Skip to main content
Kinetic Community

Nagios XI Create User

This handler creates a new Nagios XI user object.


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

Detailed Description

This handler creates a new Nagios XI user 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.
username New user username.
password Password for the new user.
name Name of the new user.
email Email address of the new user.
force password change Determines if user must change password on first login. Default is 1 (yes)
email info Send e-mail to user with their new account information. Default is 1 (yes)
monitoring contact Determines if a monitoring contact is made for this user. Default is 1 (yes)
enable notifications Determines if the user will get notifications. Default is 1 (yes)
language Sets the users preferred language. Default is xi default.
date format Sets the users preferred date format. Default is 1 (YYYY-MM-DD)
number format Sets the users preferred number format. Default is 1 (1000.00)
authorization level Sets the users authorization level. Default is user. Other option is admin.
can see all objects Allows a user to view all objects that are configured no matter what what contact group they are in or what objects they are contacts of. Default value is 0 (no).
can control all hosts and services Allows a user to configure - acknowledge problems, schedule downtime, toggle notifications and force checks on all objects. Default value is 0 (no).
can reconfigure all hosts and services Allows a user to be able to re-configure a host/service from the status screen under by using the re-configure option to set contacts, update check intervals, amount of checks for hard state, etc. Default value is 0 (no).
can control engine Allows a user to restart the Nagios Core engine. Default value is 0 (no).
can use advanced features Allows the user to see the CCM links. Shows the check_command in the re-configure host/service page. Shows advanced tab with advanced commands in the host/service detail pages. Allows setting parents during wizards and re-configuration. Default value is 0 (no).
read only Set if the user only has read access. Default value is 0 (no).

Sample Configuration

Parameter Example Configuration
error handling Raise Error
return response yes
username jmcdouglas
password test
name Jordan McDouglas
email jmcdouglas@localhost
force password change
email info
monitoring contact
enable notifications
date format
number format
authorization level
can see all objects
can control all hosts and services
can reconfigure all hosts and services
can control engine
can use advanced features
read only


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.