NRDPClient#

NRDP client can be used both from command line and from queries to check remote systes via NRDP

List of commands#

A list of all available queries (check commands)

Command Description
submit_nrdp Submit information to the remote NRDP Server.

List of Configuration#

Common Keys#

Path / Section Key Description
/settings/NRDP/client channel CHANNEL
/settings/NRDP/client hostname HOSTNAME
/settings/NRDP/client/targets/default address TARGET ADDRESS
/settings/NRDP/client/targets/default key SECURITY TOKEN
/settings/NRDP/client/targets/default password SECURITY TOKEN
/settings/NRDP/client/targets/default retries RETRIES
/settings/NRDP/client/targets/default timeout TIMEOUT
/settings/NRDP/client/targets/default token SECURITY TOKEN

Advanced keys#

Path / Section Key Description
/settings/NRDP/client/targets/default host TARGET HOST
/settings/NRDP/client/targets/default port TARGET PORT

Sample keys#

Path / Section Key Description
/settings/NRDP/client/targets/sample address TARGET ADDRESS
/settings/NRDP/client/targets/sample host TARGET HOST
/settings/NRDP/client/targets/sample key SECURITY TOKEN
/settings/NRDP/client/targets/sample password SECURITY TOKEN
/settings/NRDP/client/targets/sample port TARGET PORT
/settings/NRDP/client/targets/sample retries RETRIES
/settings/NRDP/client/targets/sample timeout TIMEOUT
/settings/NRDP/client/targets/sample token SECURITY TOKEN

Queries#

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

submit_nrdp#

Submit information to the remote NRDP Server.

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
key The security token
password The security token
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)
token The security token

help#

Description: Show help screen (this screen)

help-pb#

Description: Show help screen as a protocol buffer payload

show-default#

Description: Show default values for a given command

help-short#

Description: Show help screen (short format).

host#

Description: The host of the host running the server

port#

Description: The port of the host running the server

address#

Description: The address (host:port) of the host running the server

timeout#

Description: Number of seconds before connection times out (default=10)

target#

Description: Target to use (lookup connection info from config)

retry#

Description: Number of times ti retry a failed connection attempt (default=2)

retries#

Description: legacy version of retry

source-host#

Description: Source/sender host name (default is auto which means use the name of the actual host)

sender-host#

Description: Source/sender host name (default is auto which means use the name of the actual host)

command#

Description: The name of the command that the remote daemon should run

alias#

Description: Same as command

message#

Description: Message

result#

Description: Result code either a number or OK, WARN, CRIT, UNKNOWN

separator#

Description: Separator to use for the batch command (default is |)

batch#

Description: Add multiple records using the separator format is: command|result|message

key#

Description: The security token

password#

Description: The security token

source-host#

Description: Source/sender host name (default is auto which means use the name of the actual host)

sender-host#

Description: Source/sender host name (default is auto which means use the name of the actual host)

token#

Description: The security token

Configuration#

SMTP CLIENT SECTION#

Section for SMTP passive check module.

# Section for SMTP passive check module.
[/settings/NRDP/client]
channel=NRDP
hostname=auto
Key Default Value Description
channel NRDP CHANNEL
hostname auto HOSTNAME

channel#

CHANNEL

The channel to listen to.

Key Description
Path: /settings/NRDP/client
Key: channel
Default value: NRDP
Used by: NRDPClient

Sample#

[/settings/NRDP/client]
# CHANNEL
channel=NRDP

hostname#

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

Key Description
Path: /settings/NRDP/client
Key: hostname
Default value: auto
Used by: NRDPClient

Sample#

[/settings/NRDP/client]
# HOSTNAME
hostname=auto

CLIENT HANDLER SECTION#

# 
[/settings/NRDP/client/handlers]

REMOTE TARGET DEFINITIONS#

# 
[/settings/NRDP/client/targets]

TARGET#

Target definition for: default

# Target definition for: default
[/settings/NRDP/client/targets/default]
retries=3
timeout=30
Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
key SECURITY TOKEN
password SECURITY TOKEN
port TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT
token SECURITY TOKEN

address#

TARGET ADDRESS

Target host address

Key Description
Path: /settings/NRDP/client/targets/default
Key: address
Default value: N/A
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# TARGET ADDRESS
address=

host#

TARGET HOST

The target server to report results to.

Key Description
Path: /settings/NRDP/client/targets/default
Key: host
Advanced: Yes (means it is not commonly used)
Default value: N/A
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# TARGET HOST
host=

key#

SECURITY TOKEN

The security token

Key Description
Path: /settings/NRDP/client/targets/default
Key: key
Default value: N/A
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# SECURITY TOKEN
key=

password#

SECURITY TOKEN

The security token

Key Description
Path: /settings/NRDP/client/targets/default
Key: password
Default value: N/A
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# SECURITY TOKEN
password=

port#

TARGET PORT

The target server port

Key Description
Path: /settings/NRDP/client/targets/default
Key: port
Advanced: Yes (means it is not commonly used)
Default value: N/A
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# TARGET PORT
port=

retries#

RETRIES

Number of times to retry sending.

Key Description
Path: /settings/NRDP/client/targets/default
Key: retries
Default value: 3
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# RETRIES
retries=3

timeout#

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key Description
Path: /settings/NRDP/client/targets/default
Key: timeout
Default value: 30
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# TIMEOUT
timeout=30

token#

SECURITY TOKEN

The security token

Key Description
Path: /settings/NRDP/client/targets/default
Key: token
Default value: N/A
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/default]
# SECURITY TOKEN
token=

TARGET#

Target definition for: sample

# Target definition for: sample
[/settings/NRDP/client/targets/sample]
retries=3
timeout=30
Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
key SECURITY TOKEN
password SECURITY TOKEN
port TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT
token SECURITY TOKEN

address#

TARGET ADDRESS

Target host address

Key Description
Path: /settings/NRDP/client/targets/sample
Key: address
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# TARGET ADDRESS
address=

host#

TARGET HOST

The target server to report results to.

Key Description
Path: /settings/NRDP/client/targets/sample
Key: host
Advanced: Yes (means it is not commonly used)
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# TARGET HOST
host=

key#

SECURITY TOKEN

The security token

Key Description
Path: /settings/NRDP/client/targets/sample
Key: key
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# SECURITY TOKEN
key=

password#

SECURITY TOKEN

The security token

Key Description
Path: /settings/NRDP/client/targets/sample
Key: password
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# SECURITY TOKEN
password=

port#

TARGET PORT

The target server port

Key Description
Path: /settings/NRDP/client/targets/sample
Key: port
Advanced: Yes (means it is not commonly used)
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# TARGET PORT
port=

retries#

RETRIES

Number of times to retry sending.

Key Description
Path: /settings/NRDP/client/targets/sample
Key: retries
Default value: 3
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# RETRIES
retries=3

timeout#

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key Description
Path: /settings/NRDP/client/targets/sample
Key: timeout
Default value: 30
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# TIMEOUT
timeout=30

token#

SECURITY TOKEN

The security token

Key Description
Path: /settings/NRDP/client/targets/sample
Key: token
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: NRDPClient

Sample#

[/settings/NRDP/client/targets/sample]
# SECURITY TOKEN
token=