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

NRDPClient — NRDPClient

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

Queries (Overview):

A list of all avalible queries (check commands)

Command Description
nrdp_submit Submit information to remote host via NRDP.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/NRDP/client hostname auto HOSTNAME
/settings/NRDP/client channel NRDP CHANNEL
/settings/NRDP/client/handlers     CLIENT HANDLER SECTION
/settings/NRDP/client/targets     REMOTE TARGET DEFINITIONS
/settings/NRDP/client/targets/default sender nscp@localhost SENDER
/settings/NRDP/client/targets/default timeout 30 TIMEOUT
/settings/NRDP/client/targets/default template Hello, this is %source% reporting %message%! TEMPLATE
/settings/NRDP/client/targets/default address   TARGET ADDRESS
/settings/NRDP/client/targets/default recipient nscp@localhost RECIPIENT

Advanced keys:

Path / Section Key Default value Description
/settings/NRDP/client/targets/default parent default PARENT
/settings/NRDP/client/targets/default is template 0 IS TEMPLATE
/settings/NRDP/client/targets/default alias   ALIAS
/settings/NRDP/client/targets/default host   TARGET HOST
/settings/NRDP/client/targets/default port 0 TARGET PORT

Sample keys:

Path / Section Key Default value Description
/settings/NRDP/client/targets/sample sender nscp@localhost SENDER
/settings/NRDP/client/targets/sample parent default PARENT
/settings/NRDP/client/targets/sample timeout 30 TIMEOUT
/settings/NRDP/client/targets/sample is template 0 IS TEMPLATE
/settings/NRDP/client/targets/sample alias   ALIAS
/settings/NRDP/client/targets/sample host   TARGET HOST
/settings/NRDP/client/targets/sample template Hello, this is %source% reporting %message%! TEMPLATE
/settings/NRDP/client/targets/sample address   TARGET ADDRESS
/settings/NRDP/client/targets/sample recipient nscp@localhost RECIPIENT
/settings/NRDP/client/targets/sample port 0 TARGET PORT

Queries

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

nrdp_submit

NRDPClientnrdp_submit
Submit information to remote host via NRDP.

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

Arguments

help (NRDPClient, nrdp_submit)
Show help screen (this screen)
help-csv (NRDPClient, nrdp_submit)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (NRDPClient, nrdp_submit)
Show help screen (short format).
host (NRDPClient, nrdp_submit)
The host of the host running the server
port (NRDPClient, nrdp_submit)
The port of the host running the server
address (NRDPClient, nrdp_submit)
The address (host:port) of the host running the server
timeout (NRDPClient, nrdp_submit)
Number of seconds before connection times out (default=10)
target (NRDPClient, nrdp_submit)
Target to use (lookup connection info from config)
retry (NRDPClient, nrdp_submit)
Number of times ti retry a failed connection attempt (default=2)
command (NRDPClient, nrdp_submit)
The name of the command that the remote daemon should run
alias (NRDPClient, nrdp_submit)
Same as command
message (NRDPClient, nrdp_submit)
Message
result (NRDPClient, nrdp_submit)
Result code either a number or OK, WARN, CRIT, UNKNOWN
key (NRDPClient, nrdp_submit)
The security token
password (NRDPClient, nrdp_submit)
The security token
source-host (NRDPClient, nrdp_submit)
Source/sender host name (default is auto which means use the name of the actual host)
sender-host (NRDPClient, nrdp_submit)
Source/sender host name (default is auto which means use the name of the actual host)
token (NRDPClient, nrdp_submit)
The security token

Configuration

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

... / client

/settings/NRDP/client (NRDPClient)
Key Default Value Description
channel NRDP CHANNEL
hostname auto HOSTNAME

Sample:

# SMTP CLIENT SECTION
# Section for SMTP passive check module.
[/settings/NRDP/client]
# HOSTNAME
# The host name of this host if set to blank (default) the windows name of the computer will be used.
hostname=auto
# CHANNEL
# The channel to listen to.
channel=NRDP
hostname (NRDPClient, /settings/NRDP/client)

