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.

Queries (commands)

No commands avalible in NSClientServer

Commands (executable)

TODO: Add command list

Configuration

Section: /settings/default

Keys:

Key	Title	Description
cache allowed hosts	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.
allowed hosts	ALLOWED HOSTS	A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
inbox	INBOX	The default channel to post incoming messages on
timeout	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

Advanced Keys:

Key	Title	Description
certificate key	SSL CERTIFICATE
certificate format	CERTIFICATE FORMAT
certificate	SSL CERTIFICATE
verify mode	VERIFY MODE
ca	CA
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	THREAD POOL
allowed ciphers	ALLOWED CIPHERS
socket queue size	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.
use ssl	ENABLE SSL ENCRYPTION	This option controls if SSL should be enabled.

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

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

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

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

INBOX

Description: The default channel to post incoming messages on

Key: inbox

Default value: inbox

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

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

PASSWORD

Description: Password used to authenticate againast server

Key: password

Sample:

# PASSWORD
# Password used to authenticate againast server
[/settings/default]
password=

NSCLIENT SERVER SECTION

Section for NSClient (NSClientServer.dll) (check_nt) protocol options.

Section: /settings/NSClient/server

Keys:

Key	Title	Description
performance data	PERFORMANCE DATA	Send performance data back to nagios (set this to 0 to remove all performance data).
port	PORT NUMBER	Port to use for check_nt.

Advanced Keys:

Key	Title	Description
cache allowed hosts	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 for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificate key	SSL CERTIFICATE
certificate format	CERTIFICATE FORMAT
timeout	TIMEOUT	Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificate	SSL CERTIFICATE
verify mode	VERIFY MODE
ca	CA
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 for this key is found under: /settings/default this is marked as advanced in favour of the parent.
allowed hosts	ALLOWED HOSTS	A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
thread pool	THREAD POOL
allowed ciphers	ALLOWED CIPHERS
socket queue size	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.
password	PASSWORD	Password used to authenticate againast server parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
use ssl	ENABLE SSL ENCRYPTION	This option controls if SSL should be enabled.

PERFORMANCE DATA

Description: Send performance data back to nagios (set this to 0 to remove all performance data).

Key: performance data

Default value: 1

Sample:

# PERFORMANCE DATA
# Send performance data back to nagios (set this to 0 to remove all performance data).
[/settings/NSClient/server]
performance data=1

PORT NUMBER

Description: Port to use for check_nt.

Key: port

Default value: 12489

Sample:

# PORT NUMBER
# Port to use for check_nt.
[/settings/NSClient/server]
port=12489