# If you want to fill this file with all avalible options run the following command: # nscp settings --generate --add-defaults --load-all # If you want to activate a module and bring in all its options use: # nscp settings --activate-module --add-defaults # For details run: nscp settings --help ; Undocumented section [/settings/default] ; Undocumented key password = TIAtende07 ; Undocumented key allowed hosts = 10.63.248.131 ; CACHE ALLOWED HOSTS - If host names (DNS entries) should be cached, improves speed and security somewhat but won't allow you to have dynamic IPs for your Nagios server. cache allowed hosts = 1 ; TIMEOUT - Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. timeout = 30 ; INBOX - The default channel to post incoming messages on inbox = inbox payload length = 8192 ; Undocumented section [/settings/NRPE/server] ; Undocumented key insecure = true ; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled. use ssl = 1 ; COMMAND ALLOW NASTY META CHARS - This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments. allow nasty characters = 1 ; COMMAND ARGUMENT PROCESSING - This option determines whether or not the we will allow clients to specify arguments to commands that are executed. allow arguments = 1 ; PORT NUMBER - Port to use for NRPE. port = 5666 ; EXTENDED RESPONSE - Send more then 1 return packet to allow response to go beyond payload size (requires modified client if legacy is true this defaults to false). extended response = 0 allowed ciphers = ALL:!MD5:@STRENGTH ; VERIFY MODE - Comma separated list of verification flags to set on the SSL socket. none The server will not send a client certificate request to the client, so the client will not send a certificate. peer The server sends a client certificate request to the client and the certificate returned (if any) is checked. fail-if-no-cert if the client did not return a certificate, the TLS/SSL handshake is immediately terminated. This flag must be used together with peer. peer-cert Alias for peer and fail-if-no-cert. workarounds Various bug workarounds. single Always create a new key when using tmp_dh parameters. client-once Only request a client certificate on the initial TLS/SSL handshake. This flag must be used together with verify-peer verify mode = none ; defaults in NRPE v3 "ALL:!MD5:@STRENGTH" ; Undocumented section [/modules] ; Undocumented key CheckExternalScripts = 1 ; Undocumented key CheckHelpers = 1 ; Undocumented key CheckNSCP = 1 ; Undocumented key CheckDisk = 1 ; Undocumented key CheckSystem = 1 ; Undocumented key NSClientServer = 1 ; Undocumented key CheckEventLog = 1 ; Undocumented key NSCAClient = disabled ; Undocumented key NRPEServer = 1 ; SimpleFileWriter - Write status updates to a text file (A bit like the NSCA server does) SimpleFileWriter = 0 ; PythonScript - Loads and processes internal Python scripts PythonScript = 0 ; NRDPClient - NRDP client can be used both from command line and from queries to check remote systes via NRDP NRDPClient = 1 ; DotnetPlugin - Plugin to load and manage plugins written in dot net. DotnetPlugins = 0 ; CommandClient - A command line client, generally not used except with "nscp test". CommandClient = 0 ; CheckTaskSched - Check status of your scheduled jobs. CheckTaskSched = 1 ; NSCAServer - A server that listens for incoming NSCA connection and processes incoming requests. NSCAServer = 0 ; CheckLogFile - File for checking log files and various other forms of updating text files CheckLogFile = 1 ; SyslogClient - Forward information as syslog messages to a syslog server SyslogClient = 0 ; Scheduler - Use this to schedule check commands and jobs in conjunction with for instance passive monitoring through NSCA Scheduler = 1 ; NRPEClient - NRPE client can be used both from command line and from queries to check remote systes via NRPE as well as configure the NRPE server NRPEClient = 0 ; WEBServer - A server that listens for incoming HTTP connection and processes incoming requests. It provides both a WEB UI as well as a REST API in addition to simplifying configuration of WEB Server module. WEBServer = disabled ; GraphiteClient - Graphite client can be used to submit graph data to a graphite graphing system GraphiteClient = 0 ; SMTPClient - SMTP client can be used both from command line and from queries to check remote systes via SMTP SMTPClient = 0 ; CheckWMI - Check status via WMI CheckWMI = 1 ; SimpleCache - Stores status updates and allows for active checks to retrieve them SimpleCache = 0 ; A list of available remote target systems [/settings/targets] ; Configure which services has to be in which state [/settings/system/windows/service mapping] ; A set of options to configure the real time checks [/settings/system/windows/real-time] ; Section for system checks and system settings [/settings/system/windows] ; DEFAULT LENGTH - Used to define the default interval for range buffer checks (ie. CPU). default buffer length = 1h ; Section for configuring the shared session. [/settings/shared session] ; ENABLE THE SAHRED SESSION - This is currently not added in 0.4.x enabled = false ; Section for the PythonScripts module. [/settings/python] ; A set of options to configure the real time checks [/settings/logfile/real-time] ; REAL TIME CHECKING - Spawns a background thread which waits for file changes. enabled = 0 ; Configure log file properties. [/settings/log/file] ; MAXIMUM FILE SIZE - When file size reaches this it will be truncated to 50% if set to 0 (default) truncation will be disabled ;max size = 0 max size = 2048000 ; A list of scripts available to run from the PythonScript module. [/settings/python/scripts] ; Section for configuring the log handling. [/settings/log] ; LOG LEVEL - Log level to use. Available levels are error,warning,info,debug,trace level = debug ; FILENAME - The file to write log data to. Set this to none to disable log to file. file name = ${exe-path}/nsclient.log ; DATEMASK - The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve. date format = %Y-%m-%d %H:%M:%S ; Section for simple file writer module (SimpleFileWriter.dll). [/settings/writers/file] ; MESSAGE SYNTAX - The syntax of the message to write to the line. Can be any arbitrary string as well as include any of the following special keywords:${command} = The command name, ${host} the host, ${channel} the recieving channel, ${alias} the alias for the command, ${alias-or-command} = alias if set otherweise command, ${message} = the message data (no escape), ${result} = The result status (number). syntax = ${alias-or-command} ${result} ${message} ; FILE TO WRITE TO - The filename to write output to. file = output.txt ; CHANNEL - The channel to listen to. channel = FILE ; Section for graphite passive check module. [/settings/graphite/client] ; CHANNEL - The channel to listen to. channel = GRAPHITE ; HOSTNAME - The host name of this host if set to blank (default) the windows name of the computer will be used. hostname = auto ; A list of wrapped scripts (ie. scruts using a template mechanism). The template used will be defined by the extension of the script. [/settings/external scripts/wrapped scripts] missing = missing.ps1 ok = check_test.ps1 ; Target definition for: default [/settings/syslog/client/targets/default] ; TODO - warning severity = warning ; TODO - tag_syntax = NSCA ; TODO - severity = error ; TODO - ok severity = informational ; TODO - message_syntax = %message% ; TODO - facility = kernel ; TODO - critical severity = critical ; TODO - unknown severity = emergency ; Section for external scripts configuration options (CheckExternalScripts). [/settings/external scripts] ; COMMAND TIMEOUT - The maximum time in seconds that a command can execute. (if more then this execution will be aborted). NOTICE this only affects external commands not internal ones. timeout = 60 ; COMMAND ALLOW NASTY META CHARS - This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments. allow nasty characters = 1 ; COMMAND ARGUMENT PROCESSING - This option determines whether or not the we will allow clients to specify arguments to commands that are executed. allow arguments = 1 ; Section for SYSLOG passive check module. [/settings/syslog/client] ; CHANNEL - The channel to listen to. channel = syslog ; A set of options to configure the real time checks [/settings/eventlog/real-time] ; STARTUP AGE - The initial age to scan when starting NSClient++ startup age = 30m ; REAL TIME CHECKING - Spawns a background thread which detects issues and reports them back instantly. enabled = 0 ; LOGS TO CHECK - Comma separated list of logs to check log = application,system ; DEBUG - Log missed records (useful to detect issues with filters) not useful in production as it is a bit of a resource hog. debug = 0 ; Section for configuring the crash handler. [/settings/crash] ; SUBMIT CRASHREPORTS - Submit crash reports to nsclient.org (or your configured submission server) submit = false ; CRASH ARCHIVE LOCATION - The folder to archive crash dumps in archive folder = ${shared-path}/crash-dumps ; ARCHIVE CRASHREPORTS - Archive crash reports in the archive folder archive = true ; RESTART SERVICE NAME - The url to submit crash reports to restart target = NSCP ; RESTART - Submit crash reports to nsclient.org (or your configured submission server) restart = true ; SUBMISSION URL - The url to submit crash reports to submit url = https://crash.nsclient.org/post ; Section for log file checker [/settings/logfile] ; Section for SMTP passive check module. [/settings/SMTP/client] ; CHANNEL - The channel to listen to. channel = SMTP ; Section for NSCA (NSCAServer) (check_nsca) protocol options. [/settings/NSCA/server] ; PORT NUMBER - Port to use for NSCA. port = 5667 ; PERFORMANCE DATA - Send performance data back to nagios (set this to false to remove all performance data). performance data = 1 ; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled. use ssl = 0 ; ENCRYPTION - Name of encryption algorithm to use. Has to be the same as your agent i using or it wont work at all.This is also independent of SSL and generally used instead of SSL. Available encryption algorithms are: none = No Encryption (not safe) xor = XOR des = DES 3des = DES-EDE3 cast128 = CAST-128 xtea = XTEA blowfish = Blowfish twofish = Twofish rc2 = RC2 aes128 = AES aes192 = AES aes = AES serpent = Serpent gost = GOST encryption = des ; PAYLOAD LENGTH - Length of payload to/from the NSCA agent. This is a hard specific value so you have to "configure" (read recompile) your NSCA agent to use the same value for it to work. payload length = 512 ; Target definition for: default [/settings/NSCA/client/targets/default] address = UNKNOWN password = welcome ; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled. use ssl = 0 ; TIMEOUT - Timeout when reading/writing packets to/from sockets. timeout = 30 ; ENCRYPTION - Name of encryption algorithm to use. Has to be the same as your server i using or it wont work at all.This is also independent of SSL and generally used instead of SSL. Available encryption algorithms are: none = No Encryption (not safe) xor = XOR des = DES 3des = DES-EDE3 cast128 = CAST-128 xtea = XTEA blowfish = Blowfish twofish = Twofish rc2 = RC2 aes128 = AES aes192 = AES aes = AES serpent = Serpent gost = GOST encryption = DES ; ALLOWED CIPHERS - A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH allowed ciphers = ADH ; VERIFY MODE - verify mode = none ; Section for NSClient (NSClientServer.dll) (check_nt) protocol options. [/settings/NSClient/server] ; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled. use ssl = 0 ; PERFORMANCE DATA - Send performance data back to Nagios (set this to 0 to remove all performance data). performance data = 1 ; PORT NUMBER - Port to use for check_nt. port = 12489 ; A set of filters to use in real-time mode [/settings/system/windows/real-time/checks] ; Section for NSCA passive check module. [/settings/NSCA/client] ; HOSTNAME - The host name of the monitored computer. Set this to auto (default) to use the windows name of the computer. auto Hostname ${host} Hostname ${host_lc} Hostname in lowercase ${host_uc} Hostname in uppercase ${domain} Domainname ${domain_lc} Domainname in lowercase ${domain_uc} Domainname in uppercase hostname = auto ; CHANNEL - The channel to listen to. channel = NSCA [/settings/NRDP/client/targets/default] ; SECURITY TOKEN - The security token token = UNKNOWN ; RETRIES - Number of times to retry sending. retries = 3 ; SECURITY TOKEN - The security token key = UNKNOWN ; TARGET ADDRESS - Target host address address = UNKNOWN ; SECURITY TOKEN - The security token password = CHECK_NT PASSWORD ; TIMEOUT - Timeout when reading/writing packets to/from sockets. timeout = 90 ; Section for SMTP passive check module. [/settings/NRDP/client] ; HOSTNAME - The host name of this host if set to blank (default) the windows name of the computer will be used. hostname = auto ; CHANNEL - The channel to listen to. channel = NRDP ; Target definition for: default [/settings/NRPE/client/targets/default] ; VERIFY MODE - What to verify default is non, to validate remote certificate use remote-peer verify mode = none ; PAYLOAD LENGTH - Length of payload to/from the NRPE agent. This is a hard specific value so you have to "configure" (read recompile) your NRPE agent to use the same value for it to work. payload length = 8192 ; ENABLE SSL ENCRYPTION - This option controls if SSL should be enabled. use ssl = 1 ; TIMEOUT - Timeout when reading/writing packets to/from sockets. timeout = 30 ; Section for WEB (WEBServer.dll) (check_WEB) protocol options. [/settings/WEB/server] ; PORT NUMBER - Port to use for WEB server. port = 8443s ; CERTIFICATE - Ssl certificate to use for the ssl server certificate = ${certificate-path}/certificate.pem ; Target definition for: default [/settings/SMTP/client/targets/default] ; SENDER - Sender of email message sender = nscp@localhost ; TEMPLATE - Template for message data template = Hello, this is %source% reporting %message%! ; TIMEOUT - Timeout when reading/writing packets to/from sockets. timeout = 30 ; RECIPIENT - Recipient of email message recipient = nscp@localhost ; Files to be included in the configuration [/includes] ; Section for the EventLog Checker (CheckEventLog.dll). [/settings/eventlog] ; BUFFER_SIZE - The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve. buffer size = 131072 ; LOOKUP NAMES - Lookup the names of eventlog files lookup names = 1 ; DEBUG - Log more information when filtering (useful to detect issues with filters) not useful in production as it is a bit of a resource hog. debug = 0 ; Section for NRPE active/passive check module. [/settings/NRPE/client] ; CHANNEL - The channel to listen to. channel = NRPE ; payload length payload length = 8192 ; Section for the Scheduler module. [/settings/scheduler/schedules/default] interval = 5m channel = NRDP ; Section for the Scheduler module. [/settings/scheduler/schedules] os_version = check_os_version cpu = alias_cpu_new mem = alias_mem disk = alias_disk service = alias_service uptime = alias_up ; A list of scripts available to run from the CheckExternalScripts module. Syntax is: =