CheckMKClient
check_mk client can be used both from command line and from queries to check remote systes via check_mk

CheckMKClient — CheckMKClient

check_mk client can be used both from command line and from queries to check remote systes via check_mk

Queries (Overview):

A list of all avalible queries (check commands)

Command Description
check_mk_query Request remote information via check_mk.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/check_mk/client channel CheckMK CHANNEL
/settings/check_mk/client/handlers     CLIENT HANDLER SECTION
/settings/check_mk/client/scripts     REMOTE TARGET DEFINITIONS
/settings/check_mk/client/targets     REMOTE TARGET DEFINITIONS
/settings/check_mk/client/targets/default verify mode none VERIFY MODE
/settings/check_mk/client/targets/default certificate   SSL CERTIFICATE
/settings/check_mk/client/targets/default allowed ciphers ADH ALLOWED CIPHERS
/settings/check_mk/client/targets/default timeout 30 TIMEOUT
/settings/check_mk/client/targets/default address   TARGET ADDRESS
/settings/check_mk/client/targets/default use ssl 1 ENABLE SSL ENCRYPTION

Advanced keys:

Path / Section Key Default value Description
/settings/check_mk/client/targets/default parent default PARENT
/settings/check_mk/client/targets/default certificate format PEM CERTIFICATE FORMAT
/settings/check_mk/client/targets/default dh ${certificate-path}/nrpe_dh_512.pem DH KEY
/settings/check_mk/client/targets/default ca   CA
/settings/check_mk/client/targets/default certificate key   SSL CERTIFICATE
/settings/check_mk/client/targets/default port 0 TARGET PORT
/settings/check_mk/client/targets/default alias   ALIAS
/settings/check_mk/client/targets/default host   TARGET HOST
/settings/check_mk/client/targets/default is template 0 IS TEMPLATE

Sample keys:

Path / Section Key Default value Description
/settings/check_mk/client/targets/sample parent default PARENT
/settings/check_mk/client/targets/sample verify mode none VERIFY MODE
/settings/check_mk/client/targets/sample certificate format PEM CERTIFICATE FORMAT
/settings/check_mk/client/targets/sample dh ${certificate-path}/nrpe_dh_512.pem DH KEY
/settings/check_mk/client/targets/sample certificate   SSL CERTIFICATE
/settings/check_mk/client/targets/sample ca   CA
/settings/check_mk/client/targets/sample certificate key   SSL CERTIFICATE
/settings/check_mk/client/targets/sample port 0 TARGET PORT
/settings/check_mk/client/targets/sample alias   ALIAS
/settings/check_mk/client/targets/sample host   TARGET HOST
/settings/check_mk/client/targets/sample allowed ciphers ADH ALLOWED CIPHERS
/settings/check_mk/client/targets/sample timeout 30 TIMEOUT
/settings/check_mk/client/targets/sample address   TARGET ADDRESS
/settings/check_mk/client/targets/sample use ssl 1 ENABLE SSL ENCRYPTION
/settings/check_mk/client/targets/sample is template 0 IS TEMPLATE

Queries

A quick reference for all avalible queries (check commands) in the CheckMKClient module.

check_mk_query

CheckMKClientcheck_mk_query
Request remote information via check_mk.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
host N/A The host of the host running the server
port N/A The port of the host running the server
address N/A The address (host:port) of the host running the server
timeout N/A Number of seconds before connection times out (default=10)
target N/A Target to use (lookup connection info from config)
retry N/A Number of times ti retry a failed connection attempt (default=2)
command N/A The name of the query that the remote daemon should run
arguments N/A list of arguments
query-command N/A The name of the query that the remote daemon should run
query-arguments N/A list of arguments
certificate N/A Length of payload (has to be same as on the server)
dh N/A Length of payload (has to be same as on the server)
certificate-key N/A Client certificate to use
certificate-format N/A Client certificate format
ca N/A Certificate authority
verify N/A Client certificate format
allowed-ciphers N/A Client certificate format
payload-length N/A Length of payload (has to be same as on the server)
buffer-length N/A Length of payload (has to be same as on the server)
ssl N/A Initial an ssl handshake with the server.
timeout N/A  

Arguments

