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

Command | Description
--- | ---
`nrdp_submit` | Submit information to remote host via NRDP.

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

Configuration (Overview):

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` | `recipient` | RECIPIENT
`/settings/NRDP/client/targets/default` | `sender` | SENDER
`/settings/NRDP/client/targets/default` | `template` | TEMPLATE
`/settings/NRDP/client/targets/default` | `timeout` | TIMEOUT

Advanced keys:

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

Sample keys:

Path / Section | Key | Default Value | Description
--- | --- | --- | ---
`/settings/NRDP/client/targets/sample` | `address` | TARGET ADDRESS |
`/settings/NRDP/client/targets/sample` | `alias` | ALIAS |
`/settings/NRDP/client/targets/sample` | `host` | TARGET HOST |
`/settings/NRDP/client/targets/sample` | `is template` | IS TEMPLATE |
`/settings/NRDP/client/targets/sample` | `parent` | PARENT |
`/settings/NRDP/client/targets/sample` | `port` | TARGET PORT |
`/settings/NRDP/client/targets/sample` | `recipient` | RECIPIENT |
`/settings/NRDP/client/targets/sample` | `sender` | SENDER |
`/settings/NRDP/client/targets/sample` | `template` | TEMPLATE |
`/settings/NRDP/client/targets/sample` | `timeout` | TIMEOUT |

## Queries

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

### `nrdp_submit`

`NRDPClient` `nrdp_submit`
Submit information to remote host via NRDP.

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
`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

#### Arguments

`help` (NRDPClient, nrdp_submit)
  Show help screen (this screen)

`help-pb` (NRDPClient, nrdp_submit)
  Show help screen as a protocol buffer payload

`show-default` (NRDPClient, nrdp_submit)
  Show default values for a given command

`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

### / settings/ NRDP/ client

`/settings/NRDP/client` (NRDPClient)

SMTP CLIENT SECTION

> Section for SMTP passive check module.

> Key | Default Value | Description
> --- | --- | ---
> `channel` | NRDP | CHANNEL
> `hostname` | auto | HOSTNAME

> Sample:

>     # SMTP CLIENT SECTION
>     # Section for SMTP passive check module.
>     [/settings/NRDP/client]
>     channel=NRDP
>     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:

>       [/settings/NRDP/client]
>       # CHANNEL
>       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:

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

### … / handlers

`/settings/NRDP/client/handlers` (NRDPClient)

CLIENT HANDLER SECTION

> Sample:

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

### … / targets

`/settings/NRDP/client/targets` (NRDPClient)

REMOTE TARGET DEFINITIONS

> Sample:

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

### … / targets / default

`/settings/NRDP/client/targets/default` (NRDPClient)

TARGET DEFENITION

> Target definition for: default

> 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: default
>     [/settings/NRDP/client/targets/default]
>     address=
>     alias=
>     host=
>     is template=0
>     parent=default
>     port=0
>     recipient=nscp@localhost
>     sender=nscp@localhost
>     template=Hello, this is %source% reporting %message%!
>     timeout=30

> `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:

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

> `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:

>       [/settings/NRDP/client/targets/default]
>       # ALIAS
>       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:

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

> `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:

>       [/settings/NRDP/client/targets/default]
>       # IS TEMPLATE
>       is template=0

> `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:

>       [/settings/NRDP/client/targets/default]
>       # PARENT
>       parent=default

> `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:

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

> `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:

>       [/settings/NRDP/client/targets/default]
>       # RECIPIENT
>       recipient=nscp@localhost

> `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:

>       [/settings/NRDP/client/targets/default]
>       # SENDER
>       sender=nscp@localhost

> `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:

>       [/settings/NRDP/client/targets/default]
>       # TEMPLATE
>       template=Hello, this is %source% reporting %message%!

> `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:

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

### … / targets / sample

`/settings/NRDP/client/targets/sample` (NRDPClient)

TARGET DEFENITION

> Target definition for: sample

> 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]
>     address=
>     alias=
>     host=
>     is template=0
>     parent=default
>     port=0
>     recipient=nscp@localhost
>     sender=nscp@localhost
>     template=Hello, this is %source% reporting %message%!
>     timeout=30

> `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:

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

> `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:

>       [/settings/NRDP/client/targets/sample]
>       # ALIAS
>       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:

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

> `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:

>       [/settings/NRDP/client/targets/sample]
>       # IS TEMPLATE
>       is template=0

> `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:

>       [/settings/NRDP/client/targets/sample]
>       # PARENT
>       parent=default

> `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:

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

> `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:

>       [/settings/NRDP/client/targets/sample]
>       # RECIPIENT
>       recipient=nscp@localhost

> `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:

>       [/settings/NRDP/client/targets/sample]
>       # SENDER
>       sender=nscp@localhost

> `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:

>       [/settings/NRDP/client/targets/sample]
>       # TEMPLATE
>       template=Hello, this is %source% reporting %message%!

> `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:

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

comments powered by Disqus