NSCAClient
NSCA client can be used both from command line and from queries to submit passive checks via NSCA

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 avalible queries (check commands)

Command Description
nsca_submit Submit information to remote host via NSCA.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/NSCA/client hostname auto HOSTNAME
/settings/NSCA/client channel NSCA CHANNEL
/settings/NSCA/client/handlers     CLIENT HANDLER SECTION
/settings/NSCA/client/targets     REMOTE TARGET DEFINITIONS
/settings/NSCA/client/targets/default certificate   SSL CERTIFICATE
/settings/NSCA/client/targets/default verify mode none VERIFY MODE
/settings/NSCA/client/targets/default encryption aes ENCRYPTION
/settings/NSCA/client/targets/default allowed ciphers ADH ALLOWED CIPHERS
/settings/NSCA/client/targets/default timeout 30 TIMEOUT
/settings/NSCA/client/targets/default address   TARGET ADDRESS
/settings/NSCA/client/targets/default password   PASSWORD
/settings/NSCA/client/targets/default use ssl 0 ENABLE SSL ENCRYPTION

Advanced keys:

Path / Section Key Default value Description
/settings/NSCA/client delay 0 DELAY
/settings/NSCA/client encoding   NSCA DATA ENCODING
/settings/NSCA/client/targets/default parent default PARENT
/settings/NSCA/client/targets/default time offset 0 TIME OFFSET
/settings/NSCA/client/targets/default certificate format PEM CERTIFICATE FORMAT
/settings/NSCA/client/targets/default dh ${certificate-path}/nrpe_dh_512.pem DH KEY
/settings/NSCA/client/targets/default encoding   ENCODING
/settings/NSCA/client/targets/default ca   CA
/settings/NSCA/client/targets/default certificate key   SSL CERTIFICATE
/settings/NSCA/client/targets/default port 0 TARGET PORT
/settings/NSCA/client/targets/default alias   ALIAS
/settings/NSCA/client/targets/default host   TARGET HOST
/settings/NSCA/client/targets/default payload length 512 PAYLOAD LENGTH
/settings/NSCA/client/targets/default is template 0 IS TEMPLATE

Sample keys:

Path / Section Key Default value Description
/settings/NSCA/client/targets/sample parent default PARENT
/settings/NSCA/client/targets/sample time offset 0 TIME OFFSET
/settings/NSCA/client/targets/sample certificate format PEM CERTIFICATE FORMAT
/settings/NSCA/client/targets/sample dh ${certificate-path}/nrpe_dh_512.pem DH KEY
/settings/NSCA/client/targets/sample certificate   SSL CERTIFICATE
/settings/NSCA/client/targets/sample encoding   ENCODING
/settings/NSCA/client/targets/sample verify mode none VERIFY MODE
/settings/NSCA/client/targets/sample encryption aes ENCRYPTION
/settings/NSCA/client/targets/sample ca   CA
/settings/NSCA/client/targets/sample certificate key   SSL CERTIFICATE
/settings/NSCA/client/targets/sample port 0 TARGET PORT
/settings/NSCA/client/targets/sample alias   ALIAS
/settings/NSCA/client/targets/sample host   TARGET HOST
/settings/NSCA/client/targets/sample allowed ciphers ADH ALLOWED CIPHERS
/settings/NSCA/client/targets/sample payload length 512 PAYLOAD LENGTH
/settings/NSCA/client/targets/sample timeout 30 TIMEOUT
/settings/NSCA/client/targets/sample address   TARGET ADDRESS
/settings/NSCA/client/targets/sample password   PASSWORD
/settings/NSCA/client/targets/sample use ssl 0 ENABLE SSL ENCRYPTION
/settings/NSCA/client/targets/sample is template 0 IS TEMPLATE

Queries

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

nsca_submit

