.. module : : WEBClient: :synopsis: WEB client can be used both from command line and from queries to check remote systes via WEB(REST)

:module:`WEBClient` --- WEBClient

WEB client can be used both from command line and from queries to check remote systes via WEB(REST)

Queries (Overview):

list of all available queries (check commands)

: class : contentstable

:class: contentstable

:delim: |

:header: "Command", "Description"

:query:`web_exec` | Execute remote script via WEB.

:query:`web_forward` | Forward the request as-is to remote host via WEB.

:query:`web_query` | Request remote information via WEB.

:query:`web_submit` | Submit information to remote host via WEB.

Commands (Overview):

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

Configuration (Overview):

Common Keys:

: class : contentstable

:class: contentstable

:delim: |

:header: "Path / Section", "Key", "Description"

:confpath:`/settings/NRPE/client` | :confkey:`~/settings/NRPE/client.channel` | CHANNEL

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.address` | TARGET ADDRESS

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.certificate` | SSL CERTIFICATE

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.certificate key` | SSL CERTIFICATE KEY

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.insecure` | Insecure legacy mode

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.payload length` | PAYLOAD LENGTH

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.timeout` | TIMEOUT

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.use ssl` | ENABLE SSL ENCRYPTION

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.verify mode` | VERIFY MODE

Advanced keys:

: class : contentstable

:class: contentstable

:delim: |

:header: "Path / Section", "Key", "Default Value", "Description"

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.alias` | ALIAS

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.allowed ciphers` | ALLOWED CIPHERS

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.ca` | CA

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.certificate format` | CERTIFICATE FORMAT

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.dh` | DH KEY

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.host` | TARGET HOST

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.is template` | IS TEMPLATE

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.parent` | PARENT

:confpath:`/settings/NRPE/client/targets/default` | :confkey:`~/settings/NRPE/client/targets/default.port` | TARGET PORT

Sample keys:

: class : contentstable

:class: contentstable

:delim: |

:header: "Path / Section", "Key", "Default Value", "Description"

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.address` | TARGET ADDRESS

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.alias` | ALIAS

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.allowed ciphers` | ALLOWED CIPHERS

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.ca` | CA

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.certificate` | SSL CERTIFICATE

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.certificate format` | CERTIFICATE FORMAT

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.certificate key` | SSL CERTIFICATE KEY

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.dh` | DH KEY

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.host` | TARGET HOST

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.insecure` | Insecure legacy mode

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.is template` | IS TEMPLATE

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.parent` | PARENT

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.payload length` | PAYLOAD LENGTH

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.port` | TARGET PORT

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.timeout` | TIMEOUT

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.use ssl` | ENABLE SSL ENCRYPTION

:confpath:`/settings/NRPE/client/targets/sample` | :confkey:`~/settings/NRPE/client/targets/sample.verify mode` | VERIFY MODE

Queries

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

:query:`web_exec`

:synopsis: Execute remote script via WEB.

Usage:

: class : contentstable

:class: contentstable

:delim: |

:header: "Option", "Default Value", "Description"

:option:`help` | N/A | Show help screen (this screen)

:option:`help-pb` | N/A | Show help screen as a protocol buffer payload

:option:`show-default` | N/A | Show default values for a given command

:option:`help-short` | N/A | Show help screen (short format).

:option:`host` | | The host of the host running the server

:option:`port` | | The port of the host running the server

:option:`address` | | The address (host:port) of the host running the server

:option:`timeout` | | Number of seconds before connection times out (default=10)

:option:`target` | | Target to use (lookup connection info from config)

:option:`retry` | | Number of times ti retry a failed connection attempt (default=2)

:option:`command` | | The name of the command that the remote daemon should run

:option:`arguments` | | list of arguments

:option:`no-ssl` | N/A | Do not initial an ssl handshake with the server, talk in plain-text.

:option:`certificate` | | Length of payload (has to be same as on the server)

:option:`dh` | | The pre-generated DH key (if ADH is used this will be your 'key' though it is not a secret key)

:option:`certificate-key` | | Client certificate to use

:option:`certificate-format` | | Client certificate format (default is PEM)

:option:`insecure` | N/A | Use insecure legacy mode

:option:`ca` | | A file representing the Certificate authority used to validate peer certificates

:option:`verify` | | Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ...

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

:option:`payload-length` | | Length of payload (has to be same as on the server)

:option:`buffer-length` | | Same as payload-length (used for legacy reasons)

:option:`ssl` | N/A | Initial an ssl handshake with the server.

Arguments

: synopsis : Show help screen (this screen)

:synopsis: Show help screen (this screen)

| Show help screen (this screen)

: synopsis : Show help screen as a protocol buffer payload

:synopsis: Show help screen as a protocol buffer payload

| Show help screen as a protocol buffer payload

: synopsis : Show default values for a given command

:synopsis: Show default values for a given command

| Show default values for a given command

: synopsis : Show help screen (short format).

:synopsis: Show help screen (short format).

| Show help screen (short format).

: synopsis : The host of the host running the server

:synopsis: The host of the host running the server

| The host of the host running the server

: synopsis : The port of the host running the server

:synopsis: The port of the host running the server

| The port of the host running the server

: synopsis : The address (host : port) of the host running the server

:synopsis: The address (host:port) of the host running the server

| The address (host:port) of the host running the server

: synopsis : Number of seconds before connection times out (default=10)

:synopsis: Number of seconds before connection times out (default=10)

| Number of seconds before connection times out (default=10)

: synopsis : Target to use (lookup connection info from config)

:synopsis: Target to use (lookup connection info from config)

| Target to use (lookup connection info from config)

: synopsis : Number of times ti retry a failed connection attempt (default=2)

