config/director/Invoke-IcingaCheckDiskHealth.json

{"DataList":{"IcingaCheckDiskHealth Verbosity":{"list_name":"IcingaCheckDiskHealth Verbosity","originalId":"2","entries":[{"allowed_roles":null,"entry_value":"0","entry_name":"0","format":"string"},{"allowed_roles":null,"entry_value":"1","entry_name":"1","format":"string"},{"allowed_roles":null,"entry_value":"2","entry_name":"2","format":"string"},{"allowed_roles":null,"entry_value":"3","entry_name":"3","format":"string"}],"owner":"stein"},"PowerShell ExecutionPolicies":{"list_name":"PowerShell ExecutionPolicies","originalId":"2","entries":[{"allowed_roles":null,"entry_value":"AllSigned","entry_name":"AllSigned","format":"string"},{"allowed_roles":null,"entry_value":"Bypass","entry_name":"Bypass","format":"string"},{"allowed_roles":null,"entry_value":"Default","entry_name":"Default","format":"string"},{"allowed_roles":null,"entry_value":"RemoteSigned","entry_name":"RemoteSigned","format":"string"},{"allowed_roles":null,"entry_value":"Restricted","entry_name":"Restricted","format":"string"},{"allowed_roles":null,"entry_value":"Undefined","entry_name":"Undefined","format":"string"},{"allowed_roles":null,"entry_value":"Unrestricted","entry_name":"Unrestricted","format":"string"}],"owner":"stein"}},"Command":{"Invoke-IcingaCheckDiskHealth":{"fields":[{"datafield_id":4,"is_required":"n","var_filter":null},{"datafield_id":5,"is_required":"n","var_filter":null},{"datafield_id":6,"is_required":"n","var_filter":null},{"datafield_id":7,"is_required":"n","var_filter":null},{"datafield_id":8,"is_required":"n","var_filter":null},{"datafield_id":9,"is_required":"n","var_filter":null},{"datafield_id":10,"is_required":"n","var_filter":null},{"datafield_id":11,"is_required":"n","var_filter":null},{"datafield_id":12,"is_required":"n","var_filter":null},{"datafield_id":13,"is_required":"n","var_filter":null},{"datafield_id":14,"is_required":"n","var_filter":null},{"datafield_id":15,"is_required":"n","var_filter":null},{"datafield_id":16,"is_required":"n","var_filter":null},{"datafield_id":17,"is_required":"n","var_filter":null},{"datafield_id":18,"is_required":"n","var_filter":null},{"datafield_id":19,"is_required":"n","var_filter":null},{"datafield_id":20,"is_required":"n","var_filter":null},{"datafield_id":21,"is_required":"n","var_filter":null},{"datafield_id":22,"is_required":"n","var_filter":null},{"datafield_id":23,"is_required":"n","var_filter":null},{"datafield_id":24,"is_required":"n","var_filter":null},{"datafield_id":25,"is_required":"n","var_filter":null},{"datafield_id":26,"is_required":"n","var_filter":null},{"datafield_id":27,"is_required":"n","var_filter":null},{"datafield_id":28,"is_required":"n","var_filter":null},{"datafield_id":29,"is_required":"n","var_filter":null},{"datafield_id":30,"is_required":"n","var_filter":null},{"datafield_id":31,"is_required":"n","var_filter":null}],"object_name":"Invoke-IcingaCheckDiskHealth","arguments":{"-DiskReadByteSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskReadByteSecWarning$","order":"14"},"-C":{"value":"try { Use-Icinga -Minimal; } catch { Write-Output \u0027The Icinga PowerShell Framework is either not installed on the system or not configured properly. Please check https://icinga.com/docs/windows for further details\u0027; Write-Output \u0027Error:\u0027 $$($$_.Exception.Message)Components:`r`n$$( Get-Module -ListAvailable \u0027icinga-powershell-*\u0027 )`r`n\u0027Module-Path:\u0027`r`n$$($$Env:PSModulePath); exit 3; }; Exit-IcingaExecutePlugin -Command \u0027Invoke-IcingaCheckDiskHealth\u0027 ","order":"0"},"-DiskWriteByteSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskWriteByteSecWarning$","order":"16"},"-NoPerfData":{"set_if":"$IcingaCheckDiskHealth_Switchparameter_NoPerfData$","set_if_format":"string","order":"99"},"-ExcludeDisk":{"value":{"body":"var arr = macro(\"$IcingaCheckDiskHealth_Array_ExcludeDisk$\");\r\n if (len(arr) == 0) {\r\n return \"@()\";\r\n }\r\n return arr.map(\r\n x =\u003e if (typeof(x) == String) {\r\n var argLen = len(x);\r\n if (argLen != 0 \u0026\u0026 x.substr(0,1) == \"\u0027\" \u0026\u0026 x.substr(argLen - 1, argLen) == \"\u0027\") {\r\n x;\r\n } else {\r\n \"\u0027\" + x + \"\u0027\";\r\n }\r\n } else {\r\n x;\r\n }\r\n ).join(\",\");","type":"Function"},"order":"3"},"-ThresholdInterval":{"value":"$IcingaCheckDiskHealth_String_ThresholdInterval$","order":"100"},"-DiskQueueAvgLenWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskQueueAvgLenWarning$","order":"12"},"-IncludeDisk":{"value":{"body":"var arr = macro(\"$IcingaCheckDiskHealth_Array_IncludeDisk$\");\r\n if (len(arr) == 0) {\r\n return \"@()\";\r\n }\r\n return arr.map(\r\n x =\u003e if (typeof(x) == String) {\r\n var argLen = len(x);\r\n if (argLen != 0 \u0026\u0026 x.substr(0,1) == \"\u0027\" \u0026\u0026 x.substr(argLen - 1, argLen) == \"\u0027\") {\r\n x;\r\n } else {\r\n \"\u0027\" + x + \"\u0027\";\r\n }\r\n } else {\r\n x;\r\n }\r\n ).join(\",\");","type":"Function"},"order":"2"},"-DiskQueueAvgLenCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskQueueAvgLenCritical$","order":"13"},"-DiskQueueLenWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskQueueLenWarning$","order":"10"},"-IncludePartition":{"value":{"body":"var arr = macro(\"$IcingaCheckDiskHealth_Array_IncludePartition$\");\r\n if (len(arr) == 0) {\r\n return \"@()\";\r\n }\r\n return arr.map(\r\n x =\u003e if (typeof(x) == String) {\r\n var argLen = len(x);\r\n if (argLen != 0 \u0026\u0026 x.substr(0,1) == \"\u0027\" \u0026\u0026 x.substr(argLen - 1, argLen) == \"\u0027\") {\r\n x;\r\n } else {\r\n \"\u0027\" + x + \"\u0027\";\r\n }\r\n } else {\r\n x;\r\n }\r\n ).join(\",\");","type":"Function"},"order":"4"},"-DiskAvgReadSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskAvgReadSecCritical$","order":"21"},"-DiskWriteSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskWriteSecCritical$","order":"9"},"-IgnoreReadOnlyDisks":{"set_if":"$IcingaCheckDiskHealth_Switchparameter_IgnoreReadOnlyDisks$","set_if_format":"string","order":"99"},"-DiskAvgReadSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskAvgReadSecWarning$","order":"20"},"-DiskWriteByteSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskWriteByteSecCritical$","order":"17"},"-DiskAvgTransSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskAvgTransSecWarning$","order":"18"},"-DiskAvgWriteSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskAvgWriteSecWarning$","order":"22"},"-Verbosity":{"value":"$IcingaCheckDiskHealth_Int32_Verbosity$","order":"24"},"-DiskReadSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskReadSecWarning$","order":"6"},"-ExcludePartition":{"value":{"body":"var arr = macro(\"$IcingaCheckDiskHealth_Array_ExcludePartition$\");\r\n if (len(arr) == 0) {\r\n return \"@()\";\r\n }\r\n return arr.map(\r\n x =\u003e if (typeof(x) == String) {\r\n var argLen = len(x);\r\n if (argLen != 0 \u0026\u0026 x.substr(0,1) == \"\u0027\" \u0026\u0026 x.substr(argLen - 1, argLen) == \"\u0027\") {\r\n x;\r\n } else {\r\n \"\u0027\" + x + \"\u0027\";\r\n }\r\n } else {\r\n x;\r\n }\r\n ).join(\",\");","type":"Function"},"order":"5"},"-DiskReadSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskReadSecCritical$","order":"7"},"-CheckLogicalOnly":{"set_if":"$IcingaCheckDiskHealth_Switchparameter_CheckLogicalOnly$","set_if_format":"string","order":"99"},"-DiskReadByteSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskReadByteSecCritical$","order":"15"},"-DiskAvgWriteSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskAvgWriteSecCritical$","order":"23"},"-IgnoreOfflineDisks":{"set_if":"$IcingaCheckDiskHealth_Switchparameter_IgnoreOfflineDisks$","set_if_format":"string","order":"99"},"-DiskWriteSecWarning":{"value":"$IcingaCheckDiskHealth_Object_DiskWriteSecWarning$","order":"8"},"-DiskQueueLenCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskQueueLenCritical$","order":"11"},"-DiskAvgTransSecCritical":{"value":"$IcingaCheckDiskHealth_Object_DiskAvgTransSecCritical$","order":"19"}},"imports":["PowerShell Base"],"object_type":"object","vars":{"IcingaCheckDiskHealth_Switchparameter_IgnoreReadOnlyDisks":false,"IcingaCheckDiskHealth_Switchparameter_IgnoreOfflineDisks":false,"IcingaCheckDiskHealth_Switchparameter_NoPerfData":false,"IcingaCheckDiskHealth_Switchparameter_CheckLogicalOnly":false}},"PowerShell Base":{"methods_execute":"PluginCheck","object_name":"PowerShell Base","vars":{"IcingaPowerShellBase_String_ExecutionPolicy":"ByPass"},"is_string":null,"command":"C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe","zone":null,"disabled":false,"fields":[{"datafield_id":2,"is_required":"n","var_filter":null}],"arguments":{"-ExecutionPolicy":{"value":"$IcingaPowerShellBase_String_ExecutionPolicy$","order":"-1"},"-NoProfile":{"set_if":true,"order":"-3"},"-NoLogo":{"set_if":true,"order":"-2"}},"imports":[],"object_type":"object","timeout":"180"}},"Datafield":{"11":{"settings":{"visibility":"visible"},"description":"Warning threshold for disk Writes/sec is the rate of write operations on the disk.","caption":"DiskWriteSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"11","varname":"IcingaCheckDiskHealth_Object_DiskWriteSecWarning","format":null},"7":{"settings":{"visibility":"visible"},"description":"Specify the partition drive letters for disks to include for checks. Example C:, D:","caption":"IncludePartition","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"7","varname":"IcingaCheckDiskHealth_Array_IncludePartition","format":null},"20":{"settings":{"visibility":"visible"},"description":"Critical threshold for disk Write Bytes/sec is rate at which bytes are transferred to the disk during write operations.","caption":"DiskWriteByteSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"20","varname":"IcingaCheckDiskHealth_Object_DiskWriteByteSecCritical","format":null},"12":{"settings":{"visibility":"visible"},"description":"Critical threshold for disk Writes/sec is the rate of write operations on the disk.","caption":"DiskWriteSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"12","varname":"IcingaCheckDiskHealth_Object_DiskWriteSecCritical","format":null},"10":{"settings":{"visibility":"visible"},"description":"Critical threshold for disk Reads/sec is the rate of read operations on the disk.","caption":"DiskReadSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"10","varname":"IcingaCheckDiskHealth_Object_DiskReadSecCritical","format":null},"17":{"settings":{"visibility":"visible"},"description":"Warning threshold for disk Read Bytes/sec is the rate at which bytes are transferred from the disk during read operations.","caption":"DiskReadByteSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"17","varname":"IcingaCheckDiskHealth_Object_DiskReadByteSecWarning","format":null},"13":{"settings":{"visibility":"visible"},"description":"Warning threshold for current Disk Queue Length is the number of requests outstanding on the disk at the time the performance data is collected.\nIt also includes requests in service at the time of the collection. This is a instantaneous snapshot, not an average over the\ntime interval. Multi-spindle disk devices can have multiple requests that are active at one time, but other concurrent requests\nare awaiting service. This counter might reflect a transitory high or low queue length, but if there is a sustained load on the\ndisk drive, it is likely that this will be consistently high. Requests experience delays proportional to the length of this queue\nminus the number of spindles on the disks. For good performance, this difference should average less than two.","caption":"DiskQueueLenWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"13","varname":"IcingaCheckDiskHealth_Object_DiskQueueLenWarning","format":null},"27":{"settings":{"visibility":"visible"},"description":"Ignores any disk which is having the state `Offline` and returns `Ok` instead of `Warning` for this specific state","caption":"IgnoreOfflineDisks","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"27","varname":"IcingaCheckDiskHealth_Switchparameter_IgnoreOfflineDisks","format":null},"30":{"settings":{"visibility":"visible"},"description":null,"caption":"NoPerfData","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"30","varname":"IcingaCheckDiskHealth_Switchparameter_NoPerfData","format":null},"18":{"settings":{"visibility":"visible"},"description":"Critical threshold for disk Read Bytes/sec is the rate at which bytes are transferred from the disk during read operations.","caption":"DiskReadByteSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"18","varname":"IcingaCheckDiskHealth_Object_DiskReadByteSecCritical","format":null},"29":{"settings":{"visibility":"visible"},"description":"Set this to include only disks that have drive letters like C:, D:, ..., assigned to them. Can be combined with include/exclude filters","caption":"CheckLogicalOnly","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"29","varname":"IcingaCheckDiskHealth_Switchparameter_CheckLogicalOnly","format":null},"23":{"settings":{"visibility":"visible"},"description":"Warning threshold for avg. Disk sec/Read is the average time, in seconds, of a read of data from the disk. If the threshold values are not in seconds, please enter a unit such as (ms, s, m, h, ...)","caption":"DiskAvgReadSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"23","varname":"IcingaCheckDiskHealth_Object_DiskAvgReadSecWarning","format":null},"19":{"settings":{"visibility":"visible"},"description":"Warning threshold for disk Write Bytes/sec is rate at which bytes are transferred to the disk during write operations.","caption":"DiskWriteByteSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"19","varname":"IcingaCheckDiskHealth_Object_DiskWriteByteSecWarning","format":null},"5":{"settings":{"visibility":"visible"},"description":"Specify the index id of disks you want to include for checks. Example 0, 1","caption":"IncludeDisk","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"5","varname":"IcingaCheckDiskHealth_Array_IncludeDisk","format":null},"4":{"settings":{"visibility":"visible"},"description":"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: https://icinga.com/docs/icinga-for-windows/latest/doc/service/10-Register-Service-Checks/ An example for this argument would be 1m or 15m which will use the average of 1m or 15m for monitoring.","caption":"ThresholdInterval","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"4","varname":"IcingaCheckDiskHealth_String_ThresholdInterval","format":null},"26":{"settings":{"visibility":"visible"},"description":"Critical threshold for Avg. Disk sec/Write is the average time, in seconds, of a write of data to the disk. If the threshold values are not in seconds, please enter a unit such as (ms, s, m, h, ...)","caption":"DiskAvgWriteSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"26","varname":"IcingaCheckDiskHealth_Object_DiskAvgWriteSecCritical","format":null},"14":{"settings":{"visibility":"visible"},"description":"Critical threshold for current Disk Queue Length is the number of requests outstanding on the disk at the time the performance data is collected.\nIt also includes requests in service at the time of the collection. This is a instantaneous snapshot, not an average over the\ntime interval. Multi-spindle disk devices can have multiple requests that are active at one time, but other concurrent requests\nare awaiting service. This counter might reflect a transitory high or low queue length, but if there is a sustained load on the\ndisk drive, it is likely that this will be consistently high. Requests experience delays proportional to the length of this queue\nminus the number of spindles on the disks. For good performance, this difference should average less than two.","caption":"DiskQueueLenCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"14","varname":"IcingaCheckDiskHealth_Object_DiskQueueLenCritical","format":null},"22":{"settings":{"visibility":"visible"},"description":"Critical threshold for avg. Disk sec/Transfer is the time, in seconds, of the average disk transfer. If the threshold values are not in seconds, please enter a unit such as (ms, s, m, h, ...)","caption":"DiskAvgTransSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"22","varname":"IcingaCheckDiskHealth_Object_DiskAvgTransSecCritical","format":null},"28":{"settings":{"visibility":"visible"},"description":"Ignores any disk which is having the state `Read Only` and returns `Ok` instead of `Warning` for this specific state","caption":"IgnoreReadOnlyDisks","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"28","varname":"IcingaCheckDiskHealth_Switchparameter_IgnoreReadOnlyDisks","format":null},"25":{"settings":{"visibility":"visible"},"description":"Warning threshold for Avg. Disk sec/Write is the average time, in seconds, of a write of data to the disk. If the threshold values are not in seconds, please enter a unit such as (ms, s, m, h, ...)","caption":"DiskAvgWriteSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"25","varname":"IcingaCheckDiskHealth_Object_DiskAvgWriteSecWarning","format":null},"9":{"settings":{"visibility":"visible"},"description":"Warning threshold for disk Reads/sec is the rate of read operations on the disk.","caption":"DiskReadSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"9","varname":"IcingaCheckDiskHealth_Object_DiskReadSecWarning","format":null},"15":{"settings":{"visibility":"visible"},"description":"Warning threshold for Avg. Disk Queue Length is the average number of both read and write requests that were queued for the selected disk during the sample interval.","caption":"DiskQueueAvgLenWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"15","varname":"IcingaCheckDiskHealth_Object_DiskQueueAvgLenWarning","format":null},"21":{"settings":{"visibility":"visible"},"description":"Warning threshold for avg. Disk sec/Transfer is the time, in seconds, of the average disk transfer. If the threshold values are not in seconds, please enter a unit such as (ms, s, m, h, ...)","caption":"DiskAvgTransSecWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"21","varname":"IcingaCheckDiskHealth_Object_DiskAvgTransSecWarning","format":null},"24":{"settings":{"visibility":"visible"},"description":"Critical threshold for avg. Disk sec/Read is the average time, in seconds, of a read of data from the disk. If the threshold values are not in seconds, please enter a unit such as (ms, s, m, h, ...)","caption":"DiskAvgReadSecCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"24","varname":"IcingaCheckDiskHealth_Object_DiskAvgReadSecCritical","format":null},"16":{"settings":{"visibility":"visible"},"description":"Critical threshold for Avg. Disk Queue Length is the average number of both read and write requests that were queued for the selected disk during the sample interval.","caption":"DiskQueueAvgLenCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"16","varname":"IcingaCheckDiskHealth_Object_DiskQueueAvgLenCritical","format":null},"8":{"settings":{"visibility":"visible"},"description":"Specify the partition drive letters for disks to exclude from checks. Example C:, D:","caption":"ExcludePartition","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"8","varname":"IcingaCheckDiskHealth_Array_ExcludePartition","format":null},"2":{"settings":{"datalist":"PowerShell ExecutionPolicies","behavior":"strict","data_type":"string"},"description":"Defines with which Execution Policy the PowerShell is started","caption":"PowerShell Execution Policy","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeDatalist","originalId":"2","varname":"IcingaPowerShellBase_String_ExecutionPolicy","format":null},"6":{"settings":{"visibility":"visible"},"description":"Specify the index id of disks you want to exclude from checks. Example 0, 1","caption":"ExcludeDisk","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"6","varname":"IcingaCheckDiskHealth_Array_ExcludeDisk","format":null},"31":{"settings":{"datalist":"IcingaCheckDiskHealth Verbosity","behavior":"strict","data_type":"string"},"description":"Changes the behavior of the plugin output which check states are printed:\n0 (default): Only service checks/packages with state not OK will be printed\n1: Only services with not OK will be printed including OK checks of affected check packages including Package config\n2: Everything will be printed regardless of the check state\n3: Identical to Verbose 2, but prints in addition the check package configuration e.g (All must be [OK])","caption":"Verbosity","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeDatalist","originalId":"31","varname":"IcingaCheckDiskHealth_Int32_Verbosity","format":null}}}