HOSTNAME

The host name of this host if set to blank (default) the windows name of the computer will be used.

Path: /settings/NRDP/client

Key: hostname

Default value: auto

Used by: NRDPClient

Sample:

# HOSTNAME
# The host name of this host if set to blank (default) the windows name of the computer will be used.
[/settings/NRDP/client]
hostname=auto
channel (NRDPClient, /settings/NRDP/client)

CHANNEL

The channel to listen to.

Path: /settings/NRDP/client

Key: channel

Default value: NRDP

Used by: NRDPClient

Sample:

# CHANNEL
# The channel to listen to.
[/settings/NRDP/client]
channel=NRDP

... / client / targets / default

/settings/NRDP/client/targets/default (NRDPClient)
Key Default Value Description
address   TARGET ADDRESS
recipient nscp@localhost RECIPIENT
sender nscp@localhost SENDER
template Hello, this is %source% reporting %message%! TEMPLATE
timeout 30 TIMEOUT
alias   ALIAS
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
port 0 TARGET PORT

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/NRDP/client/targets/default]
# SENDER
# Sender of email message
[email protected]
# PARENT
# The parent the target inherits from
parent=default
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# TEMPLATE
# Template for message data
template=Hello, this is %source% reporting %message%!
# TARGET ADDRESS
# Target host address
address=
# RECIPIENT
# Recipient of email message
[email protected]
# TARGET PORT
# The target server port
port=0
sender (NRDPClient, /settings/NRDP/client/targets/default)

SENDER

Sender of email message

Path: /settings/NRDP/client/targets/default

Key: sender

Default value: nscp@localhost

Used by: NRDPClient

Sample:

