Merge pull request #140 from Icinga:feature/check_plugin_for_unc_path_monitoring

Adds new plugin Invoke-IcingaCheckUNCPath

Adds new plugin `Invoke-IcingaCheckUNCPath` to test for network share paths or other volumes to fetch the size and free space from them.

Author: LordHepipud

config/director/Invoke-IcingaCheckUNCPath.json

@@ -0,0 +1 @@
+{"DataList":{"IcingaCheckUNCPath Verbosity":{"list_name":"IcingaCheckUNCPath 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"}],"owner":"stein"}},"Command":{"PowerShell Base":{"methods_execute":"PluginCheck","object_name":"PowerShell Base","vars":{},"is_string":null,"command":"C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe","zone":null,"disabled":false,"fields":[],"arguments":{},"imports":[],"object_type":"object","timeout":"180"},"Invoke-IcingaCheckUNCPath":{"fields":[{"datafield_id":2,"is_required":"n","var_filter":null},{"datafield_id":3,"is_required":"n","var_filter":null},{"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}],"object_name":"Invoke-IcingaCheckUNCPath","arguments":{"-C":{"value":"try { Use-Icinga; } 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; exit 3; }; Exit-IcingaPluginNotInstalled \u0027Invoke-IcingaCheckUNCPath\u0027; exit Invoke-IcingaCheckUNCPath","order":"0"},"-Path":{"value":"$IcingaCheckUNCPath_String_Path$","order":"2"},"-Warning":{"value":"$IcingaCheckUNCPath_Object_Warning$","order":"4"},"-Verbosity":{"value":"$IcingaCheckUNCPath_Object_Verbosity$","order":"8"},"-CriticalTotal":{"value":"$IcingaCheckUNCPath_Object_CriticalTotal$","order":"7"},"-WarningTotal":{"value":"$IcingaCheckUNCPath_Object_WarningTotal$","order":"6"},"-Critical":{"value":"$IcingaCheckUNCPath_Object_Critical$","order":"5"},"-NoPerfData":{"set_if":"$IcingaCheckUNCPath_Switchparameter_NoPerfData$","set_if_format":"string","order":"99"},"-DisplayAlias":{"value":"$IcingaCheckUNCPath_String_DisplayAlias$","order":"3"}},"imports":["PowerShell Base"],"object_type":"object","vars":{"IcingaCheckUNCPath_Switchparameter_NoPerfData":false}}},"Datafield":{"7":{"settings":{"visbility":"visible"},"description":"A warning threshold for the shares total free space in byte units, like \"50GB:\"\nPlease note that this value is decreasing over time, therefor you will have to use the plugin handler and add \":\" at the end\nof your input to check for \"current value \u003c threshold\" like in the previous example\n\nAllowed units: B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB","caption":"CriticalTotal","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"7","varname":"IcingaCheckUNCPath_Object_CriticalTotal","format":null},"9":{"settings":{"datalist":"IcingaCheckUNCPath 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","caption":"Verbosity","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeDatalist","originalId":"9","varname":"IcingaCheckUNCPath_Object_Verbosity","format":null},"3":{"settings":{"visbility":"visible"},"description":"Modifies the plugin output to not display the value provided within the `-Path` argument but to use this string value\ninstead of shorten the output and make it more visual appealing.","caption":"DisplayAlias","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"3","varname":"IcingaCheckUNCPath_String_DisplayAlias","format":null},"2":{"settings":{"visbility":"visible"},"description":"The path to a volume or network share you want to monitor, like \"\\\\example.com\\Home\" or \"C:\\ClusterSharedVolume\\Volume1\"","caption":"Path","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"2","varname":"IcingaCheckUNCPath_String_Path","format":null},"4":{"settings":{"visbility":"visible"},"description":"A warning threshold for the shares free space in either % or byte units, like \"20%:\" or \"50GB:\"\nPlease note that this value is decreasing over time, therefor you will have to use the plugin handler and add \":\" at the end\nof your input to check for \"current value \u003c threshold\" like in the previous example\n\nAllowed units: %, B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB","caption":"Warning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"4","varname":"IcingaCheckUNCPath_Object_Warning","format":null},"6":{"settings":{"visbility":"visible"},"description":"A warning threshold for the shares total free space in byte units, like \"50GB:\"\nPlease note that this value is decreasing over time, therefor you will have to use the plugin handler and add \":\" at the end\nof your input to check for \"current value \u003c threshold\" like in the previous example\n\nAllowed units: B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB","caption":"WarningTotal","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"6","varname":"IcingaCheckUNCPath_Object_WarningTotal","format":null},"5":{"settings":{"visbility":"visible"},"description":"A critical threshold for the shares free space in either % or byte units, like \"20%:\" or \"50GB:\"\nPlease note that this value is decreasing over time, therefor you will have to use the plugin handler and add \":\" at the end\nof your input to check for \"current value \u003c threshold\" like in the previous example\n\nAllowed units: %, B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB","caption":"Critical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"5","varname":"IcingaCheckUNCPath_Object_Critical","format":null},"8":{"settings":{"visbility":"visible"},"description":"Disables the performance data output of this plugin. Default to FALSE.","caption":"NoPerfData","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"8","varname":"IcingaCheckUNCPath_Switchparameter_NoPerfData","format":null}}}

