config/director/Invoke-IcingaCheckHTTPStatus.json

{"DataList":{"IcingaCheckHTTPStatus Verbosity":{"list_name":"IcingaCheckHTTPStatus 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-IcingaCheckHTTPStatus":{"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}],"object_name":"Invoke-IcingaCheckHTTPStatus","arguments":{"-StatusCode":{"value":{"body":"var arr = macro(\"$IcingaCheckHTTPStatus_Array_StatusCode$\");\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":"14"},"-NoPerfData":{"set_if":"$IcingaCheckHTTPStatus_Switchparameter_NoPerfData$","set_if_format":"string","order":"99"},"-Verbosity":{"value":"$IcingaCheckHTTPStatus_Int32_Verbosity$","order":"16"},"-Content":{"value":{"body":"var arr = macro(\"$IcingaCheckHTTPStatus_Array_Content$\");\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":"13"},"-ProxyUsername":{"value":"$IcingaCheckHTTPStatus_String_ProxyUsername$","order":"10"},"-Username":{"value":"$IcingaCheckHTTPStatus_String_Username$","order":"8"},"-AddOutputContent":{"set_if":"$IcingaCheckHTTPStatus_Switchparameter_AddOutputContent$","set_if_format":"string","order":"99"},"-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-IcingaCheckHTTPStatus\u0027 ","order":"0"},"-ThresholdInterval":{"value":"$IcingaCheckHTTPStatus_String_ThresholdInterval$","order":"100"},"-Negate":{"set_if":"$IcingaCheckHTTPStatus_Switchparameter_Negate$","set_if_format":"string","order":"99"},"-Password":{"value":"(ConvertTo-IcingaSecureString \u0027$IcingaCheckHTTPStatus_Securestring_Password$\u0027)","order":"9"},"-Warning":{"value":"$IcingaCheckHTTPStatus_Object_Warning$","order":"2"},"-ProxyServer":{"value":"$IcingaCheckHTTPStatus_String_ProxyServer$","order":"12"},"-ProxyPassword":{"value":"(ConvertTo-IcingaSecureString \u0027$IcingaCheckHTTPStatus_Securestring_ProxyPassword$\u0027)","order":"11"},"-Minimum":{"value":"$IcingaCheckHTTPStatus_Int32_Minimum$","order":"15"},"-VHost":{"value":"$IcingaCheckHTTPStatus_String_VHost$","order":"5"},"-Critical":{"value":"$IcingaCheckHTTPStatus_Object_Critical$","order":"3"},"-Headers":{"value":{"body":"var arr = macro(\"$IcingaCheckHTTPStatus_Array_Headers$\");\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":"6"},"-Timeout":{"value":"$IcingaCheckHTTPStatus_Int32_Timeout$","order":"7"},"-Url":{"value":{"body":"var arr = macro(\"$IcingaCheckHTTPStatus_Array_Url$\");\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"}},"imports":["PowerShell Base"],"object_type":"object","vars":{"IcingaCheckHTTPStatus_Switchparameter_Negate":false,"IcingaCheckHTTPStatus_Switchparameter_NoPerfData":false,"IcingaCheckHTTPStatus_Switchparameter_AddOutputContent":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":{"16":{"settings":{"visibility":"visible"},"description":"Used to specify an array of regex-match-strings to match against the content of the webrequest response.","caption":"Content","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"16","varname":"IcingaCheckHTTPStatus_Array_Content","format":null},"7":{"settings":{"visibility":"visible"},"description":"Used to specify the URL of the host to check http as string. Use \u0027http://\u0027 or \u0027https://\u0027 to actively chose a protocol. Likewise \u0027:80\u0027 or any other port number to specify a port, etc.","caption":"Url","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"7","varname":"IcingaCheckHTTPStatus_Array_Url","format":null},"5":{"settings":{"visibility":"visible"},"description":"Used to specify the webrequest response time warning threshold in seconds, everything past that threshold is considered a WARNING.","caption":"Warning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"5","varname":"IcingaCheckHTTPStatus_Object_Warning","format":null},"21":{"settings":{"visibility":"visible"},"description":"Used to disable PerfData.","caption":"NoPerfData","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"21","varname":"IcingaCheckHTTPStatus_Switchparameter_NoPerfData","format":null},"18":{"settings":{"visibility":"visible"},"description":null,"caption":"Minimum","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeNumber","originalId":"18","varname":"IcingaCheckHTTPStatus_Int32_Minimum","format":null},"12":{"settings":{"visibility":"hidden"},"description":"Used to specify a password as securestring to authenticate with. Authentication is only possible with \u0027https://\u0027.Use with: -Username","caption":"Password","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"12","varname":"IcingaCheckHTTPStatus_Securestring_Password","format":null},"10":{"settings":{"visibility":"visible"},"description":"Used to specify the timeout in seconds of the webrequest as integer. The default is 10 for 10 seconds.","caption":"Timeout","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeNumber","originalId":"10","varname":"IcingaCheckHTTPStatus_Int32_Timeout","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},"22":{"settings":{"datalist":"IcingaCheckHTTPStatus 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":"22","varname":"IcingaCheckHTTPStatus_Int32_Verbosity","format":null},"8":{"settings":{"visibility":"visible"},"description":"Used to specify a VHost as string.","caption":"VHost","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"8","varname":"IcingaCheckHTTPStatus_String_VHost","format":null},"17":{"settings":{"visibility":"visible"},"description":null,"caption":"StatusCode","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"17","varname":"IcingaCheckHTTPStatus_Array_StatusCode","format":null},"11":{"settings":{"visibility":"visible"},"description":"Used to specify a username as string to authenticate with. Authentication is only possible with \u0027https://\u0027. Use with: -Password","caption":"Username","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"11","varname":"IcingaCheckHTTPStatus_String_Username","format":null},"9":{"settings":{"visibility":"visible"},"description":"Used to specify headers as Array. Like: -Headers \u0027Accept:application/json\u0027","caption":"Headers","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"9","varname":"IcingaCheckHTTPStatus_Array_Headers","format":null},"14":{"settings":{"visibility":"hidden"},"description":"Used to specify a proxy password as securestring to authenticate with. Use with: -ProxyUsername \u0026 -ProxyServer","caption":"ProxyPassword","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"14","varname":"IcingaCheckHTTPStatus_Securestring_ProxyPassword","format":null},"20":{"settings":{"visibility":"visible"},"description":"Adds the returned content of a webseite to the plugin output for debugging purpose","caption":"AddOutputContent","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"20","varname":"IcingaCheckHTTPStatus_Switchparameter_AddOutputContent","format":null},"15":{"settings":{"visibility":"visible"},"description":"Used to specify a proxy server as string to authenticate with.","caption":"ProxyServer","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"15","varname":"IcingaCheckHTTPStatus_String_ProxyServer","format":null},"6":{"settings":{"visibility":"visible"},"description":"Used to specify the webrequest response time critical threshold in seconds, everything past that threshold is considered a CRITICAL.","caption":"Critical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"6","varname":"IcingaCheckHTTPStatus_Object_Critical","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":"IcingaCheckHTTPStatus_String_ThresholdInterval","format":null},"19":{"settings":{"visibility":"visible"},"description":"A switch used to invert check results.","caption":"Negate","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"19","varname":"IcingaCheckHTTPStatus_Switchparameter_Negate","format":null},"13":{"settings":{"visibility":"visible"},"description":"Used to specify a proxy username as string to authenticate with. Use with: -ProxyPassword \u0026 -ProxyServer","caption":"ProxyUsername","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"13","varname":"IcingaCheckHTTPStatus_String_ProxyUsername","format":null}}}