CheckWMI
CheckWMI
— CheckWMI¶Check status via WMI
Queries (Overview):
A list of all available queries (check commands)
Command | Description |
---|---|
check_wmi |
Check a set of WMI values and return rows which are matching criteria. |
Aliases (Overview):
A list of all short hand aliases for queries (check commands)
Command | Description |
---|---|
checkwmi | Alias for: check_wmi |
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
A quick reference for all available queries (check commands) in the CheckWMI module.
check_wmi
¶CheckWMI
check_wmi
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). |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show debugging information in the log |
filter |
Filter which marks interesting items. | |
warning |
Filter which marks items which generates a warning state. | |
warn |
Short alias for warning | |
critical |
Filter which marks items which generates a critical state. | |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
empty-state |
ignored | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
top-syntax |
${list} | Top level syntax. |
ok-syntax |
ok syntax. | |
empty-syntax |
Empty syntax. | |
detail-syntax |
%(line) | Detail level syntax. |
perf-syntax |
Performance alias syntax. | |
target |
The target to check (for checking remote machines). | |
user |
Remote username when checking remote machines. | |
password |
Remote password when checking remote machines. | |
namespace |
rootcimv2 | The WMI root namespace to bind to. |
query |
The WMI query to execute. |
Basic check to see/fetch information (no check):
check_wmi "query=Select Version,Caption from win32_OperatingSystem"
OK: Microsoft Windows 8.1 Pro, 6.3.9600
A simple string check:
check_wmi "query=Select Version,Caption from win32_OperatingSystem" "warn=Version not like '6.3'" "crit=Version not like '6'"
OK: Microsoft Windows 8.1 Pro, 6.3.9600
Simple check via via NRPE:
check_nrpe --host 192.168.56.103 --command check_wmi -a "query=Select Version,Caption from win32_OperatingSystem" "warn=Version not like '6.3'" "crit=Version not like '6'"
OK: Microsoft Windows 8.1 Pro, 6.3.9600
A simple integer (number) check:
check_wmi "query=Select BuildNumber from win32_OperatingSystem" "warn=BuildNumber < 9600" "crit=BuildNumber < 8000"
L cli OK: 9600
L cli Performance data: 'BuildNumber'=9600;9600;8000
Using performance options to customize the performance data:
check_wmi "query=select Name, AvgDiskQueueLength from Win32_PerfFormattedData_PerfDisk_PhysicalDisk" "warn=AvgDiskQueueLength>0" "perf-syntax=%(Name)" "perf-config=*(prefix:'time')"
L cli OK: 0, _Total, 0, 0 C:, 0, 1 D:
L cli Performance data: 'time_Total'=0;0;0 'time0 C:'=0;0;0 'time1 D:'=0;0;0
Adding values to the message:
check_wmi "query=Select BuildNumber from win32_OperatingSystem" "warn=BuildNumber < 9600" "crit=BuildNumber < 8000" "detail-syntax=You have build %(BuildNumber)" show-all
L cli OK: You have build 10240
L cli Performance data: 'BuildNumber'=10240;9600;8000
help
(CheckWMI, check_wmi)¶help-pb
(CheckWMI, check_wmi)¶show-default
(CheckWMI, check_wmi)¶help-short
(CheckWMI, check_wmi)¶debug
(CheckWMI, check_wmi)¶show-all
(CheckWMI, check_wmi)¶filter
(CheckWMI, check_wmi)¶Key | Value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warning
(CheckWMI, check_wmi)¶Key | Value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
warn
(CheckWMI, check_wmi)¶critical
(CheckWMI, check_wmi)¶Key | Value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
crit
(CheckWMI, check_wmi)¶ok
(CheckWMI, check_wmi)¶Key | Value |
count | Number of items matching the filter |
total | Total number of items |
ok_count | Number of items matched the ok criteria |
warn_count | Number of items matched the warning criteria |
crit_count | Number of items matched the critical criteria |
problem_count | Number of items matched either warning or critical criteria |
list | A list of all items which matched the filter |
ok_list | A list of all items which matched the ok criteria |
warn_list | A list of all items which matched the warning criteria |
crit_list | A list of all items which matched the critical criteria |
problem_list | A list of all items which matched either the critical or the warning criteria |
detail_list | A special list with critical, then warning and fainally ok |
status | The returned status (OK/WARN/CRIT/UNKNOWN) |
empty-state
(CheckWMI, check_wmi)¶perf-config
(CheckWMI, check_wmi)¶top-syntax
(CheckWMI, check_wmi)¶Key | Value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
ok-syntax
(CheckWMI, check_wmi)¶empty-syntax
(CheckWMI, check_wmi)¶Key | Value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
detail-syntax
(CheckWMI, check_wmi)¶Key | Value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
perf-syntax
(CheckWMI, check_wmi)¶Key | Value |
${count} | Number of items matching the filter |
${total} | Total number of items |
${ok_count} | Number of items matched the ok criteria |
${warn_count} | Number of items matched the warning criteria |
${crit_count} | Number of items matched the critical criteria |
${problem_count} | Number of items matched either warning or critical criteria |
${list} | A list of all items which matched the filter |
${ok_list} | A list of all items which matched the ok criteria |
${warn_list} | A list of all items which matched the warning criteria |
${crit_list} | A list of all items which matched the critical criteria |
${problem_list} | A list of all items which matched either the critical or the warning criteria |
${detail_list} | A special list with critical, then warning and fainally ok |
${status} | The returned status (OK/WARN/CRIT/UNKNOWN) |
target
(CheckWMI, check_wmi)¶user
(CheckWMI, check_wmi)¶password
(CheckWMI, check_wmi)¶namespace
(CheckWMI, check_wmi)¶query
(CheckWMI, check_wmi)¶