NSCAClientnsca_submit
Submit information to remote host via NSCA.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
host N/A The host of the host running the server
port N/A The port of the host running the server
address N/A The address (host:port) of the host running the server
timeout N/A Number of seconds before connection times out (default=10)
target N/A Target to use (lookup connection info from config)
retry N/A Number of times ti retry a failed connection attempt (default=2)
command N/A The name of the command that the remote daemon should run
alias N/A Same as command
message N/A Message
result N/A Result code either a number or OK, WARN, CRIT, UNKNOWN
encryption N/A Name of encryption algorithm to use.
certificate N/A Length of payload (has to be same as on the server)
dh N/A Length of payload (has to be same as on the server)
certificate-key N/A Client certificate to use
certificate-format N/A Client certificate format
ca N/A Certificate authority
verify N/A Client certificate format
allowed-ciphers N/A Client certificate format
payload-length N/A Length of payload (has to be same as on the server)
buffer-length N/A 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 N/A  
password N/A Password
source-host N/A Source/sender host name (default is auto which means use the name of the actual host)
sender-host N/A Source/sender host name (default is auto which means use the name of the actual host)
time-offset N/A  

Arguments

help (NSCAClient, nsca_submit)
Show help screen (this screen)
help-csv (NSCAClient, nsca_submit)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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)

Configuration

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

... / client / handlers

/settings/NSCA/client/handlers (NSCAClient)

Sample:

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

... / client

/settings/NSCA/client (NSCAClient)
Key Default Value Description
channel NSCA CHANNEL
hostname auto HOSTNAME
delay 0 DELAY
encoding   NSCA DATA ENCODING

Sample:

# NSCA CLIENT SECTION
# Section for NSCA passive check module.
[/settings/NSCA/client]
# DELAY
#
delay=0
# HOSTNAME
# The host name of the monitored computer.
hostname=auto
# CHANNEL
# The channel to listen to.
channel=NSCA
# NSCA DATA ENCODING
#
encoding=
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:

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

# HOSTNAME
# The host name of the monitored computer.
[/settings/NSCA/client]
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:

# CHANNEL
# The channel to listen to.
[/settings/NSCA/client]
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:

# NSCA DATA ENCODING
#
[/settings/NSCA/client]
encoding=

... / client / targets

/settings/NSCA/client/targets (NSCAClient)

Sample:

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

... / client / targets / default

/settings/NSCA/client/targets/default (NSCAClient)
Key Default Value Description
address   TARGET ADDRESS
allowed ciphers ADH ALLOWED CIPHERS
certificate   SSL CERTIFICATE
encryption aes ENCRYPTION
password   PASSWORD
timeout 30 TIMEOUT
use ssl 0 ENABLE SSL ENCRYPTION
verify mode none VERIFY MODE
alias   ALIAS
ca   CA
certificate format PEM CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh ${certificate-path}/nrpe_dh_512.pem DH KEY
encoding   ENCODING
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
payload length 512 PAYLOAD LENGTH
port 0 TARGET PORT
time offset 0 TIME OFFSET

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/NSCA/client/targets/default]
# PARENT
# The parent the target inherits from
parent=default
# TIME OFFSET
# Time offset.
time offset=0
# CERTIFICATE FORMAT
#
certificate format=PEM
# DH KEY
#
dh=${certificate-path}/nrpe_dh_512.pem
# SSL CERTIFICATE
#
certificate=
# ENCODING
#
encoding=
# VERIFY MODE
#
verify mode=none
# ENCRYPTION
# Name of encryption algorithm to use.
encryption=aes
# CA
#
ca=
# SSL CERTIFICATE
#
certificate key=
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
allowed ciphers=ADH
# 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.
payload length=512
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# TARGET ADDRESS
# Target host address
address=
# PASSWORD
# The password to use. Again has to be the same as the server or it wont work at all.
password=
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
use ssl=0
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
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:

# PARENT
# The parent the target inherits from
[/settings/NSCA/client/targets/default]
parent=default
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:

# TIME OFFSET
# Time offset.
[/settings/NSCA/client/targets/default]
time offset=0
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:

# CERTIFICATE FORMAT
#
[/settings/NSCA/client/targets/default]
certificate format=PEM
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:

# DH KEY
#
[/settings/NSCA/client/targets/default]
dh=${certificate-path}/nrpe_dh_512.pem
certificate (NSCAClient, /settings/NSCA/client/targets/default)

SSL CERTIFICATE


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

Key: certificate

Default value:

Used by: NSCAClient

Sample:

# SSL CERTIFICATE
#
[/settings/NSCA/client/targets/default]
certificate=
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:

