NRPEClient
NRPE client can be used both from command line and from queries to check remote systes via NRPE as well as configure the NRPE server

NRPEClient — NRPEClient

NRPE client can be used both from command line and from queries to check remote systes via NRPE as well as configure the NRPE server

Queries (Overview):

A list of all available queries (check commands)

Command Description
check_nrpe Request remote information via NRPE.
exec_nrpe Execute remote script via NRPE. (Most likely you want nrpe_query).
nrpe_forward Forward the request as-is to remote host via NRPE.
nrpe_query Request remote information via NRPE.
submit_nrpe Submit information to remote host via NRPE. (Most likely you want nrpe_query).

Commands (Overview):

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

Configuration (Overview):

Common Keys:

Path / Section Key Description
/settings/NRPE/client channel CHANNEL
/settings/NRPE/client/targets/default address TARGET ADDRESS
/settings/NRPE/client/targets/default allowed ciphers ALLOWED CIPHERS
/settings/NRPE/client/targets/default certificate SSL CERTIFICATE
/settings/NRPE/client/targets/default insecure Insecure legacy mode
/settings/NRPE/client/targets/default payload length PAYLOAD LENGTH
/settings/NRPE/client/targets/default retries RETRIES
/settings/NRPE/client/targets/default timeout TIMEOUT
/settings/NRPE/client/targets/default use ssl ENABLE SSL ENCRYPTION
/settings/NRPE/client/targets/default verify mode VERIFY MODE

Advanced keys:

Path / Section Key Default Value Description
/settings/NRPE/client/targets/default ca CA  
/settings/NRPE/client/targets/default certificate format CERTIFICATE FORMAT  
/settings/NRPE/client/targets/default certificate key SSL CERTIFICATE  
/settings/NRPE/client/targets/default dh DH KEY  
/settings/NRPE/client/targets/default host TARGET HOST  
/settings/NRPE/client/targets/default port TARGET PORT  

Sample keys:

Path / Section Key Default Value Description
/settings/NRPE/client/targets/sample address TARGET ADDRESS  
/settings/NRPE/client/targets/sample allowed ciphers ALLOWED CIPHERS  
/settings/NRPE/client/targets/sample ca CA  
/settings/NRPE/client/targets/sample certificate SSL CERTIFICATE  
/settings/NRPE/client/targets/sample certificate format CERTIFICATE FORMAT  
/settings/NRPE/client/targets/sample certificate key SSL CERTIFICATE  
/settings/NRPE/client/targets/sample dh DH KEY  
/settings/NRPE/client/targets/sample host TARGET HOST  
/settings/NRPE/client/targets/sample insecure Insecure legacy mode  
/settings/NRPE/client/targets/sample payload length PAYLOAD LENGTH  
/settings/NRPE/client/targets/sample port TARGET PORT  
/settings/NRPE/client/targets/sample retries RETRIES  
/settings/NRPE/client/targets/sample timeout TIMEOUT  
/settings/NRPE/client/targets/sample use ssl ENABLE SSL ENCRYPTION  
/settings/NRPE/client/targets/sample verify mode VERIFY MODE  

Queries

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

check_nrpe

NRPEClientcheck_nrpe
Request remote information via NRPE.

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    
argument   Set command line arguments    
separator   Separator to use for the batch command (default is )  
batch   Add multiple records using the separator format is: command argument argument
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    
ssl 1 Initial an ssl handshake with the server.    
insecure N/A Use insecure legacy mode    
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.    

Arguments

