Version 6 (modified by trac, 11 months ago) (diff)

--

TracNav

NSCP server

A simple server that listens for incoming NSCP connection and handles them.

Queries (commands)

No commands avalible in NSCPServer

Commands (executable)

TODO: Add command list

Configuration

Section: /settings/default

Keys:

KeyTitleDescription
cache allowed hostsCACHE 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 hostsALLOWED HOSTS A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
inboxINBOX The default channel to post incoming messages on
timeoutTIMEOUT Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.
passwordPASSWORD Password used to authenticate againast server

Advanced Keys:

KeyTitleDescription
certificate keySSL CERTIFICATE TODO
certificate formatCERTIFICATE FORMAT TODO
certificateSSL CERTIFICATE TODO
verify modeVERIFY MODE TODO
caCA TODO
bind toBIND 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 poolTHREAD POOL TODO
allowed ciphersALLOWED CIPHERS TODO
socket queue sizeLISTEN 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 sslENABLE SSL ENCRYPTION This option controls if SSL should be enabled.

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-path}/certificate_key.pem
# CERTIFICATE FORMAT
# 
certificate format=PEM
# SSL CERTIFICATE
# 
certificate=${certificate-path}/certificate.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.
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
# 
allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
# 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=0

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, 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.
[NSCPServer]
cache allowed hosts=1

SSL CERTIFICATE

Description:

Advanced: (means it is not commonly used)

Key: certificate key

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

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# SSL CERTIFICATE
# 
[NSCPServer]
certificate key=${certificate-path}/certificate_key.pem

CERTIFICATE FORMAT

Description:

Advanced: (means it is not commonly used)

Key: certificate format

Default value: PEM

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# CERTIFICATE FORMAT
# 
[NSCPServer]
certificate format=PEM

SSL CERTIFICATE

Description:

Advanced: (means it is not commonly used)

Key: certificate

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

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# SSL CERTIFICATE
# 
[NSCPServer]
certificate=${certificate-path}/certificate.pem

VERIFY MODE

Description:

Advanced: (means it is not commonly used)

Key: verify mode

Default value: none

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# VERIFY MODE
# 
[NSCPServer]
verify mode=none

CA

Description:

Advanced: (means it is not commonly used)

Key: ca

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

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# CA
# 
[NSCPServer]
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, 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.
[NSCPServer]
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, NSCAServer, NSClientServer, NSCPServer

Sample:

# ALLOWED HOSTS
# A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
[NSCPServer]
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, NSCAServer, NSClientServer, NSCPServer

Sample:

# THREAD POOL
# 
[NSCPServer]
thread pool=10

ALLOWED CIPHERS

Description:

Advanced: (means it is not commonly used)

Key: allowed ciphers

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

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# ALLOWED CIPHERS
# 
[NSCPServer]
allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

INBOX

Description: The default channel to post incoming messages on

Key: inbox

Default value: inbox

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# INBOX
# The default channel to post incoming messages on
[NSCPServer]
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, 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.
[NSCPServer]
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, 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.
[NSCPServer]
socket queue size=0

PASSWORD

Description: Password used to authenticate againast server

Key: password

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# PASSWORD
# Password used to authenticate againast server
[NSCPServer]
password=

ENABLE SSL ENCRYPTION

Description: This option controls if SSL should be enabled.

Advanced: (means it is not commonly used)

Key: use ssl

Default value: 0

Used by: NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
[NSCPServer]
use ssl=0

NSCP SERVER SECTION

Section for NSCP (NSCPListener.dll) (check_nscp) protocol options.

Section: /settings/nscp/server

Keys:

KeyTitleDescription
allow argumentsCOMMAND ARGUMENT PROCESSING This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
portPORT NUMBER Port to use for NSCP.

Advanced Keys:

KeyTitleDescription
cache allowed hostsCACHE 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 keySSL CERTIFICATE parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificate formatCERTIFICATE FORMAT parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificateSSL CERTIFICATE parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
verify modeVERIFY MODE parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
caCA parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
bind toBIND 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 hostsALLOWED 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 poolTHREAD POOL parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
allowed ciphersALLOWED CIPHERS parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
timeoutTIMEOUT 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.
socket queue sizeLISTEN 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 favour of the parent.
use sslENABLE SSL ENCRYPTION This option controls if SSL should be enabled. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.

Sample:

# NSCP SERVER SECTION
# Section for NSCP (NSCPListener.dll) (check_nscp) protocol options.
[/settings/nscp/server]
# 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.
cache allowed hosts=1
# SSL CERTIFICATE
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificate key=${certificate-path}/certificate_key.pem
# CERTIFICATE FORMAT
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificate format=PEM
# SSL CERTIFICATE
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
certificate=${certificate-path}/certificate.pem
# VERIFY MODE
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
verify mode=none
# CA
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
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 favour 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 favour 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 favour of the parent.
thread pool=10
# ALLOWED CIPHERS
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
# COMMAND ARGUMENT PROCESSING
# This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
allow arguments=0
# 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.
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. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
socket queue size=0
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
use ssl=0
# PORT NUMBER
# Port to use for NSCP.
port=5668

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. 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: cache allowed hosts

Default value: 1

Used by: 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. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
cache allowed hosts=1

SSL CERTIFICATE

Description: 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: certificate key

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

Used by: NSCPServer

Sample:

# SSL CERTIFICATE
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
certificate key=${certificate-path}/certificate_key.pem

CERTIFICATE FORMAT

Description: 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: certificate format

Default value: PEM

Used by: NSCPServer

Sample:

# CERTIFICATE FORMAT
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
certificate format=PEM

SSL CERTIFICATE

Description: 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: certificate

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

Used by: NSCPServer

Sample:

# SSL CERTIFICATE
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
certificate=${certificate-path}/certificate.pem

VERIFY MODE

Description: 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: verify mode

Default value: none

Used by: NSCPServer

Sample:

# VERIFY MODE
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
verify mode=none

CA

Description: 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: ca

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

Used by: NSCPServer

Sample:

# CA
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
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. 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: bind to

Used by: 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. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
bind to=

ALLOWED HOSTS

Description: 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.

Advanced: (means it is not commonly used)

Key: allowed hosts

Default value: 127.0.0.1

Used by: NSCPServer

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 favour of the parent.
[NSCPServer]
allowed hosts=127.0.0.1

THREAD POOL

Description: 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: thread pool

Default value: 10

Used by: NSCPServer

Sample:

# THREAD POOL
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
thread pool=10

ALLOWED CIPHERS

Description: 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: allowed ciphers

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

Used by: NSCPServer

Sample:

# ALLOWED CIPHERS
#  parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

COMMAND ARGUMENT PROCESSING

Description: This option determines whether or not the we will allow clients to specify arguments to commands that are executed.

Key: allow arguments

Default value: 0

Used by: NSCPServer

Sample:

# COMMAND ARGUMENT PROCESSING
# This option determines whether or not the we will allow clients to specify arguments to commands that are executed.
[NSCPServer]
allow arguments=0

TIMEOUT

Description: 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.

Advanced: (means it is not commonly used)

Key: timeout

Default value: 30

Used by: NSCPServer

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 favour of the parent.
[NSCPServer]
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. 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: socket queue size

Default value: 0

Used by: 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. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
socket queue size=0

ENABLE SSL ENCRYPTION

Description: This option controls if SSL should be enabled. 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: use ssl

Default value: 0

Used by: NSCPServer

Sample:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled. parent for this key is found under: /settings/default this is marked as advanced in favour of the parent.
[NSCPServer]
use ssl=0

PORT NUMBER

Description: Port to use for NSCP.

Key: port

Default value: 5668

Used by: NSCPServer

Sample:

# PORT NUMBER
# Port to use for NSCP.
[NSCPServer]
port=5668

No configuration avalible for NSCPServer