help (CheckMKClient, check_mk_query)
Show help screen (this screen)
help-csv (CheckMKClient, check_mk_query)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckMKClient, check_mk_query)
Show help screen (short format).
host (CheckMKClient, check_mk_query)
The host of the host running the server
port (CheckMKClient, check_mk_query)
The port of the host running the server
address (CheckMKClient, check_mk_query)
The address (host:port) of the host running the server
timeout (CheckMKClient, check_mk_query)
Number of seconds before connection times out (default=10)
target (CheckMKClient, check_mk_query)
Target to use (lookup connection info from config)
retry (CheckMKClient, check_mk_query)
Number of times ti retry a failed connection attempt (default=2)
command (CheckMKClient, check_mk_query)
The name of the query that the remote daemon should run
arguments (CheckMKClient, check_mk_query)
list of arguments
query-command (CheckMKClient, check_mk_query)
The name of the query that the remote daemon should run
query-arguments (CheckMKClient, check_mk_query)
list of arguments
certificate (CheckMKClient, check_mk_query)
Length of payload (has to be same as on the server)
dh (CheckMKClient, check_mk_query)
Length of payload (has to be same as on the server)
certificate-key (CheckMKClient, check_mk_query)
Client certificate to use
certificate-format (CheckMKClient, check_mk_query)
Client certificate format
ca (CheckMKClient, check_mk_query)
Certificate authority
verify (CheckMKClient, check_mk_query)
Client certificate format
allowed-ciphers (CheckMKClient, check_mk_query)
Client certificate format
payload-length (CheckMKClient, check_mk_query)
Length of payload (has to be same as on the server)
buffer-length (CheckMKClient, check_mk_query)
Length of payload (has to be same as on the server)
ssl (CheckMKClient, check_mk_query)
Initial an ssl handshake with the server.
timeout (CheckMKClient, check_mk_query)

Configuration

A quick reference for all avalible configuration options in the CheckMKClient module.

... / client / scripts

/settings/check_mk/client/scripts (CheckMKClient)

Sample:

# REMOTE TARGET DEFINITIONS
#
[/settings/check_mk/client/scripts]

... / client / handlers

/settings/check_mk/client/handlers (CheckMKClient)

Sample:

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

... / client / targets / default

/settings/check_mk/client/targets/default (CheckMKClient)
Key Default Value Description
address   TARGET ADDRESS
allowed ciphers ADH ALLOWED CIPHERS
certificate   SSL CERTIFICATE
timeout 30 TIMEOUT
use ssl 1 ENABLE SSL ENCRYPTION
verify mode none VERIFY MODE
alias   ALIAS
ca   CA
certificate format PEM CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh ${certificate-path}/nrpe_dh_512.pem DH KEY
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
port 0 TARGET PORT

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/check_mk/client/targets/default]
# PARENT
# The parent the target inherits from
parent=default
# VERIFY MODE
#
verify mode=none
# CERTIFICATE FORMAT
#
certificate format=PEM
# DH KEY
#
dh=${certificate-path}/nrpe_dh_512.pem
# SSL CERTIFICATE
#
certificate=
# CA
#
ca=
# SSL CERTIFICATE
#
certificate key=
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
allowed ciphers=ADH
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# TARGET ADDRESS
# Target host address
address=
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
use ssl=1
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
parent (CheckMKClient, /settings/check_mk/client/targets/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: parent

Default value: default

Used by: CheckMKClient

Sample:

# PARENT
# The parent the target inherits from
[/settings/check_mk/client/targets/default]
parent=default
verify mode (CheckMKClient, /settings/check_mk/client/targets/default)

VERIFY MODE


Path: /settings/check_mk/client/targets/default

Key: verify mode

Default value: none

Used by: CheckMKClient

Sample:

# VERIFY MODE
#
[/settings/check_mk/client/targets/default]
verify mode=none
certificate format (CheckMKClient, /settings/check_mk/client/targets/default)

CERTIFICATE FORMAT


Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: certificate format

Default value: PEM

Used by: CheckMKClient

Sample:

# CERTIFICATE FORMAT
#
[/settings/check_mk/client/targets/default]
certificate format=PEM
dh (CheckMKClient, /settings/check_mk/client/targets/default)

DH KEY


Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: dh

Default value: ${certificate-path}/nrpe_dh_512.pem

Used by: CheckMKClient

Sample:

# DH KEY
#
[/settings/check_mk/client/targets/default]
dh=${certificate-path}/nrpe_dh_512.pem
certificate (CheckMKClient, /settings/check_mk/client/targets/default)

SSL CERTIFICATE


Path: /settings/check_mk/client/targets/default

Key: certificate

Default value:

Used by: CheckMKClient

Sample:

# SSL CERTIFICATE
#
[/settings/check_mk/client/targets/default]
certificate=
ca (CheckMKClient, /settings/check_mk/client/targets/default)

CA


Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: ca

Default value:

Used by: CheckMKClient

Sample:

# CA
#
[/settings/check_mk/client/targets/default]
ca=
certificate key (CheckMKClient, /settings/check_mk/client/targets/default)

SSL CERTIFICATE


Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: certificate key

Default value:

Used by: CheckMKClient

Sample:

# SSL CERTIFICATE
#
[/settings/check_mk/client/targets/default]
certificate key=
port (CheckMKClient, /settings/check_mk/client/targets/default)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: port

Default value: 0

Used by: CheckMKClient

Sample:

# TARGET PORT
# The target server port
[/settings/check_mk/client/targets/default]
port=0
alias (CheckMKClient, /settings/check_mk/client/targets/default)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: alias

Default value:

Used by: CheckMKClient

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/check_mk/client/targets/default]
alias=
host (CheckMKClient, /settings/check_mk/client/targets/default)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/default

