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
`nsca_submit`	Submit information to remote host via NSCA.

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`	`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
`/settings/NSCA/client`	`delay`	DELAY
`/settings/NSCA/client`	`encoding`	NSCA DATA ENCODING
`/settings/NSCA/client/targets/default`	`alias`	ALIAS
`/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`	`is template`	IS TEMPLATE
`/settings/NSCA/client/targets/default`	`parent`	PARENT
`/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:

Path / Section	Key	Default Value
`/settings/NSCA/client/targets/sample`	`address`	TARGET ADDRESS
`/settings/NSCA/client/targets/sample`	`alias`	ALIAS
`/settings/NSCA/client/targets/sample`	`allowed ciphers`	ALLOWED CIPHERS
`/settings/NSCA/client/targets/sample`	`ca`	CA
`/settings/NSCA/client/targets/sample`	`certificate`	SSL CERTIFICATE
`/settings/NSCA/client/targets/sample`	`certificate format`	CERTIFICATE FORMAT
`/settings/NSCA/client/targets/sample`	`certificate key`	SSL CERTIFICATE
`/settings/NSCA/client/targets/sample`	`dh`	DH KEY
`/settings/NSCA/client/targets/sample`	`encoding`	ENCODING
`/settings/NSCA/client/targets/sample`	`encryption`	ENCRYPTION
`/settings/NSCA/client/targets/sample`	`host`	TARGET HOST
`/settings/NSCA/client/targets/sample`	`is template`	IS TEMPLATE
`/settings/NSCA/client/targets/sample`	`parent`	PARENT
`/settings/NSCA/client/targets/sample`	`password`	PASSWORD
`/settings/NSCA/client/targets/sample`	`payload length`	PAYLOAD LENGTH
`/settings/NSCA/client/targets/sample`	`port`	TARGET PORT
`/settings/NSCA/client/targets/sample`	`time offset`	TIME OFFSET
`/settings/NSCA/client/targets/sample`	`timeout`	TIMEOUT
`/settings/NSCA/client/targets/sample`	`use ssl`	ENABLE SSL ENCRYPTION
`/settings/NSCA/client/targets/sample`	`verify mode`	VERIFY MODE

Queries¶

A quick reference for all available queries (check commands) in the NSCAClient module.

`nsca_submit`¶

NSCAClientnsca_submit

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)
`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
`encryption`		Name of encryption algorithm to use.
`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
`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.
`ssl`	N/A	Initial an ssl handshake with the server.
`timeout`
`password`		Password
`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)
`time-offset`
`retries`		Number of times to retry a failed connection attempt

Arguments¶

help (NSCAClient, nsca_submit)¶: Show help screen (this screen)

help-pb (NSCAClient, nsca_submit)¶: Show help screen as a protocol buffer payload

show-default (NSCAClient, nsca_submit)¶: Show default values for a given command

help-short (NSCAClient, nsca_submit)¶: Show help screen (short format).

host (NSCAClient, nsca_submit)¶: The host of the host running the server

port (NSCAClient, nsca_submit)¶: The port of the host running the server

address (NSCAClient, nsca_submit)¶: The address (host:port) of the host running the server

timeout (NSCAClient, nsca_submit)¶: Number of seconds before connection times out (default=10)

target (NSCAClient, nsca_submit)¶: Target to use (lookup connection info from config)

retry (NSCAClient, nsca_submit)¶: Number of times ti retry a failed connection attempt (default=2)

command (NSCAClient, nsca_submit)¶: The name of the command that the remote daemon should run

alias (NSCAClient, nsca_submit)¶: Same as command

message (NSCAClient, nsca_submit)¶: Message

result (NSCAClient, nsca_submit)¶: Result code either a number or OK, WARN, CRIT, UNKNOWN

encryption (NSCAClient, nsca_submit)¶: 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 = XOR

des = DES

3des = DES-EDE3

cast128 = CAST-128

xtea = XTEA

blowfish = Blowfish

twofish = Twofish

rc2 = RC2

aes128 = AES

aes192 = AES

aes = AES

serpent = Serpent

gost = GOST

certificate (NSCAClient, nsca_submit)¶: Length of payload (has to be same as on the server)

dh (NSCAClient, nsca_submit)¶: Length of payload (has to be same as on the server)

certificate-key (NSCAClient, nsca_submit)¶: Client certificate to use

certificate-format (NSCAClient, nsca_submit)¶: Client certificate format

ca (NSCAClient, nsca_submit)¶: Certificate authority

verify (NSCAClient, nsca_submit)¶: Client certificate format

allowed-ciphers (NSCAClient, nsca_submit)¶: Client certificate format

payload-length (NSCAClient, nsca_submit)¶: Length of payload (has to be same as on the server)

buffer-length (NSCAClient, nsca_submit)¶: 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.

ssl (NSCAClient, nsca_submit)¶: Initial an ssl handshake with the server.

timeout (NSCAClient, nsca_submit)

password (NSCAClient, nsca_submit)¶: Password

source-host (NSCAClient, nsca_submit)¶: Source/sender host name (default is auto which means use the name of the actual host)

sender-host (NSCAClient, nsca_submit)¶: Source/sender host name (default is auto which means use the name of the actual host)

time-offset (NSCAClient, nsca_submit)¶

retries (NSCAClient, nsca_submit)¶: Number of times to retry a failed connection attempt

/ settings/ NSCA/ client¶

/settings/NSCA/client (NSCAClient)¶

NSCA CLIENT SECTION

Section for NSCA passive check module.

Key Default Value Description

channel NSCA CHANNEL

delay 0 DELAY

encoding NSCA DATA ENCODING

hostname auto HOSTNAME

Sample:
# NSCA CLIENT SECTION
# Section for NSCA passive check module.
[/settings/NSCA/client]
channel=NSCA
delay=0
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
delay (NSCAClient, /settings/NSCA/client)¶
DELAY

Advanced (means it is not commonly used)

Path: /settings/NSCA/client

Key: delay

Default value: 0

Used by: NSCAClient

Sample:
[/settings/NSCA/client]
# DELAY
delay=0
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 uppercase

Path: /settings/NSCA/client

Key: hostname

Default value: auto

Used by: NSCAClient

Sample:
[/settings/NSCA/client]
# HOSTNAME
hostname=auto

… / handlers¶

/settings/NSCA/client/handlers (NSCAClient)¶

CLIENT HANDLER SECTION

Sample:

# CLIENT HANDLER SECTION
#
[/settings/NSCA/client/handlers]

… / targets¶

/settings/NSCA/client/targets (NSCAClient)¶

REMOTE TARGET DEFINITIONS

Sample:

# REMOTE TARGET DEFINITIONS
#
[/settings/NSCA/client/targets]

… / targets / default¶

/settings/NSCA/client/targets/default (NSCAClient)¶

TARGET DEFENITION

Target definition for: default

Key Default Value Description

address TARGET ADDRESS

alias ALIAS

allowed ciphers ADH ALLOWED CIPHERS

ca CA

certificate SSL CERTIFICATE

certificate format PEM CERTIFICATE FORMAT

certificate key SSL CERTIFICATE

dh ${certificate-path}/nrpe_dh_512.pem DH KEY

encoding ENCODING

encryption aes ENCRYPTION

host TARGET HOST

is template 0 IS TEMPLATE

parent default PARENT

password PASSWORD

payload length 512 PAYLOAD LENGTH

port 0 TARGET PORT

time offset 0 TIME OFFSET

timeout 30 TIMEOUT

use ssl 0 ENABLE SSL ENCRYPTION

verify mode none VERIFY MODE

Sample:
# TARGET DEFENITION
# Target definition for: default
[/settings/NSCA/client/targets/default]
address=
alias=
allowed ciphers=ADH
ca=
certificate=
certificate format=PEM
certificate key=
dh=${certificate-path}/nrpe_dh_512.pem
encoding=
encryption=aes
host=
is template=0
parent=default
password=
payload length=512
port=0
time offset=0
timeout=30
use ssl=0
verify mode=none
address (NSCAClient, /settings/NSCA/client/targets/default)¶
TARGET ADDRESS

Target host address

Path: /settings/NSCA/client/targets/default

Key: address

Default value:

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# TARGET ADDRESS
address=
alias (NSCAClient, /settings/NSCA/client/targets/default)¶
ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: alias

Default value:

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# ALIAS
alias=
allowed ciphers (NSCAClient, /settings/NSCA/client/targets/default)¶
ALLOWED CIPHERS

A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

Path: /settings/NSCA/client/targets/default

Key: allowed ciphers

Default value: ADH

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# ALLOWED CIPHERS
allowed ciphers=ADH
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: PEM

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# CERTIFICATE FORMAT
certificate format=PEM
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: ${certificate-path}/nrpe_dh_512.pem

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# DH KEY
dh=${certificate-path}/nrpe_dh_512.pem
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 = XOR

des = DES

3des = DES-EDE3

cast128 = CAST-128

xtea = XTEA

blowfish = Blowfish

twofish = Twofish

rc2 = RC2

aes128 = AES

aes192 = AES

aes = AES

serpent = Serpent

gost = GOST

Path: /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=
is template (NSCAClient, /settings/NSCA/client/targets/default)¶
IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: is template

Default value: 0

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# IS TEMPLATE
is template=0
parent (NSCAClient, /settings/NSCA/client/targets/default)¶
PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: parent

Default value: default

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# PARENT
parent=default
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 port

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: port

Default value: 0

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# TARGET PORT
port=0
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: none

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/default]
# VERIFY MODE
verify mode=none

… / targets / sample¶

/settings/NSCA/client/targets/sample (NSCAClient)¶

TARGET DEFENITION

Target definition for: sample

Key Default Value Description

address TARGET ADDRESS

alias ALIAS

allowed ciphers ADH ALLOWED CIPHERS

ca CA

certificate SSL CERTIFICATE

certificate format PEM CERTIFICATE FORMAT

certificate key SSL CERTIFICATE

dh ${certificate-path}/nrpe_dh_512.pem DH KEY

encoding ENCODING

encryption aes ENCRYPTION

host TARGET HOST

is template 0 IS TEMPLATE

parent default PARENT

password PASSWORD

payload length 512 PAYLOAD LENGTH

port 0 TARGET PORT

time offset 0 TIME OFFSET

timeout 30 TIMEOUT

use ssl 0 ENABLE SSL ENCRYPTION

verify mode none VERIFY MODE

Sample:
# TARGET DEFENITION
# Target definition for: sample
[/settings/NSCA/client/targets/sample]
address=
alias=
allowed ciphers=ADH
ca=
certificate=
certificate format=PEM
certificate key=
dh=${certificate-path}/nrpe_dh_512.pem
encoding=
encryption=aes
host=
is template=0
parent=default
password=
payload length=512
port=0
time offset=0
timeout=30
use ssl=0
verify mode=none
address (NSCAClient, /settings/NSCA/client/targets/sample)¶
TARGET ADDRESS

Target host address

Path: /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=
alias (NSCAClient, /settings/NSCA/client/targets/sample)¶
ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample

Key: alias

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]
# ALIAS
alias=
allowed ciphers (NSCAClient, /settings/NSCA/client/targets/sample)¶
ALLOWED CIPHERS

A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

Path: /settings/NSCA/client/targets/sample

Key: allowed ciphers

Default value: ADH

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=ADH
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: PEM

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=PEM
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: ${certificate-path}/nrpe_dh_512.pem

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=${certificate-path}/nrpe_dh_512.pem
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 = XOR

des = DES

3des = DES-EDE3

cast128 = CAST-128

xtea = XTEA

blowfish = Blowfish

twofish = Twofish

rc2 = RC2

aes128 = AES

aes192 = AES

aes = AES

serpent = Serpent

gost = GOST

Path: /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=
is template (NSCAClient, /settings/NSCA/client/targets/sample)¶
IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample

Key: is template

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]
# IS TEMPLATE
is template=0
parent (NSCAClient, /settings/NSCA/client/targets/sample)¶
PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample

Key: parent

Default value: default

Sample key: This key is provided as a sample to show how to configure objects

Used by: NSCAClient

Sample:
[/settings/NSCA/client/targets/sample]
# PARENT
parent=default
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 port

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample

Key: port

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]
# TARGET PORT
port=0
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: none

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=none

comments powered by Disqus

`NSCAClient` — NSCAClient¶

Queries¶

`nsca_submit`¶

Arguments¶

/ settings/ NSCA/ client¶

… / handlers¶

… / targets¶

… / targets / default¶

… / targets / sample¶

Table Of Contents

Previous topic

Next topic

This Page

Key	Default Value	Description
`channel`	NSCA	CHANNEL
`delay`	0	DELAY
`encoding`		NSCA DATA ENCODING
`hostname`	auto	HOSTNAME

NSCAClient — NSCAClient¶

Queries¶

nsca_submit¶

Arguments¶

/ settings/ NSCA/ client¶

… / handlers¶

… / targets¶

… / targets / default¶

… / targets / sample¶

`NSCAClient` — NSCAClient¶

`nsca_submit`¶