NSClientServer
A server that listens for incoming check_nt connection and processes incoming requests.

NSClientServer — NSClientServer

A server that listens for incoming check_nt connection and processes incoming requests.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/NSClient/server performance data 1 PERFORMANCE DATA
/settings/NSClient/server use ssl 0 ENABLE SSL ENCRYPTION
/settings/NSClient/server port 12489 PORT NUMBER
/settings/default cache allowed hosts 1 CACHE ALLOWED HOSTS
/settings/default bind to   BIND TO ADDRESS
/settings/default allowed hosts 127.0.0.1 ALLOWED HOSTS
/settings/default inbox inbox INBOX
/settings/default timeout 30 TIMEOUT
/settings/default password   PASSWORD

Advanced keys:

Path / Section Key Default value Description
/settings/NSClient/server cache allowed hosts 1 CACHE ALLOWED HOSTS
/settings/NSClient/server certificate key ${certificate-path}/certificate_key.pem SSL CERTIFICATE
/settings/NSClient/server certificate format PEM CERTIFICATE FORMAT
/settings/NSClient/server timeout 30 TIMEOUT
/settings/NSClient/server certificate ${certificate-path}/nrpe_dh_512.pem DH KEY
/settings/NSClient/server verify mode none VERIFY MODE
/settings/NSClient/server ca ${certificate-path}/ca.pem CA
/settings/NSClient/server bind to   BIND TO ADDRESS
/settings/NSClient/server allowed hosts 127.0.0.1 ALLOWED HOSTS
/settings/NSClient/server thread pool 10 THREAD POOL
/settings/NSClient/server allowed ciphers ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH ALLOWED CIPHERS
/settings/NSClient/server socket queue size 0 LISTEN QUEUE
/settings/NSClient/server password   PASSWORD
/settings/default socket queue size 0 LISTEN QUEUE
/settings/default encoding   NRPE PAYLOAD ENCODING
/settings/default thread pool 10 THREAD POOL
/settings/default modern commands 1 Register modern aliases for built-in commands

Configuration

A quick reference for all avalible configuration options in the NSClientServer module.

... / settings / default

/settings/default (NSClientServer)
Key Default Value Description
allowed hosts 127.0.0.1 ALLOWED HOSTS
bind to   BIND TO ADDRESS
cache allowed hosts 1 CACHE ALLOWED HOSTS
inbox inbox INBOX
password   PASSWORD
timeout 30 TIMEOUT
encoding   NRPE PAYLOAD ENCODING
modern commands 1 Register modern aliases for built-in commands
socket queue size 0 LISTEN QUEUE
thread pool 10 THREAD POOL

Sample:

#
#
[/settings/default]
# 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
# 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
# NRPE PAYLOAD ENCODING
#
encoding=
# 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
# 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
# PASSWORD
# Password to use
password=
# Register modern aliases for built-in commands
# Register modern 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 (NSClientServer, /settings/default)

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.

Path: /settings/default

Key: cache allowed hosts

Default value: 1

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# 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.
[/settings/default]
cache allowed hosts=1
socket queue size (NSClientServer, /settings/default)

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.

Advanced (means it is not commonly used)

Path: /settings/default

Key: socket queue size

Default value: 0

Used by: CheckMKServer, CheckSystem, NRPEServer, 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
encoding (NSClientServer, /settings/default)

NRPE PAYLOAD ENCODING


Advanced (means it is not commonly used)

Path: /settings/default

Key: encoding

Default value:

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# NRPE PAYLOAD ENCODING
#
[/settings/default]
encoding=
bind to (NSClientServer, /settings/default)

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.

Path: /settings/default

Key: bind to

Default value:

Used by: CheckMKServer, CheckSystem, NRPEServer, 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 (NSClientServer, /settings/default)

ALLOWED HOSTS

A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.

Path: /settings/default

Key: allowed hosts

Default value: 127.0.0.1

Used by: CheckMKServer, CheckSystem, NRPEServer, 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 (NSClientServer, /settings/default)

THREAD POOL


Advanced (means it is not commonly used)

Path: /settings/default

Key: thread pool

Default value: 10

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# THREAD POOL
#
[/settings/default]
thread pool=10
inbox (NSClientServer, /settings/default)

INBOX

The default channel to post incoming messages on

Path: /settings/default

Key: inbox

Default value: inbox

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# INBOX
# The default channel to post incoming messages on
[/settings/default]
inbox=inbox
timeout (NSClientServer, /settings/default)

TIMEOUT

Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.

Path: /settings/default

Key: timeout

Default value: 30

Used by: CheckMKServer, CheckSystem, NRPEServer, 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
password (NSClientServer, /settings/default)

PASSWORD

Password to use

Path: /settings/default

Key: password

Default value:

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# PASSWORD
# Password to use
[/settings/default]
password=
modern commands (NSClientServer, /settings/default)

Register modern aliases for built-in commands

Register modern 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)

Path: /settings/default

Key: modern commands

Default value: 1

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# Register modern aliases for built-in commands
# Register modern 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

... / settings / NSClient / server

/settings/NSClient/server (NSClientServer)
Key Default Value Description
performance data 1 PERFORMANCE DATA
port 12489 PORT NUMBER
use ssl 0 ENABLE SSL ENCRYPTION
allowed ciphers ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH ALLOWED CIPHERS
allowed hosts 127.0.0.1 ALLOWED HOSTS
bind to   BIND TO ADDRESS
ca ${certificate-path}/ca.pem CA
cache allowed hosts 1 CACHE ALLOWED HOSTS
certificate ${certificate-path}/nrpe_dh_512.pem DH KEY
certificate format PEM CERTIFICATE FORMAT
certificate key ${certificate-path}/certificate_key.pem SSL CERTIFICATE
password   PASSWORD
socket queue size 0 LISTEN QUEUE
thread pool 10 THREAD POOL
timeout 30 TIMEOUT
verify mode none VERIFY MODE

