Skip to main content


Kinetic Community

Nagios XI Create Host

This handler creates a new Nagios XI host object.


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

Detailed Description

This handler creates a new host object. API Documentation


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.
ip address IP address of the new host.
max check attempts Max number of attempts to try adding the host.
check period Time period name for when checks take place for this host.
contacts Nagios usernames to notify for alerts with this host. Comma separated. Use this parameter *or* the contact groups parameter.
contact groups Nagios group names to notify for alerts with this host. Comma separated. 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
ip address
max check attempts 2
check period 24x7
contacts nagiosadmin
contact groups
notification interval 5
notification period 24x7
apply config 0


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.