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 available queries (check commands)

Command Description
check_mk_query Request remote information via check_mk.

Commands (Overview):

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

Configuration (Overview):

Common Keys:

Path / Section Key Description
/settings/check_mk/client channel CHANNEL
/settings/check_mk/client/targets/default address TARGET ADDRESS
/settings/check_mk/client/targets/default retries RETRIES
/settings/check_mk/client/targets/default timeout TIMEOUT

Advanced keys:

Path / Section Key Default Value Description
/settings/check_mk/client/targets/default host TARGET HOST  
/settings/check_mk/client/targets/default port TARGET PORT  

Sample keys:

Path / Section Key Default Value Description
/settings/check_mk/client/targets/sample address TARGET ADDRESS  
/settings/check_mk/client/targets/sample host TARGET HOST  
/settings/check_mk/client/targets/sample port TARGET PORT  
/settings/check_mk/client/targets/sample retries RETRIES  
/settings/check_mk/client/targets/sample timeout TIMEOUT  

Queries

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

Arguments

help (CheckMKClient, check_mk_query)
Show help screen (this screen)
help-pb (CheckMKClient, check_mk_query)
Show help screen as a protocol buffer payload
show-default (CheckMKClient, check_mk_query)
Show default values for a given command
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)
retries (CheckMKClient, check_mk_query)
legacy version of retry
source-host (CheckMKClient, check_mk_query)
Source/sender host name (default is auto which means use the name of the actual host)
sender-host (CheckMKClient, check_mk_query)
Source/sender host name (default is auto which means use the name of the actual host)
command (CheckMKClient, check_mk_query)
The name of the command that the remote daemon should run
argument (CheckMKClient, check_mk_query)
Set command line arguments
separator (CheckMKClient, check_mk_query)
Separator to use for the batch command (default is |)
batch (CheckMKClient, check_mk_query)
Add multiple records using the separator format is: command|argument|argument
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
ssl (CheckMKClient, check_mk_query)
Initial an ssl handshake with the server.

/ settings/ check_mk/ client

/settings/check_mk/client (CheckMKClient)

CHECK MK CLIENT SECTION

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

Sample:

# CHECK MK CLIENT SECTION
# Section for check_mk active/passive check module.
[/settings/check_mk/client]
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:

[/settings/check_mk/client]
# CHANNEL
channel=CheckMK

… / handlers

/settings/check_mk/client/handlers (CheckMKClient)

CLIENT HANDLER SECTION

Sample:

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

… / scripts

/settings/check_mk/client/scripts (CheckMKClient)

REMOTE TARGET DEFINITIONS

Sample:

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

… / targets

/settings/check_mk/client/targets (CheckMKClient)

REMOTE TARGET DEFINITIONS

Sample:

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

… / targets / default

/settings/check_mk/client/targets/default (CheckMKClient)

TARGET

Target definition for: default
Key Default Value Description
address   TARGET ADDRESS
host   TARGET HOST
port   TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT

Sample:

# TARGET
# Target definition for: default
[/settings/check_mk/client/targets/default]
address=
host=
port=
retries=3
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:

[/settings/check_mk/client/targets/default]
# TARGET ADDRESS
address=
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:

[/settings/check_mk/client/targets/default]
# TARGET HOST
host=
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:

Used by: CheckMKClient

Sample:

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

RETRIES

Number of times to retry sending.

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

Key: retries

Default value: 3

Used by: CheckMKClient

Sample:

[/settings/check_mk/client/targets/default]
# RETRIES
retries=3
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:

[/settings/check_mk/client/targets/default]
# TIMEOUT
timeout=30

… / targets / sample

/settings/check_mk/client/targets/sample (CheckMKClient)

TARGET

Target definition for: sample
Key Default Value Description
address   TARGET ADDRESS
host   TARGET HOST
port   TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT

Sample:

# TARGET
# Target definition for: sample
[/settings/check_mk/client/targets/sample]
address=
host=
port=
retries=3
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:

[/settings/check_mk/client/targets/sample]
# TARGET ADDRESS
address=
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:

[/settings/check_mk/client/targets/sample]
# TARGET HOST
host=
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:

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

Used by: CheckMKClient

Sample:

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

RETRIES

Number of times to retry sending.

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

Key: retries

Default value: 3

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

Used by: CheckMKClient

Sample:

[/settings/check_mk/client/targets/sample]
# RETRIES
retries=3
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:

[/settings/check_mk/client/targets/sample]
# TIMEOUT
timeout=30
comments powered by Disqus