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
List of commands#
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). |
List of Configuration#
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 | 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 | 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#
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 | |
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. |
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
argument#
Description: Set command line arguments
separator#
Description: Separator to use for the batch command (default is |)
batch#
Description: Add multiple records using the separator format is: command|argument|argument
certificate#
Description: Length of payload (has to be same as on the server)
dh#
Description: Length of payload (has to be same as on the server)
certificate-key#
Description: Client certificate to use
certificate-format#
Description: Client certificate format
ca#
Description: Certificate authority
verify#
Description: Client certificate format
allowed-ciphers#
Description: Client certificate format
ssl#
Deafult Value: 1
Description: Initial an ssl handshake with the server.
insecure#
Description: Use insecure legacy mode
payload-length#
Description: Length of payload (has to be same as on the server)
buffer-length#
Description: 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#
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 | |
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. |
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
argument#
Description: Set command line arguments
separator#
Description: Separator to use for the batch command (default is |)
batch#
Description: Add multiple records using the separator format is: command|argument|argument
certificate#
Description: Length of payload (has to be same as on the server)
dh#
Description: Length of payload (has to be same as on the server)
certificate-key#
Description: Client certificate to use
certificate-format#
Description: Client certificate format
ca#
Description: Certificate authority
verify#
Description: Client certificate format
allowed-ciphers#
Description: Client certificate format
ssl#
Deafult Value: 1
Description: Initial an ssl handshake with the server.
insecure#
Description: Use insecure legacy mode
payload-length#
Description: Length of payload (has to be same as on the server)
buffer-length#
Description: 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#
Forward the request as-is to remote host via NRPE.
Usage#
Option | Default Value | Description |
---|---|---|
* |
*#
Description:
nrpe_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 | |
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. |
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
argument#
Description: Set command line arguments
separator#
Description: Separator to use for the batch command (default is |)
batch#
Description: Add multiple records using the separator format is: command|argument|argument
certificate#
Description: Length of payload (has to be same as on the server)
dh#
Description: Length of payload (has to be same as on the server)
certificate-key#
Description: Client certificate to use
certificate-format#
Description: Client certificate format
ca#
Description: Certificate authority
verify#
Description: Client certificate format
allowed-ciphers#
Description: Client certificate format
ssl#
Deafult Value: 1
Description: Initial an ssl handshake with the server.
insecure#
Description: Use insecure legacy mode
payload-length#
Description: Length of payload (has to be same as on the server)
buffer-length#
Description: 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#
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 | |
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. |
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
certificate#
Description: Length of payload (has to be same as on the server)
dh#
Description: Length of payload (has to be same as on the server)
certificate-key#
Description: Client certificate to use
certificate-format#
Description: Client certificate format
ca#
Description: Certificate authority
verify#
Description: Client certificate format
allowed-ciphers#
Description: Client certificate format
ssl#
Deafult Value: 1
Description: Initial an ssl handshake with the server.
insecure#
Description: Use insecure legacy mode
payload-length#
Description: Length of payload (has to be same as on the server)
buffer-length#
Description: 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.
Configuration#
NRPE CLIENT SECTION#
Section for NRPE active/passive check module.
# Section for NRPE active/passive check module. [/settings/NRPE/client] channel=NRPE
Key | Default Value | Description |
---|---|---|
channel | NRPE | CHANNEL |
channel#
CHANNEL
The channel to listen to.
Key | Description |
---|---|
Path: | /settings/NRPE/client |
Key: | channel |
Default value: | NRPE |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client] # CHANNEL channel=NRPE
CLIENT HANDLER SECTION#
# [/settings/NRPE/client/handlers]
REMOTE TARGET DEFINITIONS#
# [/settings/NRPE/client/targets]
TARGET#
Target definition for: default
# Target definition for: default [/settings/NRPE/client/targets/default] retries=3 timeout=30
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 | PAYLOAD LENGTH | |
port | TARGET PORT | |
retries | 3 | RETRIES |
timeout | 30 | TIMEOUT |
use ssl | ENABLE SSL ENCRYPTION | |
verify mode | VERIFY MODE |
address#
TARGET ADDRESS
Target host address
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | address |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # TARGET ADDRESS address=
allowed ciphers#
ALLOWED CIPHERS
A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | allowed ciphers |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # ALLOWED CIPHERS allowed ciphers=
ca#
CA
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | ca |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # CA ca=
certificate#
SSL CERTIFICATE
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | certificate |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # SSL CERTIFICATE certificate=
certificate format#
CERTIFICATE FORMAT
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | certificate format |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # CERTIFICATE FORMAT certificate format=
certificate key#
SSL CERTIFICATE
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | certificate key |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # SSL CERTIFICATE certificate key=
dh#
DH KEY
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | dh |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # DH KEY dh=
host#
TARGET HOST
The target server to report results to.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | host |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # TARGET HOST host=
insecure#
Insecure legacy mode
Use insecure legacy mode to connect to old NRPE server
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | insecure |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # Insecure legacy mode insecure=
payload length#
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.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | payload length |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # PAYLOAD LENGTH payload length=
port#
TARGET PORT
The target server port
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | port |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # TARGET PORT port=
retries#
RETRIES
Number of times to retry sending.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | retries |
Default value: | 3 |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # RETRIES retries=3
timeout#
TIMEOUT
Timeout when reading/writing packets to/from sockets.
Key | Description |
---|---|
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#
ENABLE SSL ENCRYPTION
This option controls if SSL should be enabled.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | use ssl |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # ENABLE SSL ENCRYPTION use ssl=
verify mode#
VERIFY MODE
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/default |
Key: | verify mode |
Default value: | N/A |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/default] # VERIFY MODE verify mode=
TARGET#
Target definition for: sample
# Target definition for: sample [/settings/NRPE/client/targets/sample] retries=3 timeout=30
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 | PAYLOAD LENGTH | |
port | TARGET PORT | |
retries | 3 | RETRIES |
timeout | 30 | TIMEOUT |
use ssl | ENABLE SSL ENCRYPTION | |
verify mode | VERIFY MODE |
address#
TARGET ADDRESS
Target host address
Key | Description |
---|---|
Path: | /settings/NRPE/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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # TARGET ADDRESS address=
allowed ciphers#
ALLOWED CIPHERS
A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | allowed ciphers |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # ALLOWED CIPHERS allowed ciphers=
ca#
CA
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | ca |
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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # CA ca=
certificate#
SSL CERTIFICATE
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | certificate |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # SSL CERTIFICATE certificate=
certificate format#
CERTIFICATE FORMAT
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | certificate format |
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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # CERTIFICATE FORMAT certificate format=
certificate key#
SSL CERTIFICATE
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | certificate key |
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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # SSL CERTIFICATE certificate key=
dh#
DH KEY
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | dh |
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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # DH KEY dh=
host#
TARGET HOST
The target server to report results to.
Key | Description |
---|---|
Path: | /settings/NRPE/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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # TARGET HOST host=
insecure#
Insecure legacy mode
Use insecure legacy mode to connect to old NRPE server
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | insecure |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # Insecure legacy mode insecure=
payload length#
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.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | payload length |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # PAYLOAD LENGTH payload length=
port#
TARGET PORT
The target server port
Key | Description |
---|---|
Path: | /settings/NRPE/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: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # TARGET PORT port=
retries#
RETRIES
Number of times to retry sending.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | retries |
Default value: | 3 |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # RETRIES retries=3
timeout#
TIMEOUT
Timeout when reading/writing packets to/from sockets.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | timeout |
Default value: | 30 |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # TIMEOUT timeout=30
use ssl#
ENABLE SSL ENCRYPTION
This option controls if SSL should be enabled.
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | use ssl |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # ENABLE SSL ENCRYPTION use ssl=
verify mode#
VERIFY MODE
Key | Description |
---|---|
Path: | /settings/NRPE/client/targets/sample |
Key: | verify mode |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | NRPEClient |
Sample#
[/settings/NRPE/client/targets/sample] # VERIFY MODE verify mode=