NRPEClient
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 |
---|---|
nrpe_exec |
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. |
nrpe_submit |
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 |
certificate |
SSL CERTIFICATE |
/settings/NRPE/client/targets/default |
certificate key |
SSL CERTIFICATE KEY |
/settings/NRPE/client/targets/default |
insecure |
Insecure legacy mode |
/settings/NRPE/client/targets/default |
payload length |
PAYLOAD LENGTH |
/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 |
alias |
ALIAS | |
/settings/NRPE/client/targets/default |
allowed ciphers |
ALLOWED CIPHERS | |
/settings/NRPE/client/targets/default |
ca |
CA | |
/settings/NRPE/client/targets/default |
certificate format |
CERTIFICATE FORMAT | |
/settings/NRPE/client/targets/default |
dh |
DH KEY | |
/settings/NRPE/client/targets/default |
host |
TARGET HOST | |
/settings/NRPE/client/targets/default |
is template |
IS TEMPLATE | |
/settings/NRPE/client/targets/default |
parent |
PARENT | |
/settings/NRPE/client/targets/default |
port |
TARGET PORT |
Sample keys:
A quick reference for all available queries (check commands) in the NRPEClient module.
nrpe_exec
¶NRPEClient
nrpe_exec
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 | |
arguments |
list of arguments | |
no-ssl |
N/A | Do not initial an ssl handshake with the server, talk in plain-text. |
certificate |
Length of payload (has to be same as on the server) | |
dh |
The pre-generated DH key (if ADH is used this will be your ‘key’ though it is not a secret key) | |
certificate-key |
Client certificate to use | |
certificate-format |
Client certificate format (default is PEM) | |
insecure |
N/A | Use insecure legacy mode |
ca |
A file representing the Certificate authority used to validate peer certificates | |
verify |
Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ... | |
allowed-ciphers |
Which ciphers are allowed for legacy reasons this defaults to ADH which is not secure preferably set this to DEFAULT which is better or a an even stronger cipher | |
payload-length |
Length of payload (has to be same as on the server) | |
buffer-length |
Same as payload-length (used for legacy reasons) | |
ssl |
N/A | Initial an ssl handshake with the server. |
help
(NRPEClient, nrpe_exec)¶help-pb
(NRPEClient, nrpe_exec)¶show-default
(NRPEClient, nrpe_exec)¶help-short
(NRPEClient, nrpe_exec)¶host
(NRPEClient, nrpe_exec)¶port
(NRPEClient, nrpe_exec)¶address
(NRPEClient, nrpe_exec)¶timeout
(NRPEClient, nrpe_exec)¶target
(NRPEClient, nrpe_exec)¶retry
(NRPEClient, nrpe_exec)¶command
(NRPEClient, nrpe_exec)¶arguments
(NRPEClient, nrpe_exec)¶no-ssl
(NRPEClient, nrpe_exec)¶certificate
(NRPEClient, nrpe_exec)¶dh
(NRPEClient, nrpe_exec)¶certificate-key
(NRPEClient, nrpe_exec)¶certificate-format
(NRPEClient, nrpe_exec)¶insecure
(NRPEClient, nrpe_exec)¶ca
(NRPEClient, nrpe_exec)¶verify
(NRPEClient, nrpe_exec)¶allowed-ciphers
(NRPEClient, nrpe_exec)¶payload-length
(NRPEClient, nrpe_exec)¶buffer-length
(NRPEClient, nrpe_exec)¶ssl
(NRPEClient, nrpe_exec)¶nrpe_forward
¶NRPEClient
nrpe_forward
Usage:
nrpe_query
¶NRPEClient
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) | |
command |
The name of the query that the remote daemon should run | |
arguments |
list of arguments | |
query-command |
The name of the query that the remote daemon should run | |
query-arguments |
list of arguments | |
no-ssl |
N/A | Do not initial an ssl handshake with the server, talk in plain-text. |
certificate |
Length of payload (has to be same as on the server) | |
dh |
The pre-generated DH key (if ADH is used this will be your ‘key’ though it is not a secret key) | |
certificate-key |
Client certificate to use | |
certificate-format |
Client certificate format (default is PEM) | |
insecure |
N/A | Use insecure legacy mode |
ca |
A file representing the Certificate authority used to validate peer certificates | |
verify |
Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ... | |
allowed-ciphers |
Which ciphers are allowed for legacy reasons this defaults to ADH which is not secure preferably set this to DEFAULT which is better or a an even stronger cipher | |
payload-length |
Length of payload (has to be same as on the server) | |
buffer-length |
Same as payload-length (used for legacy reasons) | |
ssl |
N/A | Initial an ssl handshake with the server. |
help
(NRPEClient, nrpe_query)¶help-pb
(NRPEClient, nrpe_query)¶show-default
(NRPEClient, nrpe_query)¶help-short
(NRPEClient, nrpe_query)¶host
(NRPEClient, nrpe_query)¶port
(NRPEClient, nrpe_query)¶address
(NRPEClient, nrpe_query)¶timeout
(NRPEClient, nrpe_query)¶target
(NRPEClient, nrpe_query)¶retry
(NRPEClient, nrpe_query)¶command
(NRPEClient, nrpe_query)¶arguments
(NRPEClient, nrpe_query)¶query-command
(NRPEClient, nrpe_query)¶query-arguments
(NRPEClient, nrpe_query)¶no-ssl
(NRPEClient, nrpe_query)¶certificate
(NRPEClient, nrpe_query)¶dh
(NRPEClient, nrpe_query)¶certificate-key
(NRPEClient, nrpe_query)¶certificate-format
(NRPEClient, nrpe_query)¶insecure
(NRPEClient, nrpe_query)¶ca
(NRPEClient, nrpe_query)¶verify
(NRPEClient, nrpe_query)¶allowed-ciphers
(NRPEClient, nrpe_query)¶payload-length
(NRPEClient, nrpe_query)¶buffer-length
(NRPEClient, nrpe_query)¶ssl
(NRPEClient, nrpe_query)¶nrpe_submit
¶NRPEClient
nrpe_submit
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 | |
no-ssl |
N/A | Do not initial an ssl handshake with the server, talk in plain-text. |
certificate |
Length of payload (has to be same as on the server) | |
dh |
The pre-generated DH key (if ADH is used this will be your ‘key’ though it is not a secret key) | |
certificate-key |
Client certificate to use | |
certificate-format |
Client certificate format (default is PEM) | |
insecure |
N/A | Use insecure legacy mode |
ca |
A file representing the Certificate authority used to validate peer certificates | |
verify |
Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ... | |
allowed-ciphers |
Which ciphers are allowed for legacy reasons this defaults to ADH which is not secure preferably set this to DEFAULT which is better or a an even stronger cipher | |
payload-length |
Length of payload (has to be same as on the server) | |
buffer-length |
Same as payload-length (used for legacy reasons) | |
ssl |
N/A | Initial an ssl handshake with the server. |
help
(NRPEClient, nrpe_submit)¶help-pb
(NRPEClient, nrpe_submit)¶show-default
(NRPEClient, nrpe_submit)¶help-short
(NRPEClient, nrpe_submit)¶host
(NRPEClient, nrpe_submit)¶port
(NRPEClient, nrpe_submit)¶address
(NRPEClient, nrpe_submit)¶timeout
(NRPEClient, nrpe_submit)¶target
(NRPEClient, nrpe_submit)¶retry
(NRPEClient, nrpe_submit)¶command
(NRPEClient, nrpe_submit)¶alias
(NRPEClient, nrpe_submit)¶message
(NRPEClient, nrpe_submit)¶result
(NRPEClient, nrpe_submit)¶no-ssl
(NRPEClient, nrpe_submit)¶certificate
(NRPEClient, nrpe_submit)¶dh
(NRPEClient, nrpe_submit)¶certificate-key
(NRPEClient, nrpe_submit)¶certificate-format
(NRPEClient, nrpe_submit)¶insecure
(NRPEClient, nrpe_submit)¶ca
(NRPEClient, nrpe_submit)¶verify
(NRPEClient, nrpe_submit)¶allowed-ciphers
(NRPEClient, nrpe_submit)¶payload-length
(NRPEClient, nrpe_submit)¶buffer-length
(NRPEClient, nrpe_submit)¶ssl
(NRPEClient, nrpe_submit)¶/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
/settings/NRPE/client/handlers
(NRPEClient)¶CLIENT HANDLER SECTION
Sample:
# CLIENT HANDLER SECTION # [/settings/NRPE/client/handlers]
/settings/NRPE/client/targets
(NRPEClient)¶REMOTE TARGET DEFINITIONS
Sample:
# REMOTE TARGET DEFINITIONS # [/settings/NRPE/client/targets]
/settings/NRPE/client/targets/default
(NRPEClient)¶TARGET DEFENITION
Target definition for: default
Key Default Value Description address
TARGET ADDRESS alias
ALIAS allowed ciphers
ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH ALLOWED CIPHERS ca
CA certificate
SSL CERTIFICATE certificate format
PEM CERTIFICATE FORMAT certificate key
SSL CERTIFICATE KEY dh
DH KEY host
TARGET HOST insecure
Insecure legacy mode is template
0 IS TEMPLATE parent
default PARENT payload length
1024 PAYLOAD LENGTH port
0 TARGET PORT timeout
30 TIMEOUT use ssl
1 ENABLE SSL ENCRYPTION verify mode
none VERIFY MODE Sample:
# TARGET DEFENITION # Target definition for: default [/settings/NRPE/client/targets/default] address= alias= allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH ca= certificate= certificate format=PEM certificate key= dh= host= insecure= is template=0 parent=default payload length=1024 port=0 timeout=30 use ssl=1 verify mode=none
address
(NRPEClient, /settings/NRPE/client/targets/default)¶TARGET ADDRESS
Target host addressPath: /settings/NRPE/client/targets/default
Key: address
Default value:
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # TARGET ADDRESS address=
alias
(NRPEClient, /settings/NRPE/client/targets/default)¶ALIAS
The alias (service name) to report to serverAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/default
Key: alias
Default value:
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # ALIAS alias=
allowed ciphers
(NRPEClient, /settings/NRPE/client/targets/default)¶ALLOWED CIPHERS
The allowed list of ciphers (setting insecure wil override this to only support ADHAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/default
Key: allowed ciphers
Default value: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # ALLOWED CIPHERS allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
ca
(NRPEClient, /settings/NRPE/client/targets/default)¶CA
The certificate authority to use to authenticate remote certificateAdvanced (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
The ssl certificate to use to encrypt the communicationPath: /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
Format of SSL certificateAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/default
Key: certificate format
Default value: PEM
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # CERTIFICATE FORMAT certificate format=PEM
certificate key
(NRPEClient, /settings/NRPE/client/targets/default)¶SSL CERTIFICATE KEY
Key for the SSL certificatePath: /settings/NRPE/client/targets/default
Key: certificate key
Default value:
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # SSL CERTIFICATE KEY certificate key=
dh
(NRPEClient, /settings/NRPE/client/targets/default)¶DH KEY
The diffi-hellman perfect forwarded secret to use setting –insecure will override thisAdvanced (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 serverPath: /settings/NRPE/client/targets/default
Key: insecure
Default value:
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # Insecure legacy mode insecure=
is template
(NRPEClient, /settings/NRPE/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/NRPE/client/targets/default
Key: is template
Default value: 0
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # IS TEMPLATE is template=0
parent
(NRPEClient, /settings/NRPE/client/targets/default)¶PARENT
The parent the target inherits fromAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/default
Key: parent
Default value: default
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # PARENT parent=default
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: 1024
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # PAYLOAD LENGTH payload length=1024
port
(NRPEClient, /settings/NRPE/client/targets/default)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/default
Key: port
Default value: 0
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # TARGET PORT port=0
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: 1
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # ENABLE SSL ENCRYPTION use ssl=1
verify mode
(NRPEClient, /settings/NRPE/client/targets/default)¶VERIFY MODE
What to verify default is non, to validate remote certificate use remote-peerPath: /settings/NRPE/client/targets/default
Key: verify mode
Default value: none
Used by:
NRPEClient
Sample:
[/settings/NRPE/client/targets/default] # VERIFY MODE verify mode=none
/settings/NRPE/client/targets/sample
(NRPEClient)¶TARGET DEFENITION
Target definition for: sample
Key Default Value Description address
TARGET ADDRESS alias
ALIAS allowed ciphers
ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH ALLOWED CIPHERS ca
CA certificate
SSL CERTIFICATE certificate format
PEM CERTIFICATE FORMAT certificate key
SSL CERTIFICATE KEY dh
DH KEY host
TARGET HOST insecure
Insecure legacy mode is template
0 IS TEMPLATE parent
default PARENT payload length
1024 PAYLOAD LENGTH port
0 TARGET PORT timeout
30 TIMEOUT use ssl
1 ENABLE SSL ENCRYPTION verify mode
none VERIFY MODE Sample:
# TARGET DEFENITION # Target definition for: sample [/settings/NRPE/client/targets/sample] address= alias= allowed ciphers=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH ca= certificate= certificate format=PEM certificate key= dh= host= insecure= is template=0 parent=default payload length=1024 port=0 timeout=30 use ssl=1 verify mode=none
address
(NRPEClient, /settings/NRPE/client/targets/sample)¶TARGET ADDRESS
Target host addressPath: /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=
alias
(NRPEClient, /settings/NRPE/client/targets/sample)¶ALIAS
The alias (service name) to report to serverAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/sample
Key: alias
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] # ALIAS alias=
allowed ciphers
(NRPEClient, /settings/NRPE/client/targets/sample)¶ALLOWED CIPHERS
The allowed list of ciphers (setting insecure wil override this to only support ADHAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/sample
Key: allowed ciphers
Default value: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
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=ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
ca
(NRPEClient, /settings/NRPE/client/targets/sample)¶CA
The certificate authority to use to authenticate remote certificateAdvanced (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
The ssl certificate to use to encrypt the communicationPath: /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
Format of SSL certificateAdvanced (means it is not commonly used)
Path: /settings/NRPE/client/targets/sample
Key: certificate format
Default value: PEM
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=PEM
certificate key
(NRPEClient, /settings/NRPE/client/targets/sample)¶SSL CERTIFICATE KEY
Key for the SSL certificatePath: /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 KEY certificate key=
dh
(NRPEClient, /settings/NRPE/client/targets/sample)¶DH KEY
The diffi-hellman perfect forwarded secret to use setting –insecure will override thisAdvanced (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 serverPath: /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=
is template
(NRPEClient, /settings/NRPE/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/NRPE/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:
NRPEClient
Sample:
[/settings/NRPE/client/targets/sample] # IS TEMPLATE is template=0
parent
(NRPEClient, /settings/NRPE/client/targets/sample)¶PARENT
The parent the target inherits fromAdvanced (means it is not commonly used)
Path: /settings/NRPE/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:
NRPEClient
Sample:
[/settings/NRPE/client/targets/sample] # PARENT parent=default
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: 1024
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=1024
port
(NRPEClient, /settings/NRPE/client/targets/sample)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/NRPE/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:
NRPEClient
Sample:
[/settings/NRPE/client/targets/sample] # TARGET PORT port=0
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: 1
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=1
verify mode
(NRPEClient, /settings/NRPE/client/targets/sample)¶VERIFY MODE
What to verify default is non, to validate remote certificate use remote-peerPath: /settings/NRPE/client/targets/sample
Key: verify mode
Default value: none
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=none