help (NRPEClient, check_nrpe)
Show help screen (this screen)
help-pb (NRPEClient, check_nrpe)
Show help screen as a protocol buffer payload
show-default (NRPEClient, check_nrpe)
Show default values for a given command
help-short (NRPEClient, check_nrpe)
Show help screen (short format).
host (NRPEClient, check_nrpe)
The host of the host running the server
port (NRPEClient, check_nrpe)
The port of the host running the server
address (NRPEClient, check_nrpe)
The address (host:port) of the host running the server
timeout (NRPEClient, check_nrpe)
Number of seconds before connection times out (default=10)
target (NRPEClient, check_nrpe)
Target to use (lookup connection info from config)
retry (NRPEClient, check_nrpe)
Number of times ti retry a failed connection attempt (default=2)
retries (NRPEClient, check_nrpe)
legacy version of retry
source-host (NRPEClient, check_nrpe)
Source/sender host name (default is auto which means use the name of the actual host)
sender-host (NRPEClient, check_nrpe)
Source/sender host name (default is auto which means use the name of the actual host)
command (NRPEClient, check_nrpe)
The name of the command that the remote daemon should run
argument (NRPEClient, check_nrpe)
Set command line arguments
separator (NRPEClient, check_nrpe)
Separator to use for the batch command (default is |)
batch (NRPEClient, check_nrpe)
Add multiple records using the separator format is: command|argument|argument
certificate (NRPEClient, check_nrpe)
Length of payload (has to be same as on the server)
dh (NRPEClient, check_nrpe)
Length of payload (has to be same as on the server)
certificate-key (NRPEClient, check_nrpe)
Client certificate to use
certificate-format (NRPEClient, check_nrpe)
Client certificate format
ca (NRPEClient, check_nrpe)
Certificate authority
verify (NRPEClient, check_nrpe)
Client certificate format
allowed-ciphers (NRPEClient, check_nrpe)
Client certificate format
ssl (NRPEClient, check_nrpe)
Initial an ssl handshake with the server.
insecure (NRPEClient, check_nrpe)
Use insecure legacy mode
payload-length (NRPEClient, check_nrpe)
Length of payload (has to be same as on the server)
buffer-length (NRPEClient, check_nrpe)
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.

exec_nrpe

NRPEClientexec_nrpe
Execute remote script via NRPE. (Most likely you want nrpe_query).

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    
argument   Set command line arguments    
separator   Separator to use for the batch command (default is )  
batch   Add multiple records using the separator format is: command argument argument
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    
ssl 1 Initial an ssl handshake with the server.    
insecure N/A Use insecure legacy mode    
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.    

Arguments

help (NRPEClient, exec_nrpe)
Show help screen (this screen)
help-pb (NRPEClient, exec_nrpe)
Show help screen as a protocol buffer payload
show-default (NRPEClient, exec_nrpe)
Show default values for a given command
help-short (NRPEClient, exec_nrpe)
Show help screen (short format).
host (NRPEClient, exec_nrpe)
The host of the host running the server
port (NRPEClient, exec_nrpe)
The port of the host running the server
address (NRPEClient, exec_nrpe)
The address (host:port) of the host running the server
timeout (NRPEClient, exec_nrpe)
Number of seconds before connection times out (default=10)
target (NRPEClient, exec_nrpe)
Target to use (lookup connection info from config)
retry (NRPEClient, exec_nrpe)
Number of times ti retry a failed connection attempt (default=2)
retries (NRPEClient, exec_nrpe)
legacy version of retry
source-host (NRPEClient, exec_nrpe)
Source/sender host name (default is auto which means use the name of the actual host)
sender-host (NRPEClient, exec_nrpe)
Source/sender host name (default is auto which means use the name of the actual host)
command (NRPEClient, exec_nrpe)
The name of the command that the remote daemon should run
argument (NRPEClient, exec_nrpe)
Set command line arguments
separator (NRPEClient, exec_nrpe)
Separator to use for the batch command (default is |)
batch (NRPEClient, exec_nrpe)
Add multiple records using the separator format is: command|argument|argument
certificate (NRPEClient, exec_nrpe)
Length of payload (has to be same as on the server)
dh (NRPEClient, exec_nrpe)
Length of payload (has to be same as on the server)
certificate-key (NRPEClient, exec_nrpe)
Client certificate to use
certificate-format (NRPEClient, exec_nrpe)
Client certificate format
ca (NRPEClient, exec_nrpe)
Certificate authority
verify (NRPEClient, exec_nrpe)
Client certificate format
allowed-ciphers (NRPEClient, exec_nrpe)
Client certificate format
ssl (NRPEClient, exec_nrpe)
Initial an ssl handshake with the server.
insecure (NRPEClient, exec_nrpe)
Use insecure legacy mode
payload-length (NRPEClient, exec_nrpe)
Length of payload (has to be same as on the server)
buffer-length (NRPEClient, exec_nrpe)
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.

nrpe_forward

NRPEClientnrpe_forward
Forward the request as-is to remote host via NRPE.

Usage:

Option Default Value Description
*    

Arguments

* (NRPEClient, nrpe_forward)

nrpe_query

NRPEClientnrpe_query
Request remote information via NRPE.

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    
argument   Set command line arguments    
separator   Separator to use for the batch command (default is )  
batch   Add multiple records using the separator format is: command argument argument
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    
ssl 1 Initial an ssl handshake with the server.    
insecure N/A Use insecure legacy mode    
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.    