:synopsis: Number of times ti retry a failed connection attempt (default=2)

| Number of times ti retry a failed connection attempt (default=2)

: synopsis : The name of the command that the remote daemon should run

:synopsis: The name of the command that the remote daemon should run

| The name of the command that the remote daemon should run

: synopsis : list of arguments

:synopsis: list of arguments

| list of arguments

: synopsis : Do not initial an ssl handshake with the server, talk in plain-text.

:synopsis: Do not initial an ssl handshake with the server, talk in plain-text.

| Do not initial an ssl handshake with the server, talk in plain-text.

: synopsis : Length of payload (has to be same as on the server)

:synopsis: Length of payload (has to be same as on the server)

| Length of payload (has to be same as on the server)

: synopsis : The pre-generated DH key (if ADH is used this will be your 'key' though it is not a secret key)

:synopsis: The pre-generated DH key (if ADH is used this will be your 'key' though it is not a secret key)

| The pre-generated DH key (if ADH is used this will be your 'key' though it is not a secret key)

: synopsis : Client certificate to use

:synopsis: Client certificate to use

| Client certificate to use

: synopsis : Client certificate format (default is PEM)

:synopsis: Client certificate format (default is PEM)

| Client certificate format (default is PEM)

: synopsis : Use insecure legacy mode

:synopsis: Use insecure legacy mode

| Use insecure legacy mode

: synopsis : A file representing the Certificate authority used to validate peer certificates

:synopsis: A file representing the Certificate authority used to validate peer certificates

| A file representing the Certificate authority used to validate peer certificates

: synopsis : Which verification mode to use : none : no verification, peer : that peer has a certificate, peer-cert : that peer has a valid certificate, ...

:synopsis: Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ...

| Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ...

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

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

| 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

: synopsis : Length of payload (has to be same as on the server)

:synopsis: Length of payload (has to be same as on the server)

| Length of payload (has to be same as on the server)

: synopsis : Same as payload-length (used for legacy reasons)

:synopsis: Same as payload-length (used for legacy reasons)

| Same as payload-length (used for legacy reasons)

: synopsis : Initial an ssl handshake with the server.

:synopsis: Initial an ssl handshake with the server.

| Initial an ssl handshake with the server.

:query:`web_forward`

:synopsis: Forward the request as-is to remote host via WEB.

Usage:

Arguments

:query:`web_query`

:synopsis: Request remote information via WEB.

Usage:

: class : contentstable

:class: contentstable

:delim: |

:header: "Option", "Default Value", "Description"

:option:`help` | N/A | Show help screen (this screen)

:option:`help-pb` | N/A | Show help screen as a protocol buffer payload

:option:`show-default` | N/A | Show default values for a given command

:option:`help-short` | N/A | Show help screen (short format).

:option:`host` | | The host of the host running the server

:option:`port` | | The port of the host running the server

:option:`address` | | The address (host:port) of the host running the server

:option:`timeout` | | Number of seconds before connection times out (default=10)

:option:`target` | | Target to use (lookup connection info from config)

:option:`retry` | | Number of times ti retry a failed connection attempt (default=2)

:option:`command` | | The name of the query that the remote daemon should run

:option:`arguments` | | list of arguments

:option:`query-command` | | The name of the query that the remote daemon should run

:option:`query-arguments` | | list of arguments

:option:`no-ssl` | N/A | Do not initial an ssl handshake with the server, talk in plain-text.

:option:`certificate` | | Length of payload (has to be same as on the server)

:option:`dh` | | The pre-generated DH key (if ADH is used this will be your 'key' though it is not a secret key)

:option:`certificate-key` | | Client certificate to use

:option:`certificate-format` | | Client certificate format (default is PEM)

:option:`insecure` | N/A | Use insecure legacy mode

:option:`ca` | | A file representing the Certificate authority used to validate peer certificates

:option:`verify` | | Which verification mode to use: none: no verification, peer: that peer has a certificate, peer-cert: that peer has a valid certificate, ...

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

:option:`payload-length` | | Length of payload (has to be same as on the server)

:option:`buffer-length` | | Same as payload-length (used for legacy reasons)

:option:`ssl` | N/A | Initial an ssl handshake with the server.

Arguments

: synopsis : Show help screen (this screen)

:synopsis: Show help screen (this screen)

| Show help screen (this screen)

: synopsis : Show help screen as a protocol buffer payload

:synopsis: Show help screen as a protocol buffer payload

| Show help screen as a protocol buffer payload

: synopsis : Show default values for a given command

:synopsis: Show default values for a given command

| Show default values for a given command

: synopsis : Show help screen (short format).

:synopsis: Show help screen (short format).

| Show help screen (short format).

: synopsis : The host of the host running the server

:synopsis: The host of the host running the server

| The host of the host running the server

: synopsis : The port of the host running the server

:synopsis: The port of the host running the server

| The port of the host running the server

: synopsis : The address (host : port) of the host running the server

:synopsis: The address (host:port) of the host running the server

| The address (host:port) of the host running the server

: synopsis : Number of seconds before connection times out (default=10)

:synopsis: Number of seconds before connection times out (default=10)

| Number of seconds before connection times out (default=10)

: synopsis : Target to use (lookup connection info from config)

:synopsis: Target to use (lookup connection info from config)

| Target to use (lookup connection info from config)

: synopsis : Number of times ti retry a failed connection attempt (default=2)

:synopsis: Number of times ti retry a failed connection attempt (default=2)

| Number of times ti retry a failed connection attempt (default=2)

: synopsis : The name of the query that the remote daemon should run

:synopsis: The name of the query that the remote daemon should run

| The name of the query that the remote daemon should run