config/director/Plugins_Bundle.json

@@ -0,0 +1,50 @@
+object CheckCommand "Invoke-IcingaCheckUNCPath" {
+    import "PowerShell Base"
+
+    arguments += {
+        "-C" = {
+            value = "try { Use-Icinga; } catch { Write-Output 'The Icinga PowerShell Framework is either not installed on the system or not configured properly. Please check https://icinga.com/docs/windows for further details'; exit 3; }; Exit-IcingaPluginNotInstalled 'Invoke-IcingaCheckUNCPath'; exit Invoke-IcingaCheckUNCPath"
+            order = 0
+        }
+        "-Path" = {
+            description = "The path to a volume or network share you want to monitor, like '\\\\example.com\\Home' or 'C:\\ClusterSharedVolume\\Volume1'"
+            value = "$IcingaCheckUNCPath_String_Path$"
+            order = 2
+        }
+        "-Warning" = {
+            description = "A warning threshold for the shares free space in either % or byte units, like '20%:' or '50GB:' Please note that this value is decreasing over time, therefor you will have to use the plugin handler and add ':' at the end of your input to check for 'current value < threshold' like in the previous example  Allowed units: %, B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB"
+            value = "$IcingaCheckUNCPath_Object_Warning$"
+            order = 4
+        }
+        "-Verbosity" = {
+            description = "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"
+            value = "$IcingaCheckUNCPath_Object_Verbosity$"
+            order = 8
+        }
+        "-CriticalTotal" = {
+            description = "A warning threshold for the shares total free space in byte units, like '50GB:' Please note that this value is decreasing over time, therefor you will have to use the plugin handler and add ':' at the end of your input to check for 'current value < threshold' like in the previous example  Allowed units: B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB"
+            value = "$IcingaCheckUNCPath_Object_CriticalTotal$"
+            order = 7
+        }
+        "-WarningTotal" = {
+            description = "A warning threshold for the shares free space in either % or byte units, like '20%:' or '50GB:' Please note that this value is decreasing over time, therefor you will have to use the plugin handler and add ':' at the end of your input to check for 'current value < threshold' like in the previous example  Allowed units: %, B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB"
+            value = "$IcingaCheckUNCPath_Object_WarningTotal$"
+            order = 6
+        }
+        "-Critical" = {
+            description = "A critical threshold for the shares free space in either % or byte units, like '20%:' or '50GB:' Please note that this value is decreasing over time, therefor you will have to use the plugin handler and add ':' at the end of your input to check for 'current value < threshold' like in the previous example  Allowed units: %, B, KB, MB, GB, TB, PB, KiB, MiB, GiB, TiB, PiB"
+            value = "$IcingaCheckUNCPath_Object_Critical$"
+            order = 5
+        }
+        "-NoPerfData" = {
+            set_if = "$IcingaCheckUNCPath_Switchparameter_NoPerfData$"
+            order = 99
+        }
+        "-DisplayAlias" = {
+            description = "Modifies the plugin output to not display the value provided within the `-Path` argument but to use this string value instead of shorten the output and make it more visual appealing."
+            value = "$IcingaCheckUNCPath_String_DisplayAlias$"
+            order = 3
+        }
+    }
+    vars.IcingaCheckUNCPath_Switchparameter_NoPerfData = false
+}