Arguments

help (NRPEClient, nrpe_query)
Show help screen (this screen)
help-pb (NRPEClient, nrpe_query)
Show help screen as a protocol buffer payload
show-default (NRPEClient, nrpe_query)
Show default values for a given command
help-short (NRPEClient, nrpe_query)
Show help screen (short format).
host (NRPEClient, nrpe_query)
The host of the host running the server
port (NRPEClient, nrpe_query)
The port of the host running the server
address (NRPEClient, nrpe_query)
The address (host:port) of the host running the server
timeout (NRPEClient, nrpe_query)
Number of seconds before connection times out (default=10)
target (NRPEClient, nrpe_query)
Target to use (lookup connection info from config)
retry (NRPEClient, nrpe_query)
Number of times ti retry a failed connection attempt (default=2)
retries (NRPEClient, nrpe_query)
legacy version of retry
source-host (NRPEClient, nrpe_query)
Source/sender host name (default is auto which means use the name of the actual host)
sender-host (NRPEClient, nrpe_query)
Source/sender host name (default is auto which means use the name of the actual host)
command (NRPEClient, nrpe_query)
The name of the command that the remote daemon should run
argument (NRPEClient, nrpe_query)
Set command line arguments
separator (NRPEClient, nrpe_query)
Separator to use for the batch command (default is |)
batch (NRPEClient, nrpe_query)
Add multiple records using the separator format is: command|argument|argument
certificate (NRPEClient, nrpe_query)
Length of payload (has to be same as on the server)
dh (NRPEClient, nrpe_query)
Length of payload (has to be same as on the server)
certificate-key (NRPEClient, nrpe_query)
Client certificate to use
certificate-format (NRPEClient, nrpe_query)
Client certificate format
ca (NRPEClient, nrpe_query)
Certificate authority
verify (NRPEClient, nrpe_query)
Client certificate format
allowed-ciphers (NRPEClient, nrpe_query)
Client certificate format
ssl (NRPEClient, nrpe_query)
Initial an ssl handshake with the server.
insecure (NRPEClient, nrpe_query)
Use insecure legacy mode
payload-length (NRPEClient, nrpe_query)
Length of payload (has to be same as on the server)
buffer-length (NRPEClient, nrpe_query)
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.

submit_nrpe

NRPEClientsubmit_nrpe
Submit information to remote host via NRPE. (Most likely you want nrpe_query).

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 result message
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    
ssl 1 Initial an ssl handshake with the server.    
insecure N/A Use insecure legacy mode    
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.    

Arguments

help (NRPEClient, submit_nrpe)
Show help screen (this screen)
help-pb (NRPEClient, submit_nrpe)
Show help screen as a protocol buffer payload
show-default (NRPEClient, submit_nrpe)
Show default values for a given command
help-short (NRPEClient, submit_nrpe)
Show help screen (short format).
host (NRPEClient, submit_nrpe)
The host of the host running the server
port (NRPEClient, submit_nrpe)
The port of the host running the server
address (NRPEClient, submit_nrpe)
The address (host:port) of the host running the server
timeout (NRPEClient, submit_nrpe)
Number of seconds before connection times out (default=10)
target (NRPEClient, submit_nrpe)
Target to use (lookup connection info from config)
retry (NRPEClient, submit_nrpe)
Number of times ti retry a failed connection attempt (default=2)
retries (NRPEClient, submit_nrpe)
legacy version of retry
source-host (NRPEClient, submit_nrpe)
Source/sender host name (default is auto which means use the name of the actual host)
sender-host (NRPEClient, submit_nrpe)
Source/sender host name (default is auto which means use the name of the actual host)
command (NRPEClient, submit_nrpe)
The name of the command that the remote daemon should run
alias (NRPEClient, submit_nrpe)
Same as command
message (NRPEClient, submit_nrpe)
Message
result (NRPEClient, submit_nrpe)
Result code either a number or OK, WARN, CRIT, UNKNOWN
separator (NRPEClient, submit_nrpe)
Separator to use for the batch command (default is |)
batch (NRPEClient, submit_nrpe)
Add multiple records using the separator format is: command|result|message
certificate (NRPEClient, submit_nrpe)
Length of payload (has to be same as on the server)
dh (NRPEClient, submit_nrpe)
Length of payload (has to be same as on the server)
certificate-key (NRPEClient, submit_nrpe)
Client certificate to use
certificate-format (NRPEClient, submit_nrpe)
Client certificate format
ca (NRPEClient, submit_nrpe)
Certificate authority
verify (NRPEClient, submit_nrpe)
Client certificate format
allowed-ciphers (NRPEClient, submit_nrpe)
Client certificate format
ssl (NRPEClient, submit_nrpe)
Initial an ssl handshake with the server.
insecure (NRPEClient, submit_nrpe)
Use insecure legacy mode
payload-length (NRPEClient, submit_nrpe)
Length of payload (has to be same as on the server)
buffer-length (NRPEClient, submit_nrpe)
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/ NRPE/ client

