NSCAClient
NSCAClient
— NSCAClient¶NSCA client can be used both from command line and from queries to submit passive checks via NSCA
Queries (Overview):
A list of all available queries (check commands)
Command | Description |
---|---|
submit_nsca |
Submit information to the remote NSCA server. |
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
Common Keys:
Path / Section | Key | Description |
---|---|---|
/settings/NSCA/client |
channel |
CHANNEL |
/settings/NSCA/client |
hostname |
HOSTNAME |
/settings/NSCA/client/targets/default |
address |
TARGET ADDRESS |
/settings/NSCA/client/targets/default |
allowed ciphers |
ALLOWED CIPHERS |
/settings/NSCA/client/targets/default |
certificate |
SSL CERTIFICATE |
/settings/NSCA/client/targets/default |
encryption |
ENCRYPTION |
/settings/NSCA/client/targets/default |
password |
PASSWORD |
/settings/NSCA/client/targets/default |
retries |
RETRIES |
/settings/NSCA/client/targets/default |
timeout |
TIMEOUT |
/settings/NSCA/client/targets/default |
use ssl |
ENABLE SSL ENCRYPTION |
/settings/NSCA/client/targets/default |
verify mode |
VERIFY MODE |
Advanced keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/NSCA/client |
encoding |
NSCA DATA ENCODING | |
/settings/NSCA/client/targets/default |
ca |
CA | |
/settings/NSCA/client/targets/default |
certificate format |
CERTIFICATE FORMAT | |
/settings/NSCA/client/targets/default |
certificate key |
SSL CERTIFICATE | |
/settings/NSCA/client/targets/default |
dh |
DH KEY | |
/settings/NSCA/client/targets/default |
encoding |
ENCODING | |
/settings/NSCA/client/targets/default |
host |
TARGET HOST | |
/settings/NSCA/client/targets/default |
payload length |
PAYLOAD LENGTH | |
/settings/NSCA/client/targets/default |
port |
TARGET PORT | |
/settings/NSCA/client/targets/default |
time offset |
TIME OFFSET |
Sample keys:
A quick reference for all available queries (check commands) in the NSCAClient module.
submit_nsca
¶NSCAClient
submit_nsca
Usage:
Option | Default Value | Description | ||
---|---|---|---|---|
help |
N/A | Show help screen (this screen) | ||
help-pb |
N/A | Show help screen as a protocol buffer payload | ||
show-default |
N/A | Show default values for a given command | ||
help-short |
N/A | Show help screen (short format). | ||
host |
The host of the host running the server | |||
port |
The port of the host running the server | |||
address |
The address (host:port) of the host running the server | |||
timeout |
Number of seconds before connection times out (default=10) | |||
target |
Target to use (lookup connection info from config) | |||
retry |
Number of times ti retry a failed connection attempt (default=2) | |||
retries |
legacy version of retry | |||
source-host |
Source/sender host name (default is auto which means use the name of the actual host) | |||
sender-host |
Source/sender host name (default is auto which means use the name of the actual host) | |||
command |
The name of the command that the remote daemon should run | |||
alias |
Same as command | |||
message |
Message | |||
result |
Result code either a number or OK, WARN, CRIT, UNKNOWN | |||
separator |
Separator to use for the batch command (default is | ) | ||
batch |
Add multiple records using the separator format is: command | result | message | |
certificate |
Length of payload (has to be same as on the server) | |||
dh |
Length of payload (has to be same as on the server) | |||
certificate-key |
Client certificate to use | |||
certificate-format |
Client certificate format | |||
ca |
Certificate authority | |||
verify |
Client certificate format | |||
allowed-ciphers |
Client certificate format | |||
ssl |
1 | Initial an ssl handshake with the server. | ||
encryption |
Name of encryption algorithm to use. | |||
payload-length |
Length of payload (has to be same as on the server) | |||
buffer-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. | |||
password |
Password | |||
time-offset |
help
(NSCAClient, submit_nsca)¶help-pb
(NSCAClient, submit_nsca)¶show-default
(NSCAClient, submit_nsca)¶help-short
(NSCAClient, submit_nsca)¶host
(NSCAClient, submit_nsca)¶port
(NSCAClient, submit_nsca)¶address
(NSCAClient, submit_nsca)¶timeout
(NSCAClient, submit_nsca)¶target
(NSCAClient, submit_nsca)¶retry
(NSCAClient, submit_nsca)¶retries
(NSCAClient, submit_nsca)¶source-host
(NSCAClient, submit_nsca)¶sender-host
(NSCAClient, submit_nsca)¶command
(NSCAClient, submit_nsca)¶alias
(NSCAClient, submit_nsca)¶message
(NSCAClient, submit_nsca)¶result
(NSCAClient, submit_nsca)¶batch
(NSCAClient, submit_nsca)¶certificate
(NSCAClient, submit_nsca)¶dh
(NSCAClient, submit_nsca)¶certificate-key
(NSCAClient, submit_nsca)¶certificate-format
(NSCAClient, submit_nsca)¶ca
(NSCAClient, submit_nsca)¶verify
(NSCAClient, submit_nsca)¶allowed-ciphers
(NSCAClient, submit_nsca)¶ssl
(NSCAClient, submit_nsca)¶encryption
(NSCAClient, submit_nsca)¶payload-length
(NSCAClient, submit_nsca)¶buffer-length
(NSCAClient, submit_nsca)¶password
(NSCAClient, submit_nsca)¶time-offset
(NSCAClient, submit_nsca)¶/settings/NSCA/client
(NSCAClient)¶NSCA CLIENT SECTION
Section for NSCA passive check module.
Key Default Value Description channel
NSCA CHANNEL encoding
NSCA DATA ENCODING hostname
auto HOSTNAME Sample:
# NSCA CLIENT SECTION # Section for NSCA passive check module. [/settings/NSCA/client] channel=NSCA encoding= hostname=auto
channel
(NSCAClient, /settings/NSCA/client)¶CHANNEL
The channel to listen to.Path: /settings/NSCA/client
Key: channel
Default value: NSCA
Used by:
NSCAClient
Sample:
[/settings/NSCA/client] # CHANNEL channel=NSCA
encoding
(NSCAClient, /settings/NSCA/client)¶NSCA DATA ENCODING
Advanced (means it is not commonly used)
Path: /settings/NSCA/client
Key: encoding
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client] # NSCA DATA ENCODING encoding=
hostname
(NSCAClient, /settings/NSCA/client)¶HOSTNAME
The host name of the monitored computer.Set this to auto (default) to use the windows name of the computer.auto Hostname${host} Hostname${host_lc}Hostname in lowercase${host_uc} Hostname in uppercase${domain} Domainname${domain_lc} Domainname in lowercase${domain_uc} Domainname in uppercasePath: /settings/NSCA/client
Key: hostname
Default value: auto
Used by:
NSCAClient
Sample:
[/settings/NSCA/client] # HOSTNAME hostname=auto
/settings/NSCA/client/handlers
(NSCAClient)¶CLIENT HANDLER SECTION
Sample:
# CLIENT HANDLER SECTION # [/settings/NSCA/client/handlers]
/settings/NSCA/client/targets
(NSCAClient)¶REMOTE TARGET DEFINITIONS
Sample:
# REMOTE TARGET DEFINITIONS # [/settings/NSCA/client/targets]
/settings/NSCA/client/targets/default
(NSCAClient)¶TARGET
Target definition for: default
Key Default Value Description address
TARGET ADDRESS allowed ciphers
ALLOWED CIPHERS ca
CA certificate
SSL CERTIFICATE certificate format
CERTIFICATE FORMAT certificate key
SSL CERTIFICATE dh
DH KEY encoding
ENCODING encryption
aes ENCRYPTION host
TARGET HOST password
PASSWORD payload length
512 PAYLOAD LENGTH port
TARGET PORT retries
3 RETRIES time offset
0 TIME OFFSET timeout
30 TIMEOUT use ssl
0 ENABLE SSL ENCRYPTION verify mode
VERIFY MODE Sample:
# TARGET # Target definition for: default [/settings/NSCA/client/targets/default] address= allowed ciphers= ca= certificate= certificate format= certificate key= dh= encoding= encryption=aes host= password= payload length=512 port= retries=3 time offset=0 timeout=30 use ssl=0 verify mode=
address
(NSCAClient, /settings/NSCA/client/targets/default)¶TARGET ADDRESS
Target host addressPath: /settings/NSCA/client/targets/default
Key: address
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # TARGET ADDRESS address=
allowed ciphers
(NSCAClient, /settings/NSCA/client/targets/default)¶ALLOWED CIPHERS
A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTHPath: /settings/NSCA/client/targets/default
Key: allowed ciphers
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # ALLOWED CIPHERS allowed ciphers=
ca
(NSCAClient, /settings/NSCA/client/targets/default)¶CA
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: ca
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # CA ca=
certificate
(NSCAClient, /settings/NSCA/client/targets/default)¶SSL CERTIFICATE
Path: /settings/NSCA/client/targets/default
Key: certificate
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # SSL CERTIFICATE certificate=
certificate format
(NSCAClient, /settings/NSCA/client/targets/default)¶CERTIFICATE FORMAT
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: certificate format
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # CERTIFICATE FORMAT certificate format=
certificate key
(NSCAClient, /settings/NSCA/client/targets/default)¶SSL CERTIFICATE
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: certificate key
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # SSL CERTIFICATE certificate key=
dh
(NSCAClient, /settings/NSCA/client/targets/default)¶DH KEY
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: dh
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # DH KEY dh=
encoding
(NSCAClient, /settings/NSCA/client/targets/default)¶ENCODING
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: encoding
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # ENCODING encoding=
encryption
(NSCAClient, /settings/NSCA/client/targets/default)¶ENCRYPTION
Name of encryption algorithm to use.Has to be the same as your server i using or it wont work at all.This is also independent of SSL and generally used instead of SSL.Available encryption algorithms are:none = No Encryption (not safe)xor = XORdes = DES3des = DES-EDE3cast128 = CAST-128xtea = XTEAblowfish = Blowfishtwofish = Twofishrc2 = RC2aes128 = AESaes192 = AESaes = AESserpent = Serpentgost = GOSTPath: /settings/NSCA/client/targets/default
Key: encryption
Default value: aes
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # ENCRYPTION encryption=aes
host
(NSCAClient, /settings/NSCA/client/targets/default)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: host
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # TARGET HOST host=
password
(NSCAClient, /settings/NSCA/client/targets/default)¶PASSWORD
The password to use. Again has to be the same as the server or it wont work at all.Path: /settings/NSCA/client/targets/default
Key: password
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # PASSWORD password=
payload length
(NSCAClient, /settings/NSCA/client/targets/default)¶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.Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: payload length
Default value: 512
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # PAYLOAD LENGTH payload length=512
port
(NSCAClient, /settings/NSCA/client/targets/default)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: port
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # TARGET PORT port=
retries
(NSCAClient, /settings/NSCA/client/targets/default)¶RETRIES
Number of times to retry sending.Path: /settings/NSCA/client/targets/default
Key: retries
Default value: 3
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # RETRIES retries=3
time offset
(NSCAClient, /settings/NSCA/client/targets/default)¶TIME OFFSET
Time offset.Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/default
Key: time offset
Default value: 0
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # TIME OFFSET time offset=0
timeout
(NSCAClient, /settings/NSCA/client/targets/default)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/NSCA/client/targets/default
Key: timeout
Default value: 30
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # TIMEOUT timeout=30
use ssl
(NSCAClient, /settings/NSCA/client/targets/default)¶ENABLE SSL ENCRYPTION
This option controls if SSL should be enabled.Path: /settings/NSCA/client/targets/default
Key: use ssl
Default value: 0
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # ENABLE SSL ENCRYPTION use ssl=0
verify mode
(NSCAClient, /settings/NSCA/client/targets/default)¶VERIFY MODE
Path: /settings/NSCA/client/targets/default
Key: verify mode
Default value:
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/default] # VERIFY MODE verify mode=
/settings/NSCA/client/targets/sample
(NSCAClient)¶TARGET
Target definition for: sample
Key Default Value Description address
TARGET ADDRESS allowed ciphers
ALLOWED CIPHERS ca
CA certificate
SSL CERTIFICATE certificate format
CERTIFICATE FORMAT certificate key
SSL CERTIFICATE dh
DH KEY encoding
ENCODING encryption
aes ENCRYPTION host
TARGET HOST password
PASSWORD payload length
512 PAYLOAD LENGTH port
TARGET PORT retries
3 RETRIES time offset
0 TIME OFFSET timeout
30 TIMEOUT use ssl
0 ENABLE SSL ENCRYPTION verify mode
VERIFY MODE Sample:
# TARGET # Target definition for: sample [/settings/NSCA/client/targets/sample] address= allowed ciphers= ca= certificate= certificate format= certificate key= dh= encoding= encryption=aes host= password= payload length=512 port= retries=3 time offset=0 timeout=30 use ssl=0 verify mode=
address
(NSCAClient, /settings/NSCA/client/targets/sample)¶TARGET ADDRESS
Target host addressPath: /settings/NSCA/client/targets/sample
Key: address
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # TARGET ADDRESS address=
allowed ciphers
(NSCAClient, /settings/NSCA/client/targets/sample)¶ALLOWED CIPHERS
A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTHPath: /settings/NSCA/client/targets/sample
Key: allowed ciphers
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # ALLOWED CIPHERS allowed ciphers=
ca
(NSCAClient, /settings/NSCA/client/targets/sample)¶CA
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: ca
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # CA ca=
certificate
(NSCAClient, /settings/NSCA/client/targets/sample)¶SSL CERTIFICATE
Path: /settings/NSCA/client/targets/sample
Key: certificate
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # SSL CERTIFICATE certificate=
certificate format
(NSCAClient, /settings/NSCA/client/targets/sample)¶CERTIFICATE FORMAT
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: certificate format
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # CERTIFICATE FORMAT certificate format=
certificate key
(NSCAClient, /settings/NSCA/client/targets/sample)¶SSL CERTIFICATE
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: certificate key
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # SSL CERTIFICATE certificate key=
dh
(NSCAClient, /settings/NSCA/client/targets/sample)¶DH KEY
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: dh
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # DH KEY dh=
encoding
(NSCAClient, /settings/NSCA/client/targets/sample)¶ENCODING
Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: encoding
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # ENCODING encoding=
encryption
(NSCAClient, /settings/NSCA/client/targets/sample)¶ENCRYPTION
Name of encryption algorithm to use.Has to be the same as your server i using or it wont work at all.This is also independent of SSL and generally used instead of SSL.Available encryption algorithms are:none = No Encryption (not safe)xor = XORdes = DES3des = DES-EDE3cast128 = CAST-128xtea = XTEAblowfish = Blowfishtwofish = Twofishrc2 = RC2aes128 = AESaes192 = AESaes = AESserpent = Serpentgost = GOSTPath: /settings/NSCA/client/targets/sample
Key: encryption
Default value: aes
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # ENCRYPTION encryption=aes
host
(NSCAClient, /settings/NSCA/client/targets/sample)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: host
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # TARGET HOST host=
password
(NSCAClient, /settings/NSCA/client/targets/sample)¶PASSWORD
The password to use. Again has to be the same as the server or it wont work at all.Path: /settings/NSCA/client/targets/sample
Key: password
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # PASSWORD password=
payload length
(NSCAClient, /settings/NSCA/client/targets/sample)¶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.Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: payload length
Default value: 512
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # PAYLOAD LENGTH payload length=512
port
(NSCAClient, /settings/NSCA/client/targets/sample)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: port
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # TARGET PORT port=
retries
(NSCAClient, /settings/NSCA/client/targets/sample)¶RETRIES
Number of times to retry sending.Path: /settings/NSCA/client/targets/sample
Key: retries
Default value: 3
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # RETRIES retries=3
time offset
(NSCAClient, /settings/NSCA/client/targets/sample)¶TIME OFFSET
Time offset.Advanced (means it is not commonly used)
Path: /settings/NSCA/client/targets/sample
Key: time offset
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # TIME OFFSET time offset=0
timeout
(NSCAClient, /settings/NSCA/client/targets/sample)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/NSCA/client/targets/sample
Key: timeout
Default value: 30
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # TIMEOUT timeout=30
use ssl
(NSCAClient, /settings/NSCA/client/targets/sample)¶ENABLE SSL ENCRYPTION
This option controls if SSL should be enabled.Path: /settings/NSCA/client/targets/sample
Key: use ssl
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # ENABLE SSL ENCRYPTION use ssl=0
verify mode
(NSCAClient, /settings/NSCA/client/targets/sample)¶VERIFY MODE
Path: /settings/NSCA/client/targets/sample
Key: verify mode
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
NSCAClient
Sample:
[/settings/NSCA/client/targets/sample] # VERIFY MODE verify mode=