# SENDER
# Sender of email message
[/settings/NRDP/client/targets/default]
[email protected]
parent (NRDPClient, /settings/NRDP/client/targets/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/NRDP/client/targets/default

Key: parent

Default value: default

Used by: NRDPClient

Sample:

# PARENT
# The parent the target inherits from
[/settings/NRDP/client/targets/default]
parent=default
timeout (NRDPClient, /settings/NRDP/client/targets/default)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/NRDP/client/targets/default

Key: timeout

Default value: 30

Used by: NRDPClient

Sample:

# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
[/settings/NRDP/client/targets/default]
timeout=30
is template (NRDPClient, /settings/NRDP/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/NRDP/client/targets/default

Key: is template

Default value: 0

Used by: NRDPClient

Sample:

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

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/NRDP/client/targets/default

Key: alias

Default value:

Used by: NRDPClient

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/NRDP/client/targets/default]
alias=
host (NRDPClient, /settings/NRDP/client/targets/default)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/NRDP/client/targets/default

Key: host

Default value:

Used by: NRDPClient

Sample:

# TARGET HOST
# The target server to report results to.
[/settings/NRDP/client/targets/default]
host=
template (NRDPClient, /settings/NRDP/client/targets/default)

TEMPLATE

Template for message data

Path: /settings/NRDP/client/targets/default

Key: template

Default value: Hello, this is %source% reporting %message%!

Used by: NRDPClient

Sample:

# TEMPLATE
# Template for message data
[/settings/NRDP/client/targets/default]
template=Hello, this is %source% reporting %message%!
address (NRDPClient, /settings/NRDP/client/targets/default)

TARGET ADDRESS

Target host address

Path: /settings/NRDP/client/targets/default

Key: address

Default value:

Used by: NRDPClient

Sample:

# TARGET ADDRESS
# Target host address
[/settings/NRDP/client/targets/default]
address=
recipient (NRDPClient, /settings/NRDP/client/targets/default)

RECIPIENT

Recipient of email message

Path: /settings/NRDP/client/targets/default

Key: recipient

Default value: nscp@localhost

Used by: NRDPClient

Sample:

# RECIPIENT
# Recipient of email message
[/settings/NRDP/client/targets/default]
[email protected]
port (NRDPClient, /settings/NRDP/client/targets/default)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/NRDP/client/targets/default

Key: port

Default value: 0

Used by: NRDPClient

Sample:

# TARGET PORT
# The target server port
[/settings/NRDP/client/targets/default]
port=0

... / client / targets

/settings/NRDP/client/targets (NRDPClient)

Sample:

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

... / client / handlers

/settings/NRDP/client/handlers (NRDPClient)

Sample:

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

... / client / targets / sample

/settings/NRDP/client/targets/sample (NRDPClient)
Key Default Value Description
address   TARGET ADDRESS
alias   ALIAS
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
port 0 TARGET PORT
recipient nscp@localhost RECIPIENT
sender nscp@localhost SENDER
template Hello, this is %source% reporting %message%! TEMPLATE
timeout 30 TIMEOUT

Sample:

# TARGET DEFENITION
# Target definition for: sample
[/settings/NRDP/client/targets/sample]
# SENDER
# Sender of email message
[email protected]
# PARENT
# The parent the target inherits from
parent=default
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# TEMPLATE
# Template for message data
template=Hello, this is %source% reporting %message%!
# TARGET ADDRESS
# Target host address
address=
# RECIPIENT
# Recipient of email message
[email protected]
# TARGET PORT
# The target server port
port=0
sender (NRDPClient, /settings/NRDP/client/targets/sample)

SENDER

Sender of email message

Path: /settings/NRDP/client/targets/sample

Key: sender

Default value: nscp@localhost

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

Used by: NRDPClient

Sample:

# SENDER
# Sender of email message
[/settings/NRDP/client/targets/sample]
[email protected]
parent (NRDPClient, /settings/NRDP/client/targets/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/NRDP/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: NRDPClient

Sample:

# PARENT
# The parent the target inherits from
[/settings/NRDP/client/targets/sample]
parent=default
timeout (NRDPClient, /settings/NRDP/client/targets/sample)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/NRDP/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: NRDPClient

Sample:

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

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/NRDP/client/targets/sample]
is template=0
alias (NRDPClient, /settings/NRDP/client/targets/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/NRDP/client/targets/sample

Key: alias

Default value:

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

Used by: NRDPClient

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/NRDP/client/targets/sample]
alias=
host (NRDPClient, /settings/NRDP/client/targets/sample)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/NRDP/client/targets/sample

Key: host

Default value:

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

Used by: NRDPClient

Sample:

# TARGET HOST
# The target server to report results to.
[/settings/NRDP/client/targets/sample]
host=
template (NRDPClient, /settings/NRDP/client/targets/sample)

TEMPLATE

Template for message data

Path: /settings/NRDP/client/targets/sample

Key: template

Default value: Hello, this is %source% reporting %message%!

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

Used by: NRDPClient

Sample:

# TEMPLATE
# Template for message data
[/settings/NRDP/client/targets/sample]
template=Hello, this is %source% reporting %message%!
address (NRDPClient, /settings/NRDP/client/targets/sample)

TARGET ADDRESS

Target host address

Path: /settings/NRDP/client/targets/sample

Key: address

Default value:

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

Used by: NRDPClient

Sample:

# TARGET ADDRESS
# Target host address
[/settings/NRDP/client/targets/sample]
address=
recipient (NRDPClient, /settings/NRDP/client/targets/sample)

RECIPIENT

Recipient of email message

Path: /settings/NRDP/client/targets/sample

Key: recipient

Default value: nscp@localhost

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

Used by: NRDPClient

Sample:

# RECIPIENT
# Recipient of email message
[/settings/NRDP/client/targets/sample]
[email protected]
port (NRDPClient, /settings/NRDP/client/targets/sample)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/NRDP/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: NRDPClient

Sample:

# TARGET PORT
# The target server port
[/settings/NRDP/client/targets/sample]
port=0
comments powered by Disqus