config/director/Invoke-IcingaCheckMSSQLBackupStatus.json

{"DataList":{"IcingaCheckMSSQLBackupStatus DatabaseStatusWarning":{"list_name":"IcingaCheckMSSQLBackupStatus DatabaseStatusWarning","originalId":"2","entries":[{"allowed_roles":null,"entry_value":"Online","entry_name":"Online","format":"string"},{"allowed_roles":null,"entry_value":"Restoring","entry_name":"Restoring","format":"string"},{"allowed_roles":null,"entry_value":"Recovering","entry_name":"Recovering","format":"string"},{"allowed_roles":null,"entry_value":"Recovering_Pending","entry_name":"Recovering_Pending","format":"string"},{"allowed_roles":null,"entry_value":"Suspect","entry_name":"Suspect","format":"string"},{"allowed_roles":null,"entry_value":"Emergency","entry_name":"Emergency","format":"string"},{"allowed_roles":null,"entry_value":"Offline","entry_name":"Offline","format":"string"},{"allowed_roles":null,"entry_value":"Copying","entry_name":"Copying","format":"string"},{"allowed_roles":null,"entry_value":"Offline_Secondary","entry_name":"Offline_Secondary","format":"string"}],"owner":"stein"},"IcingaCheckMSSQLBackupStatus Verbosity":{"list_name":"IcingaCheckMSSQLBackupStatus 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"},"IcingaCheckMSSQLBackupStatus DatabaseStatusCritical":{"list_name":"IcingaCheckMSSQLBackupStatus DatabaseStatusCritical","originalId":"2","entries":[{"allowed_roles":null,"entry_value":"Online","entry_name":"Online","format":"string"},{"allowed_roles":null,"entry_value":"Restoring","entry_name":"Restoring","format":"string"},{"allowed_roles":null,"entry_value":"Recovering","entry_name":"Recovering","format":"string"},{"allowed_roles":null,"entry_value":"Recovering_Pending","entry_name":"Recovering_Pending","format":"string"},{"allowed_roles":null,"entry_value":"Suspect","entry_name":"Suspect","format":"string"},{"allowed_roles":null,"entry_value":"Emergency","entry_name":"Emergency","format":"string"},{"allowed_roles":null,"entry_value":"Offline","entry_name":"Offline","format":"string"},{"allowed_roles":null,"entry_value":"Copying","entry_name":"Copying","format":"string"},{"allowed_roles":null,"entry_value":"Offline_Secondary","entry_name":"Offline_Secondary","format":"string"}],"owner":"stein"}},"Command":{"Invoke-IcingaCheckMSSQLBackupStatus":{"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},{"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-IcingaCheckMSSQLBackupStatus","arguments":{"-TotalBackupSizeWarning":{"value":"$IcingaCheckMSSQLBackupStatus_Object_TotalBackupSizeWarning$","order":"2"},"-IncludeDatabase":{"value":{"body":"var arr = macro(\"$IcingaCheckMSSQLBackupStatus_Array_IncludeDatabase$\");\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"},"-DatabaseStatusWarning":{"value":"$IcingaCheckMSSQLBackupStatus_Object_DatabaseStatusWarning$","order":"12"},"-ExecutionTimeCritical":{"value":"$IcingaCheckMSSQLBackupStatus_Object_ExecutionTimeCritical$","order":"11"},"-NoPerfData":{"set_if":"$IcingaCheckMSSQLBackupStatus_Switchparameter_NoPerfData$","set_if_format":"string","order":"99"},"-SqlUsername":{"value":"$IcingaCheckMSSQLBackupStatus_String_SqlUsername$","order":"15"},"-LastBackupLogAgeCritical":{"value":"$IcingaCheckMSSQLBackupStatus_Object_LastBackupLogAgeCritical$","order":"7"},"-LastBackupAgeWarning":{"value":"$IcingaCheckMSSQLBackupStatus_Object_LastBackupAgeWarning$","order":"8"},"-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 \"Error: $$($$_.Exception.Message)Components:`r`n$$( Get-Module -ListAvailable \"icinga-powershell-*\" )`r`nModule-Path:`r`n$$($$Env:PSModulePath)\"; exit 3; }; Exit-IcingaExecutePlugin -Command \u0027Invoke-IcingaCheckMSSQLBackupStatus\u0027 ","order":"0"},"-ThresholdInterval":{"value":"$IcingaCheckMSSQLBackupStatus_String_ThresholdInterval$","order":"100"},"-ExecutionTimeWarning":{"value":"$IcingaCheckMSSQLBackupStatus_Object_ExecutionTimeWarning$","order":"10"},"-LastBackupLogAgeWarning":{"value":"$IcingaCheckMSSQLBackupStatus_Object_LastBackupLogAgeWarning$","order":"6"},"-AvgBackupSizeWarning":{"value":"$IcingaCheckMSSQLBackupStatus_Object_AvgBackupSizeWarning$","order":"4"},"-IntegratedSecurity":{"set_if":"$IcingaCheckMSSQLBackupStatus_Switchparameter_IntegratedSecurity$","set_if_format":"string","order":"99"},"-DatabaseStatusCritical":{"value":"$IcingaCheckMSSQLBackupStatus_Object_DatabaseStatusCritical$","order":"13"},"-SqlHost":{"value":"$IcingaCheckMSSQLBackupStatus_String_SqlHost$","order":"17"},"-TotalBackupSizeCritical":{"value":"$IcingaCheckMSSQLBackupStatus_Object_TotalBackupSizeCritical$","order":"3"},"-SqlPort":{"value":"$IcingaCheckMSSQLBackupStatus_Int32_SqlPort$","order":"18"},"-Verbosity":{"value":"$IcingaCheckMSSQLBackupStatus_Object_Verbosity$","order":"19"},"-LastBackupAgeCritical":{"value":"$IcingaCheckMSSQLBackupStatus_Object_LastBackupAgeCritical$","order":"9"},"-AvgBackupSizeCritical":{"value":"$IcingaCheckMSSQLBackupStatus_Object_AvgBackupSizeCritical$","order":"5"},"-SqlPassword":{"value":"(ConvertTo-IcingaSecureString \u0027$IcingaCheckMSSQLBackupStatus_Securestring_SqlPassword$\u0027)","order":"16"}},"imports":["PowerShell Base"],"object_type":"object","vars":{"IcingaCheckMSSQLBackupStatus_Switchparameter_NoPerfData":false,"IcingaCheckMSSQLBackupStatus_Switchparameter_IntegratedSecurity":false}},"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"}},"Datafield":{"16":{"settings":{"visibility":"visible"},"description":"The username for connecting to the MSSQL database","caption":"SqlUsername","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"16","varname":"IcingaCheckMSSQLBackupStatus_String_SqlUsername","format":null},"3":{"settings":{"visibility":"visible"},"description":"Warning threshold for the total backupsize which represent a count of all backups","caption":"TotalBackupSizeWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"3","varname":"IcingaCheckMSSQLBackupStatus_Object_TotalBackupSizeWarning","format":null},"5":{"settings":{"visibility":"visible"},"description":"Warning threshold for the average backupsize which represent an average backupsize of all backups","caption":"AvgBackupSizeWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"5","varname":"IcingaCheckMSSQLBackupStatus_Object_AvgBackupSizeWarning","format":null},"21":{"settings":{"visibility":"visible"},"description":"Disables the performance data output of this plugin","caption":"NoPerfData","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"21","varname":"IcingaCheckMSSQLBackupStatus_Switchparameter_NoPerfData","format":null},"18":{"settings":{"visibility":"visible"},"description":"The IP address or FQDN to the MSSQL server to connect to","caption":"SqlHost","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"18","varname":"IcingaCheckMSSQLBackupStatus_String_SqlHost","format":null},"12":{"settings":{"visibility":"visible"},"description":"Critical threshold for the execution time, which returns the elapsed time how long the backup process took","caption":"ExecutionTimeCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"12","varname":"IcingaCheckMSSQLBackupStatus_Object_ExecutionTimeCritical","format":null},"10":{"settings":{"visibility":"visible"},"description":"Critical threshold for the last backup age, which returns the elapsed time since a database was last backupped","caption":"LastBackupAgeCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"10","varname":"IcingaCheckMSSQLBackupStatus_Object_LastBackupAgeCritical","format":null},"2":{"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":"2","varname":"IcingaCheckMSSQLBackupStatus_String_ThresholdInterval","format":null},"22":{"settings":{"datalist":"IcingaCheckMSSQLBackupStatus 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":"IcingaCheckMSSQLBackupStatus_Object_Verbosity","format":null},"8":{"settings":{"visibility":"visible"},"description":null,"caption":"LastBackupLogAgeCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"8","varname":"IcingaCheckMSSQLBackupStatus_Object_LastBackupLogAgeCritical","format":null},"17":{"settings":{"visibility":"hidden"},"description":"The password for connecting to the MSSQL database as secure string","caption":"SqlPassword","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"17","varname":"IcingaCheckMSSQLBackupStatus_Securestring_SqlPassword","format":null},"11":{"settings":{"visibility":"visible"},"description":"Warning threshold for the execution time, which returns the elapsed time how long the backup process took","caption":"ExecutionTimeWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"11","varname":"IcingaCheckMSSQLBackupStatus_Object_ExecutionTimeWarning","format":null},"9":{"settings":{"visibility":"visible"},"description":"Warning threshold for the last log backup age, which returns the elapsed time since a database was last backupped","caption":"LastBackupAgeWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"9","varname":"IcingaCheckMSSQLBackupStatus_Object_LastBackupAgeWarning","format":null},"14":{"settings":{"datalist":"IcingaCheckMSSQLBackupStatus DatabaseStatusCritical","behavior":"strict","data_type":"string"},"description":"Critical threshold for the database status:\n Online\n Restoring\n Recovering\n Recovering_Pending\n Suspect\n Emergency\n Offline\n Copying\n Offline_Secondary","caption":"DatabaseStatusCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeDatalist","originalId":"14","varname":"IcingaCheckMSSQLBackupStatus_Object_DatabaseStatusCritical","format":null},"7":{"settings":{"visibility":"visible"},"description":"Warning threshold for the last log backup age, which returns the elapsed time since a database was last backupped","caption":"LastBackupLogAgeWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"7","varname":"IcingaCheckMSSQLBackupStatus_Object_LastBackupLogAgeWarning","format":null},"15":{"settings":{"visibility":"visible"},"description":"Specifies the database or databases which will be checked. Leave empty to fetch metrics from\nall databases on the given system","caption":"IncludeDatabase","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeArray","originalId":"15","varname":"IcingaCheckMSSQLBackupStatus_Array_IncludeDatabase","format":null},"20":{"settings":{"visibility":"visible"},"description":"Allows this plugin to use the credentials of the current PowerShell session inherited by\nthe user the PowerShell is running with. If this is set and the user the PowerShell is\nrunning with can access to the MSSQL database you will not require to provide username\nand password","caption":"IntegratedSecurity","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"20","varname":"IcingaCheckMSSQLBackupStatus_Switchparameter_IntegratedSecurity","format":null},"6":{"settings":{"visibility":"visible"},"description":"Critical threshold for the average backupsize which represent an average backupsize of all backups","caption":"AvgBackupSizeCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"6","varname":"IcingaCheckMSSQLBackupStatus_Object_AvgBackupSizeCritical","format":null},"4":{"settings":{"visibility":"visible"},"description":"Critical threshold for the total backupsize which represent a count of all backups","caption":"TotalBackupSizeCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"4","varname":"IcingaCheckMSSQLBackupStatus_Object_TotalBackupSizeCritical","format":null},"19":{"settings":{"visibility":"visible"},"description":"The port of the MSSQL server/instance to connect to with the provided credentials","caption":"SqlPort","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeNumber","originalId":"19","varname":"IcingaCheckMSSQLBackupStatus_Int32_SqlPort","format":null},"13":{"settings":{"datalist":"IcingaCheckMSSQLBackupStatus DatabaseStatusWarning","behavior":"strict","data_type":"string"},"description":"Warning threshold for the database status:\n Online\n Restoring\n Recovering\n Recovering_Pending\n Suspect\n Emergency\n Offline\n Copying\n Offline_Secondary","caption":"DatabaseStatusWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeDatalist","originalId":"13","varname":"IcingaCheckMSSQLBackupStatus_Object_DatabaseStatusWarning","format":null}}}