Key: host

Default value:

Used by: CheckMKClient

Sample:

# TARGET HOST
# The target server to report results to.
[/settings/check_mk/client/targets/default]
host=
allowed ciphers (CheckMKClient, /settings/check_mk/client/targets/default)

ALLOWED CIPHERS

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

Path: /settings/check_mk/client/targets/default

Key: allowed ciphers

Default value: ADH

Used by: CheckMKClient

Sample:

# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
[/settings/check_mk/client/targets/default]
allowed ciphers=ADH
timeout (CheckMKClient, /settings/check_mk/client/targets/default)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/check_mk/client/targets/default

Key: timeout

Default value: 30

Used by: CheckMKClient

Sample:

# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
[/settings/check_mk/client/targets/default]
timeout=30
address (CheckMKClient, /settings/check_mk/client/targets/default)

TARGET ADDRESS

Target host address

Path: /settings/check_mk/client/targets/default

Key: address

Default value:

Used by: CheckMKClient

Sample:

# TARGET ADDRESS
# Target host address
[/settings/check_mk/client/targets/default]
address=
use ssl (CheckMKClient, /settings/check_mk/client/targets/default)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/check_mk/client/targets/default

Key: use ssl

Default value: 1

Used by: CheckMKClient

Sample:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
[/settings/check_mk/client/targets/default]
use ssl=1
is template (CheckMKClient, /settings/check_mk/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/check_mk/client/targets/default

Key: is template

Default value: 0

Used by: CheckMKClient

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/check_mk/client/targets/default]
is template=0

... / client

/settings/check_mk/client (CheckMKClient)
Key Default Value Description
channel CheckMK CHANNEL

Sample:

# CHECK MK CLIENT SECTION
# Section for NSCP active/passive check module.
[/settings/check_mk/client]
# CHANNEL
# The channel to listen to.
channel=CheckMK
channel (CheckMKClient, /settings/check_mk/client)

CHANNEL

The channel to listen to.

Path: /settings/check_mk/client

Key: channel

Default value: CheckMK

Used by: CheckMKClient

Sample:

# CHANNEL
# The channel to listen to.
[/settings/check_mk/client]
channel=CheckMK

... / client / targets

/settings/check_mk/client/targets (CheckMKClient)

Sample:

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

... / client / targets / sample