/settings/NRPE/client (NRPEClient)

NRPE CLIENT SECTION

Section for NRPE active/passive check module.
Key Default Value Description
channel NRPE CHANNEL

Sample:

# NRPE CLIENT SECTION
# Section for NRPE active/passive check module.
[/settings/NRPE/client]
channel=NRPE
channel (NRPEClient, /settings/NRPE/client)

CHANNEL

The channel to listen to.

Path: /settings/NRPE/client

Key: channel

Default value: NRPE

Used by: NRPEClient

Sample:

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

… / handlers

/settings/NRPE/client/handlers (NRPEClient)

CLIENT HANDLER SECTION

Sample:

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

… / targets

/settings/NRPE/client/targets (NRPEClient)

REMOTE TARGET DEFINITIONS

Sample:

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

… / targets / default

/settings/NRPE/client/targets/default (NRPEClient)

TARGET

Target definition for: default
Key Default Value Description
address   TARGET ADDRESS
allowed ciphers   ALLOWED CIPHERS
ca   CA
certificate   SSL CERTIFICATE
certificate format   CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh   DH KEY
host   TARGET HOST
insecure   Insecure legacy mode
payload length 0 PAYLOAD LENGTH
port   TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT
use ssl 0 ENABLE SSL ENCRYPTION
verify mode   VERIFY MODE

Sample:

# TARGET
# Target definition for: default
[/settings/NRPE/client/targets/default]
address=
allowed ciphers=
ca=
certificate=
certificate format=
certificate key=
dh=
host=
insecure=
payload length=0
port=
retries=3
timeout=30
use ssl=0
verify mode=
address (NRPEClient, /settings/NRPE/client/targets/default)

TARGET ADDRESS

Target host address

Path: /settings/NRPE/client/targets/default

Key: address

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# TARGET ADDRESS
address=
allowed ciphers (NRPEClient, /settings/NRPE/client/targets/default)

ALLOWED CIPHERS

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

Path: /settings/NRPE/client/targets/default

Key: allowed ciphers

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# ALLOWED CIPHERS
allowed ciphers=
ca (NRPEClient, /settings/NRPE/client/targets/default)

CA

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/default

Key: ca

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# CA
ca=
certificate (NRPEClient, /settings/NRPE/client/targets/default)

SSL CERTIFICATE

Path: /settings/NRPE/client/targets/default

Key: certificate

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# SSL CERTIFICATE
certificate=
certificate format (NRPEClient, /settings/NRPE/client/targets/default)

CERTIFICATE FORMAT

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/default

Key: certificate format

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# CERTIFICATE FORMAT
certificate format=
certificate key (NRPEClient, /settings/NRPE/client/targets/default)

SSL CERTIFICATE

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/default

Key: certificate key

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# SSL CERTIFICATE
certificate key=
dh (NRPEClient, /settings/NRPE/client/targets/default)

DH KEY

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/default

Key: dh

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# DH KEY
dh=
host (NRPEClient, /settings/NRPE/client/targets/default)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/default

Key: host

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# TARGET HOST
host=
insecure (NRPEClient, /settings/NRPE/client/targets/default)

Insecure legacy mode

Use insecure legacy mode to connect to old NRPE server

Path: /settings/NRPE/client/targets/default

