| Version 6 (modified by mickem, 16 months ago) (diff) |
|---|
TracNav
-
Configuration 0.4.x
- /modules
- /settings/NRPE/client
- /settings/NRPE/client/handlers
- /settings/NRPE/client/targets
- /settings/NRPE/client/targets/default
- /settings/NRPE/server
- /settings/NSCA/client
- /settings/NSCA/client/handlers
- /settings/NSCA/client/server
- /settings/NSCA/client/targets
- /settings/NSCA/client/targets/default
- /settings/NSCA/server
- /settings/NSCA/test_nsca_client
- /settings/NSCA/test_nsca_client/handlers
- /settings/NSCA/test_nsca_client/server
- /settings/NSCA/test_nsca_client/targets
- /settings/NSCA/test_nsca_client/targets/default
- /settings/NSCA/test_nsca_client/targets/nsca_test_local
- /settings/NSCA/test_nsca_server
- /settings/NSCP/client
- /settings/NSCP/client/handlers
- /settings/NSCP/client/targets
- /settings/NSCP/client/targets/default
- /settings/NSClient/server
- /settings/SMTP/client
- /settings/SMTP/client/handlers
- /settings/SMTP/client/targets
- /settings/SMTP/client/targets/default
- /settings/Task Scheduler
- /settings/check/system/windows
- /settings/check/system/windows/pdh
- /settings/check/system/windows/pdh/counters
- /settings/check/system/windows/service mapping
- /settings/crash
- /settings/default
- /settings/default/socket
- /settings/eventlog
- /settings/eventlog/real-time
- /settings/eventlog/real-time/filters
- /settings/external scripts
- /settings/external scripts/alias
- /settings/external scripts/scripts
- /settings/external scripts/wrapped scripts
- /settings/external scripts/wrappings
- /settings/log
- /settings/nscp/server
- /settings/pytest
- /settings/pytest/scripts
- /settings/python
- /settings/python/scripts
- /settings/scheduler
- /settings/scheduler/default
- /settings/scheduler/schedules
- /settings/shared session
- /settings/syslog/client
- /settings/syslog/client/handlers
- /settings/syslog/client/targets
- /settings/syslog/client/targets/default
- /settings/targets
Configuration 0.4.x
For older version please refer to doc/configuration/0.3.x
Configuration is fairly simple and straight forward. But due to flexibility the actual file may be placed in many location and can even not be a file at all (for instance the registry). Regardless of which store you have for configuration the end result is the same. The configuration will const of a section (path) a key and a value. The path (section) is a hierarcical structure meaning you will find things like /foo/bar/baz or to make real examples /settings/NRPE/server. This is similar to how it was in older version except there we would only have had NRPE in the path (section) name. If your configuration is in a file (and most likely it is) you can edit it using a normal text editor (such as notepad or vi). The file is usually called nsc.ini or nsclient.ini (but this can be changed).
The configuration is as mentioned divided into sections (paths) each with a given name.
The various sections are described in short below. The default configuration file has a lot of examples and comments so make sure you change this before you use NSClient++ as some of the examples might be potential security issues.
/modules
Normal settings
| CheckDisk | CheckDisk: CheckDisk can check various file and disk related things. | |
| The current version has commands to check Size of hard drives and directories. | ||
| CheckEventLog | Event log Checker.: Check for errors and warnings in the event log. | |
| This is only supported through NRPE so if you plan to use only NSClient this wont help you at all. | ||
| CheckExternalScripts | Check External Scripts: A simple wrapper to run external scripts and batch files. | |
| CheckHelpers | Helper function: Various helper function to extend other checks. | |
| This is also only supported through NRPE. | ||
| CheckNSCP | Check NSCP: Checkes the state of the agent | |
| CheckSystem | CheckSystem: Various system related checks, such as CPU load, process state, service state memory usage and PDH counters. | |
| CheckTaskSched | CheckTaskSched: CheckTaskSched can check various file and disk related things. | |
| The current version has commands to check Size of hard drives and directories. | ||
| CheckTaskSched2 | CheckTaskSched2: CheckTaskSched2 can check various file and disk related things. | |
| The current version has commands to check Size of hard drives and directories. | ||
| CheckWMI | CheckWMI: CheckWMI can check various file and disk related things. | |
| The current version has commands to check Size of hard drives and directories. | ||
| FileLogger | File logger: Writes errors and (if configured) debug info to a text file. | |
| NRPEClient | NRPE client (w/ SSL): A simple client for checking remote NRPE servers (think proxy). | |
| NRPEServer | NRPE server: A simple server that listens for incoming NRPE connection and handles them. | |
| NRPE is preferred over NSClient as it is more flexible. You can of cource use both NSClient and NRPE. | ||
| NSCAClient | NSCAClient: Passive check support (needs NSCA on nagios server). | |
| Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST} | ||
| NSCAServer | NSCA server (w/ encryption): A simple server that listens for incoming NSCA connection and handles them. | |
| Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST} | ||
| NSCPClient | NSCP client: A simple client for checking remote NSCP servers (think proxy). | |
| SSL support is missing (so you cant use encryption)! | ||
| NSCPServer | NSCP server (no SSL): A simple server that listens for incoming NSCP connection and handles them. | |
| NSClientServer | NSClient server: A simple server that listens for incoming NSClient (check_nt) connection and handles them. | |
| Although NRPE is the preferred method NSClient is fully supported and can be used for simplicity or for compatibility. | ||
| PythonScript | PythonScript: PythonScript... | |
| SMTPClient | SMTPClient: Passive check support via SMTP | |
| Scheduler | Scheduler: A scheduler which schedules checks at regular intervals | |
| SyslogClient | SyslogClient: Passive check support via Syslog |
/settings/NRPE/client
Section for NRPE active/passive check module.
Normal settings
| channel | NRPE | CHANNEL: The channel to listen to. |
/settings/NRPE/client/handlers
/settings/NRPE/client/targets
/settings/NRPE/client/targets/default
Target defnition for: default
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | default | TARGET ALIAS: The alias for the target |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: |
| host | default | TARGET HOST: Target host name |
| parent | default | TARGET PARENT: The parent the target inherits from |
| payload length | 1024 | 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. |
| timeout | 30 | TIMEOUT: Timeout when reading/writing packets to/from sockets. |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. |
/settings/NRPE/server
Section for NRPE (NRPEListener.dll) (check_nrpe) protocol options.
Normal settings
| allow arguments | 0 | COMMAND ARGUMENT PROCESSING: This option determines whether or not the we will allow clients to specify arguments to commands that are executed. |
| allow nasty characters | 0 | COMMAND ALLOW NASTY META CHARS: This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments. |
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: Parent element can be found under: /settings/default |
| payload length | 1024 | 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. |
| performance data | 1 | PERFORMANCE DATA: Send performance data back to nagios (set this to 0 to remove all performance data). |
| port | 5666 | PORT NUMBER: Port to use for NRPE. |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default |
/settings/NSCA/client
Section for NSCA passive check module.
Normal settings
| channel | NSCA | CHANNEL: The channel to listen to. |
| delay | 0 | DELAY: |
| hostname | auto | HOSTNAME: The host name of this host if set to blank (default) the windows name of the computer will be used. |
/settings/NSCA/client/handlers
/settings/NSCA/client/server
Configure the NSCA server to report to.
/settings/NSCA/client/targets
/settings/NSCA/client/targets/default
Target defnition for: default
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | default | TARGET ALIAS: The alias for the target |
| encryption | aes | ENCRYPTION METHOD: Number corresponding to the various encryption algorithms (see the wiki). Has to be the same as the server or it wont work at all. |
| host | default | TARGET HOST: Target host name |
| parent | default | TARGET PARENT: The parent the target inherits from |
| password | PASSWORD: The password to use. Again has to be the same as the server or it wont work at all. | |
| payload length | 512 | 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. |
| port | 5667 | NSCA PORT: The NSCA server port |
| time offset | 0 | TIME OFFSET: Time offset. |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived withint this time we will bail out. |
/settings/NSCA/server
Section for NSCA (NSCAServer) (check_nsca) protocol options.
Normal settings
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default |
| encryption | aes | ENCRYPTION: Encryption to use |
| inbox | inbox | INBOX: The default channel to post incoming messages on Parent element can be found under: /settings/default |
| password | PASSWORD: Password to use | |
| payload length | 512 | 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. |
| performance data | 1 | PERFORMANCE DATA: Send performance data back to nagios (set this to 0 to remove all performance data). |
| port | 5667 | PORT NUMBER: Port to use for NSCA. |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default |
/settings/NSCA/test_nsca_client
Section for NSCA passive check module.
Normal settings
| channel | NSCA | CHANNEL: The channel to listen to. |
| delay | 0 | DELAY: |
| hostname | auto | HOSTNAME: The host name of this host if set to blank (default) the windows name of the computer will be used. |
/settings/NSCA/test_nsca_client/handlers
/settings/NSCA/test_nsca_client/server
Configure the NSCA server to report to.
/settings/NSCA/test_nsca_client/targets
/settings/NSCA/test_nsca_client/targets/default
Target defnition for: default
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | default | TARGET ALIAS: The alias for the target |
| encryption | aes | ENCRYPTION METHOD: Number corresponding to the various encryption algorithms (see the wiki). Has to be the same as the server or it wont work at all. |
| host | TARGET HOST: Target host name | |
| parent | default | TARGET PARENT: The parent the target inherits from |
| password | PASSWORD: The password to use. Again has to be the same as the server or it wont work at all. | |
| payload length | 512 | 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. |
| port | 5667 | NSCA PORT: The NSCA server port |
| time offset | 0 | TIME OFFSET: Time offset. |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived withint this time we will bail out. |
/settings/NSCA/test_nsca_client/targets/nsca_test_local
Target defnition for: nsca_test_local
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | nsca_test_local | TARGET ALIAS: The alias for the target |
| host | nsca://127.0.0.1:15667 | TARGET HOST: Target host name |
| parent | default | TARGET PARENT: The parent the target inherits from |
/settings/NSCA/test_nsca_server
Section for NSCA (NSCAServer) (check_nsca) protocol options.
Normal settings
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default |
| encryption | aes | ENCRYPTION: Encryption to use |
| inbox | inbox | INBOX: The default channel to post incoming messages on Parent element can be found under: /settings/default |
| password | PASSWORD: Password to use | |
| payload length | 512 | 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. |
| performance data | 1 | PERFORMANCE DATA: Send performance data back to nagios (set this to 0 to remove all performance data). |
| port | 5667 | PORT NUMBER: Port to use for NSCA. |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default |
/settings/NSCP/client
Section for NSCP active/passive check module.
Normal settings
| channel | NSCP | CHANNEL: The channel to listen to. |
/settings/NSCP/client/handlers
/settings/NSCP/client/targets
/settings/NSCP/client/targets/default
Target defnition for: default
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | default | TARGET ALIAS: The alias for the target |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: |
| host | default | TARGET HOST: Target host name |
| parent | default | TARGET PARENT: The parent the target inherits from |
| payload length | 1024 | 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. |
| timeout | 30 | TIMEOUT: Timeout when reading/writing packets to/from sockets. |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. |
/settings/NSClient/server
Section for NSClient (NSClientServer.dll) (check_nt) protocol options.
Normal settings
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default/socket |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default/socket | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default/socket |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: Parent element can be found under: /settings/default/socket |
| password | PASSWORD: Password used to authenticate againast server Parent element can be found under: /settings/default | |
| performance data | 1 | PERFORMANCE DATA: Send performance data back to nagios (set this to 0 to remove all performance data). |
| port | 12489 | PORT NUMBER: Port to use for check_nt. |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default/socket |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default/socket |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default/socket |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default/socket |
/settings/SMTP/client
Section for SMTP passive check module.
Normal settings
| channel | SMTP | CHANNEL: The channel to listen to. |
/settings/SMTP/client/handlers
/settings/SMTP/client/targets
/settings/SMTP/client/targets/default
Target defnition for: default
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | default | TARGET ALIAS: The alias for the target |
| host | default | TARGET HOST: Target host name |
| parent | default | TARGET PARENT: The parent the target inherits from |
| recipient | nscp@localhost | RECIPIENT: Recipient of email message |
| sender | nscp@localhost | SENDER: Sender of email message |
| template | Hello, this is %source% reporting %message%||TEMPLATE: Template for message data | |
| timeout | 30 | TIMEOUT: Timeout when reading/writing packets to/from sockets. |
/settings/Task Scheduler
???
Advanced settings
| syntax | %title% last run: %most-recent-run-time% (%exit-code%) | SYNTAX: Set this to use a specific syntax string for all commands (that don't specify one) |
/settings/check/system/windows
Section for system checks and system settings
Normal settings
| AUTO_START | started | SERVICE_AUTO_START: TODO |
| BOOT_START | ignored | SERVICE_BOOT_START: TODO |
| DELAYED | ignored | SERVICE_DELAYED: TODO |
| DEMAND_START | ignored | SERVICE_DEMAND_START: TODO |
| DISABLED | stopped | SERVICE_DISABLED: TODO |
| SYSTEM_START | ignored | SERVICE_SYSTEM_START: TODO |
| default | 1 | DEFAULT COUNTERS: Load the default counters: cpu, memory commit bytes, memory commit limit and uptime If not you need to specify these manually. |
| default buffer length | 1h | DEFAULT INTERVALL: Used to define the default intervall for range buffer checks (ie. CPU). |
/settings/check/system/windows/pdh
/settings/check/system/windows/pdh/counters
/settings/check/system/windows/service mapping
Confiure which services has to be in which state
/settings/crash
Configure crash handling properties.
Normal settings
| archive | 1 | ARCHIVE CRASHREPORTS: Archive crash reports in the archive folder |
| archive folder | ${shared-path}/crash-dumps | folder: The archive folder for crash dunpes. |
| restart | 1 | RESTART: Submit crash reports to nsclient.org (or your configured submission server) |
| restart target | NSClientpp | RESTART SERVICE NAME: The url to submit crash reports to |
| submit | 0 | SUBMIT CRASHREPORTS: Submit crash reports to nsclient.org (or your configured submission server) |
| submit url | http://crash.nsclient.org/submit | SUBMISSION URL: The url to submit crash reports to |
/settings/default
Normal settings
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: Parent element can be found under: /settings/default |
| inbox | inbox | INBOX: The default channel to post incoming messages on Parent element can be found under: /settings/default |
| password | PASSWORD: Password used to authenticate againast server Parent element can be found under: /settings/default | |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default |
/settings/default/socket
Normal settings
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default/socket |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default/socket | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default/socket |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: Parent element can be found under: /settings/default/socket |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default/socket |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default/socket |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default/socket |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default/socket |
/settings/eventlog
Section for the EventLog? Checker (CheckEventLog.dll).
Normal settings
| buffer size | 131072 | BUFFER_SIZE: The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve. |
| debug | 0 | DEBUG: Log more information when filtering (usefull to detect issues with filters) not usefull in production as it is a bit of a resource hog. |
| lookup names | 1 | LOOKUP NAMES: Lookup the names of eventlog files |
| syntax | SYNTAX: Set this to use a specific syntax string for all commands (that don't specify one). |
/settings/eventlog/real-time
A set of options to configure the real time checks
Normal settings
| destination | NSCA | DESTINATION: The destination for intercepted messages |
| enabled | 0 | REAL TIME CHECKING: Spawns a backgrounnd thread which detects issues and reports them back instantly. |
| filter | STARTUP AGE: The initial age to scan when starting NSClient++ | |
| language | MESSAGE LANGUAGE: The language to use for rendering message (mainly used fror testing) | |
| log | application | LOGS TO CHECK: Coma separated list of logs to check |
| maximum age | 5m | MAGIMUM AGE: How long befor reporting "ok" (if this is set to off no ok will be reported only errors) |
| startup age | 30m | STARTUP AGE: The initial age to scan when starting NSClient++ |
| syntax | %type% %source%: %message% | STARTUP AGE: The initial age to scan when starting NSClient++ |
/settings/eventlog/real-time/filters
A set of filters to use in real-time mode
/settings/external scripts
Section for external scripts configuration options (CheckExternalScripts).
Normal settings
| allow arguments | 0 | COMMAND ARGUMENT PROCESSING: This option determines whether or not the we will allow clients to specify arguments to commands that are executed. |
| allow nasty characters | 0 | COMMAND ALLOW NASTY META CHARS: This option determines whether or not the we will allow clients to specify nasty (as in |`&><'"\[]{}) characters in arguments. |
| script path | SCRIPT DIRECTORY: Load all scripts in a directory and use them as commands. Probably dangerous but useful if you have loads of scripts :) | |
| timeout | 60 | 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. |
/settings/external scripts/alias
A list of aliases available. An alias is an internal command that has been "wrapped" (to add arguments). Be careful so you don't create loops (ie check_loop=check_a, check_a=check_loop)
/settings/external scripts/scripts
A list of scripts available to run from the CheckExternalScripts module. Syntax is: <command>=<script> <arguments>
/settings/external scripts/wrapped scripts
A list of wrappped scripts (ie. using the template mechanism)
/settings/external scripts/wrappings
A list of templates for wrapped scripts
/settings/log
Configure loggning properties.
Normal settings
| date format | %Y-%m-%d %H:%M:%S | DATEMASK: The size of the buffer to use when getting messages this affects the speed and maximum size of messages you can recieve. |
| file name | FILENAME: The file to write log data to. If no directory is used this is relative to the NSClient++ binary. | |
| level | INFO | LOG LEVEL: Log level to use |
| log mask | false | LOG MASK: The log mask information, error, warning, critical, debug |
| root | auto | ROOT: Set this to use a specific syntax string for all commands (that don't specify one). |
/settings/nscp/server
Section for NSCP (NSCPListener.dll) (check_nscp) protocol options.
Normal settings
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. Parent element can be found under: /settings/default |
| bind to | BIND TO ADDRESS: Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses. Parent element can be found under: /settings/default | |
| cache allowed hosts | 1 | CACHE ALLOWED HOSTS: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server. Parent element can be found under: /settings/default |
| certificate | ${certificate-path}/nrpe_dh_512.pem | SSL CERTIFICATE: Parent element can be found under: /settings/default |
| port | 5668 | PORT NUMBER: Port to use for NSCP. |
| socket queue size | 0 | LISTEN QUEUE: Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts. Parent element can be found under: /settings/default |
| thread pool | 10 | THREAD POOL: Parent element can be found under: /settings/default |
| timeout | 30 | TIMEOUT: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. Parent element can be found under: /settings/default |
| use ssl | 1 | ENABLE SSL ENCRYPTION: This option controls if SSL should be enabled. Parent element can be found under: /settings/default |
/settings/pytest
Section for the PythonScripts? module.
/settings/pytest/scripts
A list of scripts available to run from the PythonScript module.
/settings/python
Section for the PythonScripts? module.
/settings/python/scripts
A list of scripts available to run from the PythonScript module.
/settings/scheduler
Section for the Scheduler module.
Normal settings
| threads | 5 | THREAD COUNT: Number of threads to use. |
/settings/scheduler/default
Schedule defenition for: Default schedule
Normal settings
| alias | SCHEDULE ALIAS: The alias (service name) to report to server | |
| channel | NSCA | SCHEDULE CHANNEL: Channel to send results on |
| command | check_ok | SCHEDULE COMMAND: Command to execute |
| interval | 5s | SCHEDULE INTERAVAL: Time in seconds between each check |
| report | all | REPORT MODE: What to report to the server (any of the following: all, critical, warning, unknown, ok) |
/settings/scheduler/schedules
Section for the Scheduler module.
/settings/shared session
Section for configuring the shared session.
Normal settings
| enabled | 0 | LOG LEVEL: Log level to use |
/settings/syslog/client
Section for SYSLOG passive check module.
Normal settings
| channel | syslog | CHANNEL: The channel to listen to. |
| hostname | HOSTNAME: The host name of this host if set to blank (default) the windows name of the computer will be used. |
/settings/syslog/client/handlers
/settings/syslog/client/targets
/settings/syslog/client/targets/default
Target defnition for: default
Normal settings
| address | TARGET ADDRESS: Target host address | |
| alias | default | TARGET ALIAS: The alias for the target |
| critical severity | critical | SSL CERTIFICATE: |
| facility | kernel | SSL CERTIFICATE: |
| host | default | TARGET HOST: Target host name |
| message_syntax | %message% | SSL CERTIFICATE: |
| ok severity | informational | SSL CERTIFICATE: |
| parent | default | TARGET PARENT: The parent the target inherits from |
| severity | error | SSL CERTIFICATE: |
| tag_syntax | NSCP | SSL CERTIFICATE: |
| unknown severity | emergency | SSL CERTIFICATE: |
| warning severity | warning | SSL CERTIFICATE: |
/settings/targets
A list of avalible remote target systems








