| Version 1 (modified by mickem, 16 months ago) (diff) |
|---|
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
This is a list of modules to load at startup. All the modules included in this list has to be NSClient++ modules and located in the modules subdirectory. This is in effect the list of plug-ins that will be available as the service is running. For information on the various plug-ins check the Modules section in the navigation box. Apart from module each module can be given an alias as well as an optional disabled flag to indicate it should not be loaded. The point of aliases is to allow the same module to be loaded multiple times. For instance perhaps you want to have multiple NRPE server one with SSL enable one without or different payload length or some such. The syntax is:
[/modules] <alias>=<module> <module>=1 <module>=disabled <module>=enabled <module>=
Notice that = is NOT optional (which is was in previous versions)
A complete list of all available modules: ListTagged(module)?
/settings/default
This section has generic options for NSClient++. Some of these settings (such as allowed_hosts) are inherited in the sections below so it is probably a better idea to set them here in the "global" section.
TODO
/includes
A list of other configuration files (or other configuration stores) to include when reading this file.
TODO
Module Configuration
NRPE Listener Sections
NRPE Section
This section is included from NRPEListener/config/nrpe/0.4.x?
NRPE Handlers Section
This section is included from NRPEListener/config/nrpe_handlers/0.4.x?
File Logging Sections
Log Section
This section is included from FileLogger/config/0.4.x?
NSClient Sections
NSClient Section
This section is included from NSClientListener/config/0.4.x?
Check System Sections
CheckSystem Section
This section is included from CheckSystem/config/0.4.x?
TracNav
Documentation
Guides
Information
Sponsoring
Modules
- overview
Checks and commands
- overview
CauseCrashes
CheckNSCP
CheckDisk
CheckLogFile
CheckEventLog
CheckSystem
CheckHelpers
- overview
- check_always_ok
- check_always_critical
- check_always_warning
- check_ok
- check_critical
- check_warning
- check_multi
- check_version
- check_timeout
- check_negate
CheckTaskSched
CheckTaskSched2
CheckWMI
Scripting Languages?
Servers and protocols?
- overview?
check_nrpe (NRPE Server)
check_nrpe (NRPE Client)
check_nt (NSClient Server)
check_nt (NSClient Client)?
NSCA (NSCA Server)
NSCA (NSCA Client)
NRDP (NRDP Client)
check_mk (CheckMK Server)
check_mk (CheckMK Client)
graphite (Graphite Client)
SMTP (SMTP Client)
syslog (Syslog Client)
Utilities and tools?
Donate
Configuration for CheckSystem module
Section with configuration keys for the CheckSystem module
Section: /settings/system/windows/pdh/counters/cpu
Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| collection strategy | round robin | Collection Strategy | Collection strategy for CPU is usually round robin, for others static. |
Sample:
# # [/settings/system/windows/pdh/counters/cpu] # Collection Strategy # Collection strategy for CPU is usually round robin, for others static. collection strategy=round robin
Collection Strategy
Description: Collection strategy for CPU is usually round robin, for others static.
Key: collection strategy
Default value: round robin
Used by: CheckSystem
Sample:
# Collection Strategy # Collection strategy for CPU is usually round robin, for others static. [/settings/system/windows/pdh/counters/cpu] collection strategy=round robin
Section: /settings/default
Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| 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. |
| certificate | SSL CERTIFICATE | TODO | |
| verify mode | none | VERIFY MODE | TODO |
| allowed hosts | 127.0.0.1 | ALLOWED HOSTS | A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. |
| allowed ciphers | ADH | ALLOWED CIPHERS | A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH |
| inbox | inbox | INBOX | The default channel to post incoming messages on |
| timeout | 30 | TIMEOUT | Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. |
| password | PASSWORD | Password used to authenticate againast server | |
| use ssl | 1 | ENABLE SSL ENCRYPTION | This option controls if SSL should be enabled. |
Advanced Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| certificate key | SSL CERTIFICATE | TODO | |
| certificate format | PEM | CERTIFICATE FORMAT | TODO |
| dh | ${certificate-path}/nrpe_dh_512.pem | DH KEY | TODO |
| ca | ${certificate-path}/ca.pem | CA | TODO |
| 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. | |
| thread pool | 10 | THREAD POOL | TODO |
| 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. |
| modern commands | 1 | Register modern aliases for built-in commands | Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ |
Sample:
#
#
[/settings/default]
# 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.
cache allowed hosts=1
# SSL CERTIFICATE
#
certificate key=
# CERTIFICATE FORMAT
#
certificate format=PEM
# DH KEY
#
dh=${certificate-path}/nrpe_dh_512.pem
# SSL CERTIFICATE
#
certificate=
# VERIFY MODE
#
verify mode=none
# CA
#
ca=${certificate-path}/ca.pem
# 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.
bind to=
# ALLOWED HOSTS
# A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
allowed hosts=127.0.0.1
# THREAD POOL
#
thread pool=10
# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
allowed ciphers=ADH
# INBOX
# The default channel to post incoming messages on
inbox=inbox
# TIMEOUT
# Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.
timeout=30
# 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.
socket queue size=0
# PASSWORD
# Password used to authenticate againast server
password=
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
use ssl=1
# Register modern aliases for built-in commands
# Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++
modern commands=1
CACHE ALLOWED HOSTS
Description: If hostnames should be cached, improves speed and security somewhat but wont allow you to have dynamic IPs for your nagios server.
Key: cache allowed hosts
Default value: 1
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# 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. [/settings/default] cache allowed hosts=1
SSL CERTIFICATE
Description:
Advanced: (means it is not commonly used)
Key: certificate key
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# SSL CERTIFICATE # [/settings/default] certificate key=
CERTIFICATE FORMAT
Description:
Advanced: (means it is not commonly used)
Key: certificate format
Default value: PEM
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# CERTIFICATE FORMAT # [/settings/default] certificate format=PEM
DH KEY
Description:
Advanced: (means it is not commonly used)
Key: dh
Default value: ${certificate-path}/nrpe_dh_512.pem
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# DH KEY
#
[/settings/default]
dh=${certificate-path}/nrpe_dh_512.pem
SSL CERTIFICATE
Description:
Key: certificate
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# SSL CERTIFICATE # [/settings/default] certificate=
VERIFY MODE
Description:
Key: verify mode
Default value: none
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# VERIFY MODE # [/settings/default] verify mode=none
CA
Description:
Advanced: (means it is not commonly used)
Key: ca
Default value: ${certificate-path}/ca.pem
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# CA
#
[/settings/default]
ca=${certificate-path}/ca.pem
BIND TO ADDRESS
Description: 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.
Advanced: (means it is not commonly used)
Key: bind to
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# 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. [/settings/default] bind to=
ALLOWED HOSTS
Description: A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
Key: allowed hosts
Default value: 127.0.0.1
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# ALLOWED HOSTS # A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. [/settings/default] allowed hosts=127.0.0.1
THREAD POOL
Description:
Advanced: (means it is not commonly used)
Key: thread pool
Default value: 10
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# THREAD POOL # [/settings/default] thread pool=10
ALLOWED CIPHERS
Description: A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
Key: allowed ciphers
Default value: ADH
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# ALLOWED CIPHERS # A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH [/settings/default] allowed ciphers=ADH
INBOX
Description: The default channel to post incoming messages on
Key: inbox
Default value: inbox
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# INBOX # The default channel to post incoming messages on [/settings/default] inbox=inbox
TIMEOUT
Description: Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.
Key: timeout
Default value: 30
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# TIMEOUT # Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. [/settings/default] timeout=30
LISTEN QUEUE
Description: 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.
Advanced: (means it is not commonly used)
Key: socket queue size
Default value: 0
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# 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. [/settings/default] socket queue size=0
PASSWORD
Description: Password used to authenticate againast server
Key: password
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# PASSWORD # Password used to authenticate againast server [/settings/default] password=
ENABLE SSL ENCRYPTION
Description: This option controls if SSL should be enabled.
Key: use ssl
Default value: 1
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# ENABLE SSL ENCRYPTION # This option controls if SSL should be enabled. [/settings/default] use ssl=1
Register modern aliases for built-in commands
Description: Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++
Advanced: (means it is not commonly used)
Key: modern commands
Default value: 1
Used by: NRPEServer, CheckMKServer, CheckSystem, NSCAServer, NSClientServer, NSCPServer
Sample:
# Register modern aliases for built-in commands # Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ [/settings/default] modern commands=1
SERVICE MAPPING SECTION
Confiure which services has to be in which state
Section: /settings/system/windows/service mapping
Advanced Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| DELAYED | ignored | SERVICE_DELAYED | TODO |
| DISABLED | stopped | SERVICE_DISABLED | TODO |
| DEMAND_START | ignored | SERVICE_DEMAND_START | TODO |
| AUTO_START | started | SERVICE_AUTO_START | TODO |
| SYSTEM_START | ignored | SERVICE_SYSTEM_START | TODO |
| BOOT_START | ignored | SERVICE_BOOT_START | TODO |
Sample:
# SERVICE MAPPING SECTION # Confiure which services has to be in which state [/settings/system/windows/service mapping] # SERVICE_DELAYED # TODO DELAYED=ignored # SERVICE_DISABLED # TODO DISABLED=stopped # SERVICE_DEMAND_START # TODO DEMAND_START=ignored # SERVICE_AUTO_START # TODO AUTO_START=started # SERVICE_SYSTEM_START # TODO SYSTEM_START=ignored # SERVICE_BOOT_START # TODO BOOT_START=ignored
SERVICE_DELAYED
Description: TODO
Advanced: (means it is not commonly used)
Key: DELAYED
Default value: ignored
Used by: CheckSystem
Sample:
# SERVICE_DELAYED # TODO [/settings/system/windows/service mapping] DELAYED=ignored
SERVICE_DISABLED
Description: TODO
Advanced: (means it is not commonly used)
Key: DISABLED
Default value: stopped
Used by: CheckSystem
Sample:
# SERVICE_DISABLED # TODO [/settings/system/windows/service mapping] DISABLED=stopped
SERVICE_DEMAND_START
Description: TODO
Advanced: (means it is not commonly used)
Key: DEMAND_START
Default value: ignored
Used by: CheckSystem
Sample:
# SERVICE_DEMAND_START # TODO [/settings/system/windows/service mapping] DEMAND_START=ignored
SERVICE_AUTO_START
Description: TODO
Advanced: (means it is not commonly used)
Key: AUTO_START
Default value: started
Used by: CheckSystem
Sample:
# SERVICE_AUTO_START # TODO [/settings/system/windows/service mapping] AUTO_START=started
SERVICE_SYSTEM_START
Description: TODO
Advanced: (means it is not commonly used)
Key: SYSTEM_START
Default value: ignored
Used by: CheckSystem
Sample:
# SERVICE_SYSTEM_START # TODO [/settings/system/windows/service mapping] SYSTEM_START=ignored
SERVICE_BOOT_START
Description: TODO
Advanced: (means it is not commonly used)
Key: BOOT_START
Default value: ignored
Used by: CheckSystem
Sample:
# SERVICE_BOOT_START # TODO [/settings/system/windows/service mapping] BOOT_START=ignored
PDH COUNTER INFORMATION
Section: /settings/system/windows/pdh
Sample:
# PDH COUNTER INFORMATION # [/settings/system/windows/pdh]
WINDOWS CHECK SYSTEM
Section for system checks and system settings
Section: /settings/system/windows
Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| default buffer length | 1h | DEFAULT LENGTH | Used to define the default intervall for range buffer checks (ie. CPU). |
Advanced Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| subsystem | default | PDH SUBSYSTEM | Set which pdh subsystem to use. |
| default intervall | 1 | DEFAULT INTERVALL | Used to define the default intervall for range buffer checks (ie. CPU). |
| modern commands | 1 | Register modern aliases for built-in commands | Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favour of the parent. |
Sample:
# WINDOWS CHECK SYSTEM # Section for system checks and system settings [/settings/system/windows] # DEFAULT LENGTH # Used to define the default intervall for range buffer checks (ie. CPU). default buffer length=1h # PDH SUBSYSTEM # Set which pdh subsystem to use. subsystem=default # DEFAULT INTERVALL # Used to define the default intervall for range buffer checks (ie. CPU). default intervall=1 # Register modern aliases for built-in commands # Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favour of the parent. modern commands=1
DEFAULT LENGTH
Description: Used to define the default intervall for range buffer checks (ie. CPU).
Key: default buffer length
Default value: 1h
Used by: CheckSystem
Sample:
# DEFAULT LENGTH # Used to define the default intervall for range buffer checks (ie. CPU). [/settings/system/windows] default buffer length=1h
PDH SUBSYSTEM
Description: Set which pdh subsystem to use.
Advanced: (means it is not commonly used)
Key: subsystem
Default value: default
Used by: CheckSystem
Sample:
# PDH SUBSYSTEM # Set which pdh subsystem to use. [/settings/system/windows] subsystem=default
DEFAULT INTERVALL
Description: Used to define the default intervall for range buffer checks (ie. CPU).
Advanced: (means it is not commonly used)
Key: default intervall
Default value: 1
Used by: CheckSystem
Sample:
# DEFAULT INTERVALL # Used to define the default intervall for range buffer checks (ie. CPU). [/settings/system/windows] default intervall=1
Register modern aliases for built-in commands
Description: Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
Advanced: (means it is not commonly used)
Key: modern commands
Default value: 1
Used by: CheckSystem
Sample:
# Register modern aliases for built-in commands # Register moden alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favour of the parent. [/settings/system/windows] modern commands=1
PDH COUNTERS
Define various PDH counters to check.
Section: /settings/system/windows/pdh/counters
Keys:
| Key | Default | Title | Description |
|---|---|---|---|
| memory commit bytes | \4\26 | memory commit bytes | System counter for check_xx commands.. |
| memory commit limit | \4\30 | memory commit limit | System counter for check_xx commands.. |
| cpu | \238(_total)\6 | cpu | System counter for check_xx commands.. |
| uptime | \2\674 | uptime | System counter for check_xx commands.. |
Sample:
# PDH COUNTERS # Define various PDH counters to check. [/settings/system/windows/pdh/counters] # memory commit bytes # System counter for check_xx commands.. memory commit bytes=\4\26 # memory commit limit # System counter for check_xx commands.. memory commit limit=\4\30 # cpu # System counter for check_xx commands.. cpu=\238(_total)\6 # uptime # System counter for check_xx commands.. uptime=\2\674
memory commit bytes
Description: System counter for check_xx commands..
Key: memory commit bytes
Default value: \4\26
Used by: CheckSystem
Sample:
# memory commit bytes # System counter for check_xx commands.. [/settings/system/windows/pdh/counters] memory commit bytes=\4\26
memory commit limit
Description: System counter for check_xx commands..
Key: memory commit limit
Default value: \4\30
Used by: CheckSystem
Sample:
# memory commit limit # System counter for check_xx commands.. [/settings/system/windows/pdh/counters] memory commit limit=\4\30
cpu
Description: System counter for check_xx commands..
Key: cpu
Default value: \238(_total)\6
Used by: CheckSystem
Sample:
# cpu # System counter for check_xx commands.. [/settings/system/windows/pdh/counters] cpu=\238(_total)\6
uptime
Description: System counter for check_xx commands..
Key: uptime
Default value: \2\674
Used by: CheckSystem
Sample:
# uptime # System counter for check_xx commands.. [/settings/system/windows/pdh/counters] uptime=\2\674
External Script Sections
External Script Section
This section is included from CheckExternalScripts/config/external_script/0.4.x?
External Scripts Section
This section is included from CheckExternalScripts/config/external_scripts/0.4.x?
External Alias Section
This section is included from CheckExternalScripts/config/external_alias/0.4.x?
Event Log Sections
Event Log Section
This section is included from CheckEventLog/config/0.4.x?
NSCA Agent Sections
These sections describe the configuration options for the NSCA module.
NSCA Agent Section
This section is included from NSCAServer/config/NSCAServer/0.4.x?
NSCA Commands Section
This section is included from NSCAServer/config/NSCA_Commands/0.4.x?
LUA Scripts
A list of LUA script to load at startup. In difference to "external checks" all LUA scripts are loaded at startup. Names have no meaning since the script (on boot) submits the available commands and tie them to various functions.
[/settings/Lua/scripts] scripts\test.lua