Key: insecure

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# Insecure legacy mode
insecure=
payload length (NRPEClient, /settings/NRPE/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.

Path: /settings/NRPE/client/targets/default

Key: payload length

Default value: 0

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# PAYLOAD LENGTH
payload length=0
port (NRPEClient, /settings/NRPE/client/targets/default)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/default

Key: port

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# TARGET PORT
port=
retries (NRPEClient, /settings/NRPE/client/targets/default)

RETRIES

Number of times to retry sending.

Path: /settings/NRPE/client/targets/default

Key: retries

Default value: 3

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# RETRIES
retries=3
timeout (NRPEClient, /settings/NRPE/client/targets/default)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/NRPE/client/targets/default

Key: timeout

Default value: 30

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# TIMEOUT
timeout=30
use ssl (NRPEClient, /settings/NRPE/client/targets/default)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/NRPE/client/targets/default

Key: use ssl

Default value: 0

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# ENABLE SSL ENCRYPTION
use ssl=0
verify mode (NRPEClient, /settings/NRPE/client/targets/default)

VERIFY MODE

Path: /settings/NRPE/client/targets/default

Key: verify mode

Default value:

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/default]
# VERIFY MODE
verify mode=

… / targets / sample

/settings/NRPE/client/targets/sample (NRPEClient)

TARGET

Target definition for: sample
Key Default Value Description
address   TARGET ADDRESS
allowed ciphers   ALLOWED CIPHERS
ca   CA
certificate   SSL CERTIFICATE
certificate format   CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh   DH KEY
host   TARGET HOST
insecure   Insecure legacy mode
payload length 0 PAYLOAD LENGTH
port   TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT
use ssl 0 ENABLE SSL ENCRYPTION
verify mode   VERIFY MODE

Sample:

# TARGET
# Target definition for: sample
[/settings/NRPE/client/targets/sample]
address=
allowed ciphers=
ca=
certificate=
certificate format=
certificate key=
dh=
host=
insecure=
payload length=0
port=
retries=3
timeout=30
use ssl=0
verify mode=
address (NRPEClient, /settings/NRPE/client/targets/sample)

TARGET ADDRESS

Target host address

Path: /settings/NRPE/client/targets/sample

Key: address

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# TARGET ADDRESS
address=
allowed ciphers (NRPEClient, /settings/NRPE/client/targets/sample)

ALLOWED CIPHERS

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

Path: /settings/NRPE/client/targets/sample

Key: allowed ciphers

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# ALLOWED CIPHERS
allowed ciphers=
ca (NRPEClient, /settings/NRPE/client/targets/sample)

CA

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/sample

Key: ca

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# CA
ca=
certificate (NRPEClient, /settings/NRPE/client/targets/sample)

SSL CERTIFICATE

Path: /settings/NRPE/client/targets/sample

Key: certificate

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# SSL CERTIFICATE
certificate=
certificate format (NRPEClient, /settings/NRPE/client/targets/sample)

CERTIFICATE FORMAT

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/sample

Key: certificate format

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# CERTIFICATE FORMAT
certificate format=
certificate key (NRPEClient, /settings/NRPE/client/targets/sample)

SSL CERTIFICATE

Advanced (means it is not commonly used)

Path: /settings/NRPE/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: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# SSL CERTIFICATE
certificate key=
dh (NRPEClient, /settings/NRPE/client/targets/sample)

DH KEY

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/sample

Key: dh

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# DH KEY
dh=
host (NRPEClient, /settings/NRPE/client/targets/sample)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/sample

Key: host

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# TARGET HOST
host=
insecure (NRPEClient, /settings/NRPE/client/targets/sample)

Insecure legacy mode

Use insecure legacy mode to connect to old NRPE server

Path: /settings/NRPE/client/targets/sample

Key: insecure

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# Insecure legacy mode
insecure=
payload length (NRPEClient, /settings/NRPE/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.

Path: /settings/NRPE/client/targets/sample

Key: payload length

Default value: 0

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# PAYLOAD LENGTH
payload length=0
port (NRPEClient, /settings/NRPE/client/targets/sample)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/NRPE/client/targets/sample

Key: port

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# TARGET PORT
port=
retries (NRPEClient, /settings/NRPE/client/targets/sample)

RETRIES

Number of times to retry sending.

Path: /settings/NRPE/client/targets/sample

Key: retries

Default value: 3

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# RETRIES
retries=3
timeout (NRPEClient, /settings/NRPE/client/targets/sample)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/NRPE/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: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# TIMEOUT
timeout=30
use ssl (NRPEClient, /settings/NRPE/client/targets/sample)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/NRPE/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: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# ENABLE SSL ENCRYPTION
use ssl=0
verify mode (NRPEClient, /settings/NRPE/client/targets/sample)

VERIFY MODE

Path: /settings/NRPE/client/targets/sample

Key: verify mode

Default value:

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

Used by: NRPEClient

Sample:

[/settings/NRPE/client/targets/sample]
# VERIFY MODE
verify mode=
comments powered by Disqus