Sample:

# NSCLIENT SERVER SECTION
# Section for NSClient (NSClientServer.dll) (check_nt) protocol options.
[/settings/NSClient/server]
# 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. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
cache allowed hosts=1
# SSL CERTIFICATE
#
certificate key=${certificate-path}/certificate_key.pem
# CERTIFICATE FORMAT
#
certificate format=PEM
# 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 favor of the parent.
timeout=30
# DH KEY
#
certificate=${certificate-path}/nrpe_dh_512.pem
# 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. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
bind to=
# 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 favor of the parent.
allowed hosts=127.0.0.1
# THREAD POOL
#  parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
thread pool=10
# ALLOWED CIPHERS
#
allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
# PERFORMANCE DATA
# Send performance data back to Nagios (set this to 0 to remove all performance data).
performance data=1
# 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 for this key is found under: /settings/default this is marked as advanced in favor of the parent.
socket queue size=0
# PASSWORD
# Password used to authenticate against server parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
password=
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
use ssl=0
# PORT NUMBER
# Port to use for check_nt.
port=12489
cache allowed hosts (NSClientServer, /settings/NSClient/server)

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. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: cache allowed hosts

Default value: 1

Used by: NSClientServer

Sample:

# 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. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
[/settings/NSClient/server]
cache allowed hosts=1
certificate key (NSClientServer, /settings/NSClient/server)

SSL CERTIFICATE


Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: certificate key

Default value: ${certificate-path}/certificate_key.pem

Used by: NSClientServer

Sample:

# SSL CERTIFICATE
#
[/settings/NSClient/server]
certificate key=${certificate-path}/certificate_key.pem
certificate format (NSClientServer, /settings/NSClient/server)

CERTIFICATE FORMAT


Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: certificate format

Default value: PEM

Used by: NSClientServer

Sample:

# CERTIFICATE FORMAT
#
[/settings/NSClient/server]
certificate format=PEM
timeout (NSClientServer, /settings/NSClient/server)

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 favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: timeout

Default value: 30

Used by: NSClientServer

Sample:

# 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 favor of the parent.
[/settings/NSClient/server]
timeout=30
certificate (NSClientServer, /settings/NSClient/server)

DH KEY


Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: certificate

Default value: ${certificate-path}/nrpe_dh_512.pem

Used by: NSClientServer

Sample:

# DH KEY
#
[/settings/NSClient/server]
certificate=${certificate-path}/nrpe_dh_512.pem
verify mode (NSClientServer, /settings/NSClient/server)

VERIFY MODE


Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: verify mode

Default value: none

Used by: NSClientServer

Sample:

# VERIFY MODE
#
[/settings/NSClient/server]
verify mode=none
ca (NSClientServer, /settings/NSClient/server)

CA


Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: ca

Default value: ${certificate-path}/ca.pem

Used by: NSClientServer

Sample:

# CA
#
[/settings/NSClient/server]
ca=${certificate-path}/ca.pem
bind to (NSClientServer, /settings/NSClient/server)

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 favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: bind to

Default value:

Used by: NSClientServer

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. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
[/settings/NSClient/server]
bind to=
allowed hosts (NSClientServer, /settings/NSClient/server)

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 favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: allowed hosts

Default value: 127.0.0.1

Used by: NSClientServer

Sample:

# 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 favor of the parent.
[/settings/NSClient/server]
allowed hosts=127.0.0.1
thread pool (NSClientServer, /settings/NSClient/server)

THREAD POOL

parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: thread pool

Default value: 10

Used by: NSClientServer

Sample:

# THREAD POOL
#  parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
[/settings/NSClient/server]
thread pool=10
allowed ciphers (NSClientServer, /settings/NSClient/server)

ALLOWED CIPHERS


Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: allowed ciphers

Default value: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

Used by: NSClientServer

Sample:

# ALLOWED CIPHERS
#
[/settings/NSClient/server]
allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
performance data (NSClientServer, /settings/NSClient/server)

PERFORMANCE DATA

Send performance data back to Nagios (set this to 0 to remove all performance data).

Path: /settings/NSClient/server

Key: performance data

Default value: 1

Used by: NSClientServer

Sample:

# PERFORMANCE DATA
# Send performance data back to Nagios (set this to 0 to remove all performance data).
[/settings/NSClient/server]
performance data=1
socket queue size (NSClientServer, /settings/NSClient/server)

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 for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: socket queue size

Default value: 0

Used by: NSClientServer

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. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
[/settings/NSClient/server]
socket queue size=0
password (NSClientServer, /settings/NSClient/server)

PASSWORD

Password used to authenticate against server parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/NSClient/server

Key: password

Default value:

Used by: NSClientServer

Sample:

# PASSWORD
# Password used to authenticate against server parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
[/settings/NSClient/server]
password=
use ssl (NSClientServer, /settings/NSClient/server)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/NSClient/server

Key: use ssl

Default value: 0

Used by: NSClientServer

Sample:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
[/settings/NSClient/server]
use ssl=0
port (NSClientServer, /settings/NSClient/server)

PORT NUMBER

Port to use for check_nt.

Path: /settings/NSClient/server

Key: port

Default value: 12489

Used by: NSClientServer

Sample:

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

Table Of Contents

Previous topic

NSCPServer — NSCPServer

Next topic

PythonScript — PythonScript

This Page