config/director/Invoke-IcingaCheckMSSQLResource.json

{"DataList":{"IcingaCheckMSSQLResource Verbosity":{"list_name":"IcingaCheckMSSQLResource 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"}},"Command":{"Invoke-IcingaCheckMSSQLResource":{"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}],"object_name":"Invoke-IcingaCheckMSSQLResource","arguments":{"-SqlUsername":{"value":"$IcingaCheckMSSQLResource_String_SqlUsername$","order":"8"},"-AverageLatchWaitTimeWarning":{"value":"$IcingaCheckMSSQLResource_Object_AverageLatchWaitTimeWarning$","order":"5"},"-NoPerfData":{"set_if":"$IcingaCheckMSSQLResource_Switchparameter_NoPerfData$","set_if_format":"string","order":"99"},"-SqlPort":{"value":"$IcingaCheckMSSQLResource_Int32_SqlPort$","order":"11"},"-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-IcingaCheckMSSQLResource\u0027 ","order":"0"},"-AverageLatchWaitTimeCritical":{"value":"$IcingaCheckMSSQLResource_Object_AverageLatchWaitTimeCritical$","order":"4"},"-ThresholdInterval":{"value":"$IcingaCheckMSSQLResource_String_ThresholdInterval$","order":"100"},"-BufferCacheHitRatioCritical":{"value":"$IcingaCheckMSSQLResource_Object_BufferCacheHitRatioCritical$","order":"6"},"-BufferCacheHitRatioWarning":{"value":"$IcingaCheckMSSQLResource_Object_BufferCacheHitRatioWarning$","order":"7"},"-IntegratedSecurity":{"set_if":"$IcingaCheckMSSQLResource_Switchparameter_IntegratedSecurity$","set_if_format":"string","order":"99"},"-PageLifeExpectancyCritical":{"value":"$IcingaCheckMSSQLResource_Object_PageLifeExpectancyCritical$","order":"2"},"-SqlHost":{"value":"$IcingaCheckMSSQLResource_String_SqlHost$","order":"10"},"-Verbosity":{"value":"$IcingaCheckMSSQLResource_Int32_Verbosity$","order":"13"},"-SqlPassword":{"value":"(ConvertTo-IcingaSecureString \u0027$IcingaCheckMSSQLResource_Securestring_SqlPassword$\u0027)","order":"9"},"-SqlDatabase":{"value":"$IcingaCheckMSSQLResource_String_SqlDatabase$","order":"12"},"-PageLifeExpectancyWarning":{"value":"$IcingaCheckMSSQLResource_Object_PageLifeExpectancyWarning$","order":"3"}},"imports":["PowerShell Base"],"object_type":"object","vars":{"IcingaCheckMSSQLResource_Switchparameter_NoPerfData":false,"IcingaCheckMSSQLResource_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":{"datalist":"IcingaCheckMSSQLResource 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])e","caption":"Verbosity","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeDatalist","originalId":"16","varname":"IcingaCheckMSSQLResource_Int32_Verbosity","format":null},"3":{"settings":{"visibility":"visible"},"description":"Critical threshold for the page life expectancy which indicates the number of seconds a page will stay in the buffer pool without references.","caption":"PageLifeExpectancyCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"3","varname":"IcingaCheckMSSQLResource_Object_PageLifeExpectancyCritical","format":null},"5":{"settings":{"visibility":"visible"},"description":"Critical threshold for the Average Latch Wait Time (ms) for latch requests that had to wait.","caption":"AverageLatchWaitTimeCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"5","varname":"IcingaCheckMSSQLResource_Object_AverageLatchWaitTimeCritical","format":null},"12":{"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":"12","varname":"IcingaCheckMSSQLResource_Int32_SqlPort","format":null},"10":{"settings":{"visibility":"hidden"},"description":"The password for connecting to the MSSQL database as secure string","caption":"SqlPassword","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"10","varname":"IcingaCheckMSSQLResource_Securestring_SqlPassword","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":"IcingaCheckMSSQLResource_String_ThresholdInterval","format":null},"8":{"settings":{"visibility":"visible"},"description":"Warning threshold for the Buffer cache hit ratio which Indicates the percentage of pages found in the buffer cache without having to read from disk.\nThe ratio is the total number of cache hits divided by the total number of cache lookups over the last few thousand page accesses. After a long period\nof time, the ratio moves very little. Because reading from the cache is much less expensive than reading from disk, you want this ratio to be high.\nGenerally, you can increase the buffer cache hit ratio by increasing the amount of memory available to SQL Server or by using the buffer pool extension\nfeature.","caption":"BufferCacheHitRatioWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"8","varname":"IcingaCheckMSSQLResource_Object_BufferCacheHitRatioWarning","format":null},"11":{"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":"11","varname":"IcingaCheckMSSQLResource_String_SqlHost","format":null},"9":{"settings":{"visibility":"visible"},"description":"The username for connecting to the MSSQL database","caption":"SqlUsername","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"9","varname":"IcingaCheckMSSQLResource_String_SqlUsername","format":null},"14":{"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":"14","varname":"IcingaCheckMSSQLResource_Switchparameter_IntegratedSecurity","format":null},"7":{"settings":{"visibility":"visible"},"description":"Warning threshold for the Buffer cache hit ratio which Indicates the percentage of pages found in the buffer cache without having to read from disk.\nThe ratio is the total number of cache hits divided by the total number of cache lookups over the last few thousand page accesses. After a long period\nof time, the ratio moves very little. Because reading from the cache is much less expensive than reading from disk, you want this ratio to be high.\nGenerally, you can increase the buffer cache hit ratio by increasing the amount of memory available to SQL Server or by using the buffer pool extension\nfeature.","caption":"BufferCacheHitRatioCritical","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"7","varname":"IcingaCheckMSSQLResource_Object_BufferCacheHitRatioCritical","format":null},"15":{"settings":{"visibility":"visible"},"description":"Disables the performance data output of this plugin","caption":"NoPerfData","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeBoolean","originalId":"15","varname":"IcingaCheckMSSQLResource_Switchparameter_NoPerfData","format":null},"6":{"settings":{"visibility":"visible"},"description":"Warning threshold for the Average Latch Wait Time (ms) for latch requests that had to wait.","caption":"AverageLatchWaitTimeWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"6","varname":"IcingaCheckMSSQLResource_Object_AverageLatchWaitTimeWarning","format":null},"4":{"settings":{"visibility":"visible"},"description":"Warning threshold for the page life expectancy which indicates the number of seconds a page will stay in the buffer pool without references.","caption":"PageLifeExpectancyWarning","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"4","varname":"IcingaCheckMSSQLResource_Object_PageLifeExpectancyWarning","format":null},"13":{"settings":{"visibility":"visible"},"description":"The name of a specific database to connect to. Leave empty to connect \"globally\"","caption":"SqlDatabase","datatype":"Icinga\\Module\\Director\\DataType\\DataTypeString","originalId":"13","varname":"IcingaCheckMSSQLResource_String_SqlDatabase","format":null}}}