/settings/check_mk/client/targets/sample (CheckMKClient)
Key Default Value Description
address   TARGET ADDRESS
alias   ALIAS
allowed ciphers ADH ALLOWED CIPHERS
ca   CA
certificate   SSL CERTIFICATE
certificate format PEM CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh ${certificate-path}/nrpe_dh_512.pem DH KEY
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
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/check_mk/client/targets/sample]
# PARENT
# The parent the target inherits from
parent=default
# VERIFY MODE
#
verify mode=none
# CERTIFICATE FORMAT
#
certificate format=PEM
# DH KEY
#
dh=${certificate-path}/nrpe_dh_512.pem
# SSL CERTIFICATE
#
certificate=
# CA
#
ca=
# SSL CERTIFICATE
#
certificate key=
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
allowed ciphers=ADH
# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
timeout=30
# TARGET ADDRESS
# Target host address
address=
# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
use ssl=1
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
parent (CheckMKClient, /settings/check_mk/client/targets/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/check_mk/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: CheckMKClient

Sample:

# PARENT
# The parent the target inherits from
[/settings/check_mk/client/targets/sample]
parent=default
verify mode (CheckMKClient, /settings/check_mk/client/targets/sample)

VERIFY MODE


Path: /settings/check_mk/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: CheckMKClient

Sample:

# VERIFY MODE
#
[/settings/check_mk/client/targets/sample]
verify mode=none
certificate format (CheckMKClient, /settings/check_mk/client/targets/sample)

CERTIFICATE FORMAT


Advanced (means it is not commonly used)

Path: /settings/check_mk/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: CheckMKClient

Sample:

# CERTIFICATE FORMAT
#
[/settings/check_mk/client/targets/sample]
certificate format=PEM
dh (CheckMKClient, /settings/check_mk/client/targets/sample)

DH KEY


Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/sample

Key: dh

Default value: ${certificate-path}/nrpe_dh_512.pem

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

Used by: CheckMKClient

Sample:

# DH KEY
#
[/settings/check_mk/client/targets/sample]
dh=${certificate-path}/nrpe_dh_512.pem
certificate (CheckMKClient, /settings/check_mk/client/targets/sample)

SSL CERTIFICATE


Path: /settings/check_mk/client/targets/sample

Key: certificate

Default value:

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

Used by: CheckMKClient

Sample:

# SSL CERTIFICATE
#
[/settings/check_mk/client/targets/sample]
certificate=
ca (CheckMKClient, /settings/check_mk/client/targets/sample)

CA


Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/sample

Key: ca

Default value:

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

Used by: CheckMKClient

Sample:

# CA
#
[/settings/check_mk/client/targets/sample]
ca=
certificate key (CheckMKClient, /settings/check_mk/client/targets/sample)

SSL CERTIFICATE


Advanced (means it is not commonly used)

Path: /settings/check_mk/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: CheckMKClient

Sample:

# SSL CERTIFICATE
#
[/settings/check_mk/client/targets/sample]
certificate key=
port (CheckMKClient, /settings/check_mk/client/targets/sample)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/check_mk/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: CheckMKClient

Sample:

# TARGET PORT
# The target server port
[/settings/check_mk/client/targets/sample]
port=0
alias (CheckMKClient, /settings/check_mk/client/targets/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/sample

Key: alias

Default value:

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

Used by: CheckMKClient

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/check_mk/client/targets/sample]
alias=
host (CheckMKClient, /settings/check_mk/client/targets/sample)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/check_mk/client/targets/sample

Key: host

Default value:

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

Used by: CheckMKClient

Sample:

# TARGET HOST
# The target server to report results to.
[/settings/check_mk/client/targets/sample]
host=
allowed ciphers (CheckMKClient, /settings/check_mk/client/targets/sample)

ALLOWED CIPHERS

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

Path: /settings/check_mk/client/targets/sample

Key: allowed ciphers

Default value: ADH

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

Used by: CheckMKClient

Sample:

# ALLOWED CIPHERS
# A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH
[/settings/check_mk/client/targets/sample]
allowed ciphers=ADH
timeout (CheckMKClient, /settings/check_mk/client/targets/sample)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/check_mk/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: CheckMKClient

Sample:

# TIMEOUT
# Timeout when reading/writing packets to/from sockets.
[/settings/check_mk/client/targets/sample]
timeout=30
address (CheckMKClient, /settings/check_mk/client/targets/sample)

TARGET ADDRESS

Target host address

Path: /settings/check_mk/client/targets/sample

Key: address

Default value:

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

Used by: CheckMKClient

Sample:

# TARGET ADDRESS
# Target host address
[/settings/check_mk/client/targets/sample]
address=
use ssl (CheckMKClient, /settings/check_mk/client/targets/sample)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/check_mk/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: CheckMKClient

Sample:

# ENABLE SSL ENCRYPTION
# This option controls if SSL should be enabled.
[/settings/check_mk/client/targets/sample]
use ssl=1
is template (CheckMKClient, /settings/check_mk/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/check_mk/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: CheckMKClient

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/check_mk/client/targets/sample]
is template=0
comments powered by Disqus