Invoke-IcingaCheckScheduledTask¶
Description¶
Checks the current state for a list of specified tasks based on their name and prints the result
Check for a list of tasks by their name and compare their current state with a plugin argument to determine the plugin output. States of tasks not matching the plugin argument will return [CRITICAL], while all other tasks will return [OK]. For not found tasks we will return [UNKNOWN] More Information on https://github.com/Icinga/icinga-powershell-plugins
Permissions¶
No special permissions required.
Arguments¶
Argument | Type | Required | Default | Description |
---|---|---|---|---|
TaskName | Array | false | @() | A list of tasks to check for. If your tasks contain spaces, wrap them around a ‘ to ensure they are properly handled as string |
State | Array | false | @() | The state a task should currently have for the plugin to return [OK] |
IgnoreExitCodes | Array | false | @() | A list of exit codes which will be considered as [OK]. By default every task which did not exit with 0 will be handled as critical. |
WarningMissedRuns | Object | false | Defines a warning threshold for missed runs for filtered tasks. Supports Icinga default threshold syntax. |
|
CriticalMissedRuns | Object | false | Defines a critical threshold for missed runs for filtered tasks. Supports Icinga default threshold syntax. |
|
WarningLastRunTime | String | false | Allows to specify a time interval, on which the check will return warning based on the last run time of a task and the current time. The value will be subtracted from the current time Values have to be specified as time units like, -10m, -1d, -1w, -2M, -1y |
|
CriticalLastRunTime | String | false | Allows to specify a time interval, on which the check will return critical based on the last run time of a task and the current time. The value will be subtracted from the current time Values have to be specified as time units like, -10m, -1d, -1w, -2M, -1y |
|
WarningNextRunTime | String | false | Allows to specify a time interval, on which the check will return warning based on the next run time of a task and the current time. The value will be added to the current time Values have to be specified as time units like, 10m, 1d, 1w, 2M, 1y |
|
CriticalNextRunTime | String | false | Allows to specify a time interval, on which the check will return critical based on the next run time of a task and the current time. The value will be added to the current time Values have to be specified as time units like, 10m, 1d, 1w, 2M, 1y |
|
IgnoreLastRunTime | SwitchParameter | false | False | By default every task which did not exit with 0 will be handled as critical. If you set this flag, the exit code of the task is ignored during check execution |
NoPerfData | SwitchParameter | false | False | Set this argument to not write any performance data |
Verbosity | Int32 | false | 0 | Changes the behavior of the plugin output which check states are printed: 0 (default): Only service checks/packages with state not OK will be printed 1: Only services with not OK will be printed including OK checks of affected check packages including Package config 2: Everything will be printed regardless of the check state 3: Identical to Verbose 2, but prints in addition the check package configuration e.g (All must be [OK]) |
ThresholdInterval | String | Change the value your defined threshold checks against from the current value to a collected time threshold of the Icinga for Windows daemon, as described here. An example for this argument would be 1m or 15m which will use the average of 1m or 15m for monitoring. |
Examples¶
Example Command 1¶
Invoke-IcingaCheckScheduledTask -TaskName 'AutomaticBackup', 'Windows Backup Monitor' -State 'Ready';
Example Output 1¶
[OK] Check package "Scheduled Tasks"
| 'automaticbackup_microsoftwindowswindowsbackup'=Ready;;Ready 'windows_backup_monitor_microsoftwindowswindowsbackup'=Ready;;Ready
Example Command 2¶
Invoke-IcingaCheckScheduledTask -TaskName 'AutomaticBackup', 'Windows Backup Monitor' -State 'Disabled';
Example Output 2¶
[CRITICAL] Check package "Scheduled Tasks" - [CRITICAL] AutomaticBackup (\Microsoft\Windows\WindowsBackup\), Windows Backup Monitor (\Microsoft\Windows\WindowsBackup\)
\_ [CRITICAL] Check package "\Microsoft\Windows\WindowsBackup\"
\_ [CRITICAL] AutomaticBackup (\Microsoft\Windows\WindowsBackup\): Value "Ready" is not matching threshold "Disabled"
\_ [CRITICAL] Windows Backup Monitor (\Microsoft\Windows\WindowsBackup\): Value "Ready" is not matching threshold "Disabled"
| 'automaticbackup_microsoftwindowswindowsbackup'=Ready;;Disabled 'windows_backup_monitor_microsoftwindowswindowsbackup'=Ready;;Disabled