CheckDisk
CheckDisk
— CheckDisk¶CheckDisk can check various file and disk related things.
Queries (Overview):
A list of all available queries (check commands)
Command | Description |
---|---|
check_drivesize |
Check the size (free-space) of a drive or volume. |
check_files |
Check various aspects of a file and/or folder. |
checkdrivesize |
Legacy version of check_drivesize |
checkfiles |
Legacy version of check_drivesize |
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
A quick reference for all available queries (check commands) in the CheckDisk module.
check_drivesize
¶CheckDisk
check_drivesize
Usage:
Option | Default Value | Description |
---|---|---|
filter |
mounted = 1 | Filter which marks interesting items. |
warning |
used > 80% | Filter which marks items which generates a warning state. |
warn |
Short alias for warning | |
critical |
used > 90% | Filter which marks items which generates a critical state. |
crit |
Short alias for critical. | |
ok |
Filter which marks items which generates an ok state. | |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show details for all matches regardless of status (normally details are only showed for warnings and criticals). |
empty-state |
unknown | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
escape-html |
N/A | Escape any < and > characters to prevent HTML encoding |
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). |
top-syntax |
${status} ${problem_list} | Top level syntax. |
ok-syntax |
%(status) All %(count) drive(s) are ok | ok syntax. |
empty-syntax |
%(status): No drives found | Empty syntax. |
detail-syntax |
${drive_or_name}: ${used}/${size} used | Detail level syntax. |
perf-syntax |
${drive_or_id} | Performance alias syntax. |
drive |
The drives to check. | |
ignore-unreadable |
N/A | DEPRECATED (manually set filter instead) Ignore drives which are not reachable by the current user. |
mounted |
N/A | DEPRECATED (this is now default) Show only mounted rives i.e. drives which have a mount point. |
magic |
Magic number for use with scaling drive sizes. | |
exclude |
A list of drives not to check | |
total |
N/A | Include the total of all matching drives |
To check the size of the C:drive and make sure it has atleast 10% free space:
check_drivesize "crit=free<10%" drive=c:
L client CRITICAL: c:: 205GB/223GB used
L client Performance data: 'c: free'=18GB;0;22;0;223 'c: free %'=8%;0;9;0;100
To check the size of all the drives and make sure it has atleast 10% free space:
check_drivesize "crit=free<10%" drive=*
L client OK: All drives ok
L client Performance data: 'C:\ free'=18GB;0;2;0;223 'C:\ free %'=8%;0;0;0;100 'D:\ free'=18GB;0;4;0;465 'D:\ free %'=3%;0;0;0;100 'M:\ free'=83GB;0;27;0;2746 'M:\ free %'=3%;0;0;0;100
To check the size of all the drives and display all values, not just problems:
check_drivesize drive=* --show-all
L client CRITICAL: c:: 205GB/223GB used
L client Performance data: 'c: free'=18GB;0;22;0;223 'c: free %'=8%;0;9;0;100
To check the size of all the drives and return the value in gigabytes. By default units on performance data will be scaled to “something apropriate”:
check_drivesize "perf-config=*(unit:g)"
L cli CRITICAL: CRITICAL C:\: 208.147GB/223.471GB used, D:\: 399.607GB/465.759GB used
L cli Performance data: 'C:\ used'=0.00019g;0.00017;0.00019;0;0.00021 'C:\ used %'=93%;79;89;0;100 'D:\ used'=0.00038g;0.00035;0.00039;0;0.00044 'D:\ used %'=85%;79;89;0;100 'E:\ used'=0g;0;0;0;0 '\\?\Volume{d458535f-27c7-11e4-be66-806e6f6e6963}\ used'=0g;0;0;0;0 '\\?\Volume{d458535f-27c7-11e4-be66-806e6f6e6963}\ used %'=33%;79;89;0;100
To check the size of a mounted volume (c:volumne_test) and make sure it has 1M free space warn if free space is less then 10M:
check_drivesize "crit=free<1M" "warn=free<10M" drive=c:\\volumne_test
C:: Total: 74.5G - Used: 71.2G (95%) - Free: 3.28G (5%) < critical,C:;5%;10;5;
To check the size of all volumes and make sure they have 1M space free:
check_drivesize "crit=free<1M" drive=all-volumes
L client OK: All drives ok
L client Performance data: 'C:\ free'=18GB;0;2;0;223 'C:\ free %'=8%;0;0;0;100 'D:\ free'=18GB;0;4;0;465 'D:\ free %'=3%;0;0;0;100 'E:\ free'=0B;0;0;0;0 'F:\ free'=0B;0;0;0;0
To check the size of all fixed and network drives and make sure they have at least 1gig free space:
check_drivesize "crit=free<1g" drive=* "filter=type in ('fixed', 'remote')"
L client OK: All drives ok
L client Performance data: 'C:\ free'=18GB;0;2;0;223 'C:\ free %'=8%;0;0;0;100 'D:\ free'=18GB;0;4;0;465 'D:\ free %'=3%;0;0;0;100 'M:\ free'=83GB;0;27;0;2746 'M:\ free %'=3%;0;0;0;100
To check all fixed and network drives but ignore C and F:
check_drivesize "crit=free<1g" drive=* "filter=type in ('fixed', 'remote')" exclude=C:\\ exclude=D:\\
L client OK: All drives ok
L client Performance data: 'M:\ free'=83GB;0;27;0;2746 'M:\ free %'=3%;0;0;0;100
To checking UNC Paths. Please note that I need to use \ to escape the back-slashes from check_nrpe you can escape using ‘ instead which is simpler:
check_drivesize drive=\\\\medin-ds\\data\\ "crit=free<10%"
L client CRITICAL: \\medin-ds\data\: 2.6TB/2.68TB used
L client Performance data: '\\medin-ds\data\ free'=83GB;0;274;0;2746 '\\medin-ds\data\ free %'=3%;0;9;0;100
Important
Please note that UNC paths are only avalible in each session meaning a user mounted share will not be visible to NSClient++ (since services run in their own session). But as long as NSClient++ can access the share it still works as long as you specify the UNC path. In other words the following will NOT work:
check_drivesize drive=m:
But the following will:
check_drivesize drive=\\myserver\\mydrive
Important
Do not forget the trailing .
Default via NRPE:
check_nrpe --host 192.168.56.103 --command check_drivesize
C:\: 205GB/223GB used, D:\: 448GB/466GB used, M:\: 2.6TB/2.68TB used|'C:\ used'=204GB;44;22;0;223 'C:\ used %'=91%;19;9;0;100 'D:\ used'=447GB;93;46;0;465...
filter
(CheckDisk, check_drivesize)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
drive | Technical name of drive |
drive_or_id | Drive letter if present if not use id |
drive_or_name | Drive letter if present if not use name |
erasable | 1 (true) if drive is erasable |
flags | String representation of flags |
free | Shorthand for total_free (Number of free bytes) |
free_pct | Shorthand for total_free_pct (% free space) |
hotplug | 1 (true) if drive is hotplugable |
id | Drive or id of drive |
mounted | Check if a drive is mounted |
name | Descriptive name of drive |
readable | 1 (true) if drive is readable |
removable | 1 (true) if drive is removable |
size | Total size of drive |
total_free | Number of free bytes |
total_free_pct | % free space |
total_used | Number of used bytes |
total_used_pct | % used space |
type | Type of drive |
used | Number of used bytes |
used_pct | Shorthand for total_used_pct (% used space) |
user_free | Free space available to user (which runs NSClient++) |
user_free_pct | % free space available to user |
user_used | Number of used bytes (related to user) |
user_used_pct | % used space available to user |
writable | 1 (true) if drive is writable |
warning
(CheckDisk, check_drivesize)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
drive | Technical name of drive |
drive_or_id | Drive letter if present if not use id |
drive_or_name | Drive letter if present if not use name |
erasable | 1 (true) if drive is erasable |
flags | String representation of flags |
free | Shorthand for total_free (Number of free bytes) |
free_pct | Shorthand for total_free_pct (% free space) |
hotplug | 1 (true) if drive is hotplugable |
id | Drive or id of drive |
mounted | Check if a drive is mounted |
name | Descriptive name of drive |
readable | 1 (true) if drive is readable |
removable | 1 (true) if drive is removable |
size | Total size of drive |
total_free | Number of free bytes |
total_free_pct | % free space |
total_used | Number of used bytes |
total_used_pct | % used space |
type | Type of drive |
used | Number of used bytes |
used_pct | Shorthand for total_used_pct (% used space) |
user_free | Free space available to user (which runs NSClient++) |
user_free_pct | % free space available to user |
user_used | Number of used bytes (related to user) |
user_used_pct | % used space available to user |
writable | 1 (true) if drive is writable |
warn
(CheckDisk, check_drivesize)¶critical
(CheckDisk, check_drivesize)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
drive | Technical name of drive |
drive_or_id | Drive letter if present if not use id |
drive_or_name | Drive letter if present if not use name |
erasable | 1 (true) if drive is erasable |
flags | String representation of flags |
free | Shorthand for total_free (Number of free bytes) |
free_pct | Shorthand for total_free_pct (% free space) |
hotplug | 1 (true) if drive is hotplugable |
id | Drive or id of drive |
mounted | Check if a drive is mounted |
name | Descriptive name of drive |
readable | 1 (true) if drive is readable |
removable | 1 (true) if drive is removable |
size | Total size of drive |
total_free | Number of free bytes |
total_free_pct | % free space |
total_used | Number of used bytes |
total_used_pct | % used space |
type | Type of drive |
used | Number of used bytes |
used_pct | Shorthand for total_used_pct (% used space) |
user_free | Free space available to user (which runs NSClient++) |
user_free_pct | % free space available to user |
user_used | Number of used bytes (related to user) |
user_used_pct | % used space available to user |
writable | 1 (true) if drive is writable |
crit
(CheckDisk, check_drivesize)¶ok
(CheckDisk, check_drivesize)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
drive | Technical name of drive |
drive_or_id | Drive letter if present if not use id |
drive_or_name | Drive letter if present if not use name |
erasable | 1 (true) if drive is erasable |
flags | String representation of flags |
free | Shorthand for total_free (Number of free bytes) |
free_pct | Shorthand for total_free_pct (% free space) |
hotplug | 1 (true) if drive is hotplugable |
id | Drive or id of drive |
mounted | Check if a drive is mounted |
name | Descriptive name of drive |
readable | 1 (true) if drive is readable |
removable | 1 (true) if drive is removable |
size | Total size of drive |
total_free | Number of free bytes |
total_free_pct | % free space |
total_used | Number of used bytes |
total_used_pct | % used space |
type | Type of drive |
used | Number of used bytes |
used_pct | Shorthand for total_used_pct (% used space) |
user_free | Free space available to user (which runs NSClient++) |
user_free_pct | % free space available to user |
user_used | Number of used bytes (related to user) |
user_used_pct | % used space available to user |
writable | 1 (true) if drive is writable |
debug
(CheckDisk, check_drivesize)¶show-all
(CheckDisk, check_drivesize)¶empty-state
(CheckDisk, check_drivesize)¶perf-config
(CheckDisk, check_drivesize)¶escape-html
(CheckDisk, check_drivesize)¶help
(CheckDisk, check_drivesize)¶help-pb
(CheckDisk, check_drivesize)¶show-default
(CheckDisk, check_drivesize)¶help-short
(CheckDisk, check_drivesize)¶top-syntax
(CheckDisk, check_drivesize)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
ok-syntax
(CheckDisk, check_drivesize)¶empty-syntax
(CheckDisk, check_drivesize)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
detail-syntax
(CheckDisk, check_drivesize)¶Key | Value |
drive | Technical name of drive |
drive_or_id | Drive letter if present if not use id |
drive_or_name | Drive letter if present if not use name |
erasable | 1 (true) if drive is erasable |
flags | String representation of flags |
free | Shorthand for total_free (Number of free bytes) |
free_pct | Shorthand for total_free_pct (% free space) |
hotplug | 1 (true) if drive is hotplugable |
id | Drive or id of drive |
mounted | Check if a drive is mounted |
name | Descriptive name of drive |
readable | 1 (true) if drive is readable |
removable | 1 (true) if drive is removable |
size | Total size of drive |
total_free | Number of free bytes |
total_free_pct | % free space |
total_used | Number of used bytes |
total_used_pct | % used space |
type | Type of drive |
used | Number of used bytes |
used_pct | Shorthand for total_used_pct (% used space) |
user_free | Free space available to user (which runs NSClient++) |
user_free_pct | % free space available to user |
user_used | Number of used bytes (related to user) |
user_used_pct | % used space available to user |
writable | 1 (true) if drive is writable |
perf-syntax
(CheckDisk, check_drivesize)¶Key | Value |
drive | Technical name of drive |
drive_or_id | Drive letter if present if not use id |
drive_or_name | Drive letter if present if not use name |
erasable | 1 (true) if drive is erasable |
flags | String representation of flags |
free | Shorthand for total_free (Number of free bytes) |
free_pct | Shorthand for total_free_pct (% free space) |
hotplug | 1 (true) if drive is hotplugable |
id | Drive or id of drive |
mounted | Check if a drive is mounted |
name | Descriptive name of drive |
readable | 1 (true) if drive is readable |
removable | 1 (true) if drive is removable |
size | Total size of drive |
total_free | Number of free bytes |
total_free_pct | % free space |
total_used | Number of used bytes |
total_used_pct | % used space |
type | Type of drive |
used | Number of used bytes |
used_pct | Shorthand for total_used_pct (% used space) |
user_free | Free space available to user (which runs NSClient++) |
user_free_pct | % free space available to user |
user_used | Number of used bytes (related to user) |
user_used_pct | % used space available to user |
writable | 1 (true) if drive is writable |
drive
(CheckDisk, check_drivesize)¶ignore-unreadable
(CheckDisk, check_drivesize)¶mounted
(CheckDisk, check_drivesize)¶magic
(CheckDisk, check_drivesize)¶exclude
(CheckDisk, check_drivesize)¶total
(CheckDisk, check_drivesize)¶check_files
¶CheckDisk
check_files
Usage:
Option | Default Value | Description |
---|---|---|
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. | |
debug |
N/A | Show debugging information in the log |
show-all |
N/A | Show details for all matches regardless of status (normally details are only showed for warnings and criticals). |
empty-state |
unknown | Return status to use when nothing matched filter. |
perf-config |
Performance data generation configuration | |
escape-html |
N/A | Escape any < and > characters to prevent HTML encoding |
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). |
top-syntax |
${status}: ${problem_count}/${count} files (${problem_list}) | Top level syntax. |
ok-syntax |
%(status): All %(count) files are ok | ok syntax. |
empty-syntax |
No files found | Empty syntax. |
detail-syntax |
${name} | Detail level syntax. |
perf-syntax |
${name} | Performance alias syntax. |
path |
The path to search for files under. | |
file |
Alias for path. | |
paths |
A comma separated list of paths to scan | |
pattern |
. | The pattern of files to search for (works like a filter but is faster and can be combined with a filter). |
max-depth |
Maximum depth to recurse | |
total |
filter | Include the total of either (filter) all files matching the filter or (all) all files regardless of the filter |
Order is somewhat important but mainly in the fact that some operations are more costly then others. For instance line_count requires us to read and count the lines in each file so choosing between the following: Fast version:
filter=creation < -2d and line_count > 100
Show version:
filter=line_count > 100 and creation < -2d
The first one will be significantly faster if you have a thousand old files and 3 new ones. But looking at the following:
filter=creation < -2d and size > 100k
Swapping them would not be noticeable.
Checking file versions:
check_files path=c:/foo/ pattern=*.exe "filter=version != '1.0'" "detail-syntax=%(filename): %(version)" "warn=count > 1" show-all
L cli WARNING: WARNING: 0/11 files (check_nrpe.exe: , nscp.exe: 0.5.0.16, reporter.exe: 0.5.0.16)
L cli Performance data: 'count'=11;1;0
Using the line count with limited recursion:
check_files path=c:/windows pattern=*.txt max-depth=1 "filter=line_count gt 100" "detail-syntax=%(filename): %(line_count)" "warn=count>0" show-all
L cli WARNING: WARNING: 0/1 files (AsChkDev.txt: 328)
L cli Performance data: 'count'=1;0;0
Check file sizes:
check_files path=c:/windows pattern=*.txt "detail-syntax=%(filename): %(size)" "warn=size>20k" max-depth=1
L cli WARNING: WARNING: 1/6 files (AsChkDev.txt: 29738)
L cli Performance data: 'AsChkDev.txt size'=29.04101KB;20;0 'AsDCDVer.txt size'=0.02246KB;20;0 'AsHDIVer.txt size'=0.02734KB;20;0 'AsPEToolVer.txt size'=0.08789KB;20;0 'AsToolCDVer.txt size'=0.05273KB;20;0 'csup.txt size'=0.00976KB;20;0
filter
(CheckDisk, check_files)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
access | Last access time |
access_l | Last access time (local time) |
access_u | Last access time (UTC) |
age | Seconds since file was last written |
creation | When file was created |
creation_l | When file was created (local time) |
creation_u | When file was created (UTC) |
file | The name of the file |
filename | The name of the file |
line_count | Number of lines in the file (text files) |
name | The name of the file |
path | Path of file |
size | File size |
total | True if this is the total object |
type | Type of item (file or dir) |
version | Windows exe/dll file version |
write | Alias for written |
written | When file was last written to |
written_l | When file was last written to (local time) |
written_u | When file was last written to (UTC) |
warning
(CheckDisk, check_files)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
access | Last access time |
access_l | Last access time (local time) |
access_u | Last access time (UTC) |
age | Seconds since file was last written |
creation | When file was created |
creation_l | When file was created (local time) |
creation_u | When file was created (UTC) |
file | The name of the file |
filename | The name of the file |
line_count | Number of lines in the file (text files) |
name | The name of the file |
path | Path of file |
size | File size |
total | True if this is the total object |
type | Type of item (file or dir) |
version | Windows exe/dll file version |
write | Alias for written |
written | When file was last written to |
written_l | When file was last written to (local time) |
written_u | When file was last written to (UTC) |
warn
(CheckDisk, check_files)¶critical
(CheckDisk, check_files)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
access | Last access time |
access_l | Last access time (local time) |
access_u | Last access time (UTC) |
age | Seconds since file was last written |
creation | When file was created |
creation_l | When file was created (local time) |
creation_u | When file was created (UTC) |
file | The name of the file |
filename | The name of the file |
line_count | Number of lines in the file (text files) |
name | The name of the file |
path | Path of file |
size | File size |
total | True if this is the total object |
type | Type of item (file or dir) |
version | Windows exe/dll file version |
write | Alias for written |
written | When file was last written to |
written_l | When file was last written to (local time) |
written_u | When file was last written to (UTC) |
crit
(CheckDisk, check_files)¶ok
(CheckDisk, check_files)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
access | Last access time |
access_l | Last access time (local time) |
access_u | Last access time (UTC) |
age | Seconds since file was last written |
creation | When file was created |
creation_l | When file was created (local time) |
creation_u | When file was created (UTC) |
file | The name of the file |
filename | The name of the file |
line_count | Number of lines in the file (text files) |
name | The name of the file |
path | Path of file |
size | File size |
total | True if this is the total object |
type | Type of item (file or dir) |
version | Windows exe/dll file version |
write | Alias for written |
written | When file was last written to |
written_l | When file was last written to (local time) |
written_u | When file was last written to (UTC) |
debug
(CheckDisk, check_files)¶show-all
(CheckDisk, check_files)¶empty-state
(CheckDisk, check_files)¶perf-config
(CheckDisk, check_files)¶escape-html
(CheckDisk, check_files)¶help
(CheckDisk, check_files)¶help-pb
(CheckDisk, check_files)¶show-default
(CheckDisk, check_files)¶help-short
(CheckDisk, check_files)¶top-syntax
(CheckDisk, check_files)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
ok-syntax
(CheckDisk, check_files)¶empty-syntax
(CheckDisk, check_files)¶Key | Value |
count | Number of items matching the filter. Common option for all checks. |
total | Total number of items. Common option for all checks. |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
detail-syntax
(CheckDisk, check_files)¶Key | Value |
access | Last access time |
access_l | Last access time (local time) |
access_u | Last access time (UTC) |
age | Seconds since file was last written |
creation | When file was created |
creation_l | When file was created (local time) |
creation_u | When file was created (UTC) |
file | The name of the file |
filename | The name of the file |
line_count | Number of lines in the file (text files) |
name | The name of the file |
path | Path of file |
size | File size |
total | True if this is the total object |
type | Type of item (file or dir) |
version | Windows exe/dll file version |
write | Alias for written |
written | When file was last written to |
written_l | When file was last written to (local time) |
written_u | When file was last written to (UTC) |
perf-syntax
(CheckDisk, check_files)¶Key | Value |
access | Last access time |
access_l | Last access time (local time) |
access_u | Last access time (UTC) |
age | Seconds since file was last written |
creation | When file was created |
creation_l | When file was created (local time) |
creation_u | When file was created (UTC) |
file | The name of the file |
filename | The name of the file |
line_count | Number of lines in the file (text files) |
name | The name of the file |
path | Path of file |
size | File size |
total | True if this is the total object |
type | Type of item (file or dir) |
version | Windows exe/dll file version |
write | Alias for written |
written | When file was last written to |
written_l | When file was last written to (local time) |
written_u | When file was last written to (UTC) |
path
(CheckDisk, check_files)¶file
(CheckDisk, check_files)¶paths
(CheckDisk, check_files)¶pattern
(CheckDisk, check_files)¶max-depth
(CheckDisk, check_files)¶total
(CheckDisk, check_files)¶checkdrivesize
¶CheckDisk
checkdrivesize
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). |
CheckAll |
true | Checks all drives. |
CheckAllOthers |
true | Checks all drives turns the drive option into an exclude option. |
Drive |
The drives to check | |
FilterType |
The type of drives to check fixed, remote, cdrom, ramdisk, removable | |
perf-unit |
Force performance data to use a given unit prevents scaling which can cause problems over time in some graphing solutions. | |
ShowAll |
short | Configures display format (if set shows all items not only failures, if set to long shows all cores). |
MaxWarn |
Maximum value before a warning is returned. | |
MaxCrit |
Maximum value before a critical is returned. | |
MinWarn |
Minimum value before a warning is returned. | |
MinCrit |
Minimum value before a critical is returned. | |
MaxWarnFree |
Maximum value before a warning is returned. | |
MaxCritFree |
Maximum value before a critical is returned. | |
MinWarnFree |
Minimum value before a warning is returned. | |
MinCritFree |
Minimum value before a critical is returned. | |
MaxWarnUsed |
Maximum value before a warning is returned. | |
MaxCritUsed |
Maximum value before a critical is returned. | |
MinWarnUsed |
Minimum value before a warning is returned. | |
MinCritUsed |
Minimum value before a critical is returned. |
help
(CheckDisk, checkdrivesize)¶help-pb
(CheckDisk, checkdrivesize)¶show-default
(CheckDisk, checkdrivesize)¶help-short
(CheckDisk, checkdrivesize)¶CheckAll
(CheckDisk, checkdrivesize)¶CheckAllOthers
(CheckDisk, checkdrivesize)¶Drive
(CheckDisk, checkdrivesize)¶FilterType
(CheckDisk, checkdrivesize)¶perf-unit
(CheckDisk, checkdrivesize)¶ShowAll
(CheckDisk, checkdrivesize)¶MaxWarn
(CheckDisk, checkdrivesize)¶MaxCrit
(CheckDisk, checkdrivesize)¶MinWarn
(CheckDisk, checkdrivesize)¶MinCrit
(CheckDisk, checkdrivesize)¶MaxWarnFree
(CheckDisk, checkdrivesize)¶MaxCritFree
(CheckDisk, checkdrivesize)¶MinWarnFree
(CheckDisk, checkdrivesize)¶MinCritFree
(CheckDisk, checkdrivesize)¶MaxWarnUsed
(CheckDisk, checkdrivesize)¶MaxCritUsed
(CheckDisk, checkdrivesize)¶MinWarnUsed
(CheckDisk, checkdrivesize)¶MinCritUsed
(CheckDisk, checkdrivesize)¶checkfiles
¶CheckDisk
checkfiles
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). |
syntax |
Syntax for individual items (detail-syntax). | |
master-syntax |
Syntax for top syntax (top-syntax). | |
path |
The file or path to check | |
pattern |
Deprecated and ignored | |
alias |
Deprecated and ignored | |
debug |
N/A | Debug |
max-dir-depth |
The maximum level to recurse | |
filter |
The filter to use when including files in the check | |
warn |
Deprecated and ignored | |
crit |
Deprecated and ignored | |
MaxWarn |
Maximum value before a warning is returned. | |
MaxCrit |
Maximum value before a critical is returned. | |
MinWarn |
Minimum value before a warning is returned. | |
MinCrit |
Minimum value before a critical is returned. |
help
(CheckDisk, checkfiles)¶help-pb
(CheckDisk, checkfiles)¶show-default
(CheckDisk, checkfiles)¶help-short
(CheckDisk, checkfiles)¶syntax
(CheckDisk, checkfiles)¶master-syntax
(CheckDisk, checkfiles)¶path
(CheckDisk, checkfiles)¶pattern
(CheckDisk, checkfiles)¶alias
(CheckDisk, checkfiles)¶debug
(CheckDisk, checkfiles)¶max-dir-depth
(CheckDisk, checkfiles)¶filter
(CheckDisk, checkfiles)¶warn
(CheckDisk, checkfiles)¶crit
(CheckDisk, checkfiles)¶MaxWarn
(CheckDisk, checkfiles)¶MaxCrit
(CheckDisk, checkfiles)¶MinWarn
(CheckDisk, checkfiles)¶MinCrit
(CheckDisk, checkfiles)¶