Skip to main content
Kinetic Community

Nagios XI Create Service

This handler creates a new Nagios XI service object.

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

nagios_xi_create_config_service_v1.zip

Detailed Description

This handler creates a new service object. API Documentation

Parameters

Name Description
error handling Determine what to return if an error is encountered.
return response true or false. Determines if Kinetic Task returns the Nagios response output.
host name Host name to apply to the new host.
service description Service description for the new service
check command The command to run with command parameters. Example: check_ping\!3000,80%\!5000,100%
max check attempts Max number of attempts to try adding the host.
check interval Time in minutes for how often the service checks.
check period Time period name for when checks take place for this host.
retry interval Time in minutes for how often the service is checked after a failed check.
contacts Nagios usernames to notify for alerts with this host. Comma seperated. Use this parameter *or* the contact groups parameter.
contact groups Nagios group names to notify for alerts with this host. Comma seperated. Use this parameter *or* the contacts parameter.
notification interval Interval check period in minutes for alert notifications on this host.
notification period Notification time period name. Determines the time period that notifications take place in.
apply config 1 or 0 for true or false. 1 will restart the Nagios Core service and apply the change.

Sample Configuration

Parameter Example Configuration
error handling Raise Error
return response yes
host name testapihostapply
service description PING
check command check_ping\!3000,80%\!5000,100%
max check attempts 2
check interval 5
check period 24x7
retry interval 5
contacts nagiosadmin
contact groups
notification interval 5
notification period 24x7
apply config 0

Results

Name Description
Handler Error Message Error message if set to return - blank if no errors.
Nagios XI Response Nagios response if set to return.

Change Log

Version Date Description
1 2017-11-26 * Initial version. See README for details.