# ENCODING
#
[/settings/NSCA/client/targets/default]
encoding=
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:

# VERIFY MODE
#
[/settings/NSCA/client/targets/default]
verify mode=none
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:

# ENCRYPTION
# Name of encryption algorithm to use.
[/settings/NSCA/client/targets/default]
encryption=aes
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:

# CA
#
[/settings/NSCA/client/targets/default]
ca=
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:

# SSL CERTIFICATE
#
[/settings/NSCA/client/targets/default]
certificate key=
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:

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

# ALIAS
# The alias (service name) to report to server
[/settings/NSCA/client/targets/default]
alias=
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:

# TARGET HOST
# The target server to report results to.
[/settings/NSCA/client/targets/default]
host=
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:

# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
[/settings/NSCA/client/targets/default]
allowed ciphers=ADH
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:

# 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.
[/settings/NSCA/client/targets/default]
payload length=512
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:

# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
[/settings/NSCA/client/targets/default]
timeout=30
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:

# TARGET ADDRESS
# Target host address
[/settings/NSCA/client/targets/default]
address=
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:

# PASSWORD
# The password to use. Again has to be the same as the server or it wont work at all.
[/settings/NSCA/client/targets/default]
password=
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:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
[/settings/NSCA/client/targets/default]
use ssl=0
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:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/NSCA/client/targets/default]
is template=0

... / client / targets / sample

/settings/NSCA/client/targets/sample (NSCAClient)
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]
# PARENT
# The parent the target inherits from
parent=default
# TIME OFFSET
# Time offset.
time offset=0
# CERTIFICATE FORMAT
#
certificate format=PEM
# DH KEY
#
dh=${certificate-path}/nrpe_dh_512.pem
# SSL CERTIFICATE
#
certificate=
# ENCODING
#
encoding=
# VERIFY MODE
#
verify mode=none
# ENCRYPTION
# Name of encryption algorithm to use.
encryption=aes
# CA
#
ca=
# SSL CERTIFICATE
#
certificate key=
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
allowed ciphers=ADH
# 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.
payload length=512
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# TARGET ADDRESS
# Target host address
address=
# PASSWORD
# The password to use. Again has to be the same as the server or it wont work at all.
password=
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
use ssl=0
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
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:

# PARENT
# The parent the target inherits from
[/settings/NSCA/client/targets/sample]
parent=default
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:

# TIME OFFSET
# Time offset.
[/settings/NSCA/client/targets/sample]
time offset=0
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:

# CERTIFICATE FORMAT
#
[/settings/NSCA/client/targets/sample]
certificate format=PEM
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:

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

# SSL CERTIFICATE
#
[/settings/NSCA/client/targets/sample]
certificate=
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:

# ENCODING
#
[/settings/NSCA/client/targets/sample]
encoding=
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:

# VERIFY MODE
#
[/settings/NSCA/client/targets/sample]
verify mode=none
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:

# ENCRYPTION
# Name of encryption algorithm to use.
[/settings/NSCA/client/targets/sample]
encryption=aes
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:

# CA
#
[/settings/NSCA/client/targets/sample]
ca=
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:

# SSL CERTIFICATE
#
[/settings/NSCA/client/targets/sample]
certificate key=
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:

# TARGET PORT
# The target server port
[/settings/NSCA/client/targets/sample]
port=0
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:

# ALIAS
# The alias (service name) to report to server
[/settings/NSCA/client/targets/sample]
alias=
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:

# TARGET HOST
# The target server to report results to.
[/settings/NSCA/client/targets/sample]
host=
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:

# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
[/settings/NSCA/client/targets/sample]
allowed ciphers=ADH
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:

# 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.
[/settings/NSCA/client/targets/sample]
payload length=512
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:

# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
[/settings/NSCA/client/targets/sample]
timeout=30
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:

# TARGET ADDRESS
# Target host address
[/settings/NSCA/client/targets/sample]
address=
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:

# PASSWORD
# The password to use. Again has to be the same as the server or it wont work at all.
[/settings/NSCA/client/targets/sample]
password=
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:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
[/settings/NSCA/client/targets/sample]
use ssl=0
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:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/NSCA/client/targets/sample]
is template=0
comments powered by Disqus