Merge pull request #5372 from ruzickap/fix/itl_check_command_description

Update ITL CheckCommand description attribute, part 2

itl/command-nscp-local.conf

@@ -25,8 +25,14 @@ object CheckCommand "nscp-local" {
 	command = [ NscpPath + "\\nscp.exe", "client" ]
 
 	arguments = {
-		"--log" = "$nscp_log_level$"
+		"--log" = {
-		"--load-all" = { set_if ="$nscp_load_all$" }
+			value = "$nscp_log_level$"
+			description = "The log level to use"
+		}
+		"--load-all" = {
+			set_if ="$nscp_load_all$"
+			description = "Load all plugins (currently only used with generate)"
+		}
 		"--module" = {
 			value = "$nscp_modules$"
 			description = "Specify which NSClient++ modules are required. 'nscp client' just needs 'CheckSystem' by default."
@@ -34,19 +40,22 @@ object CheckCommand "nscp-local" {
 		}
 		"-q" = {
 			value = "$nscp_query$"
+			description = "Run a query with a given name"
 			required = true
 		}
 		"-b" = {
 			set_if = "$nscp_boot$"
+			description = "Boot the client before executing command (similar as running the command from test mode)"
 		}
 		"-a" = {
 			value = "$nscp_arguments$"
 			repeat_key = true
+			description = "List of arguments (arguments gets -- prefixed automatically (--argument foo=bar is the same as setting '--foo bar')"
 		}
 		"--show-all" = {
 			set_if = "$nscp_showall$"
+			description = ""
 		}
-
 	}
 
 	vars.nscp_log_level = "critical"
@@ -63,6 +72,7 @@ object CheckCommand "nscp-local-cpu" {
 		"--time" = {
 			value = "$nscp_cpu_time$"
 			repeat_key = true
+			description = "The time to check"
 		}
 		"--warning" = {
 			value = "load>$nscp_cpu_warning$"
@@ -91,9 +101,11 @@ object CheckCommand "nscp-local-memory" {
 	arguments += {
 		"--type=committed" = {
 			set_if = "$nscp_memory_committed$"
+			description = "Total memory (RAM+PAGE)"
 		}
 		"--type=physical" = {
 			set_if = "$nscp_memory_physical$"
+			description = "Physical memory (RAM)"
 		}
 		"--warning" = {
 			value = "$nscp_memory_op$ $nscp_memory_warning$"

itl/plugins-contrib.d/web.conf

@@ -264,58 +264,58 @@ object CheckCommand "nginx_status" {
 		command = [ PluginContribDir + "/check_nginx_status.pl" ]
 
 		arguments = {
-				"--hostname" = {
+			"--hostname" = {
-						value = "$nginx_status_host_address$"
+				value = "$nginx_status_host_address$"
-						description = "name or IP address of host to check"
+				description = "name or IP address of host to check"
-				}
+			}
-				"--port" = {
+			"--port" = {
-						value = "$nginx_status_port$"
+				value = "$nginx_status_port$"
-						description = "the http port"
+				description = "the http port"
-				}
+			}
-				"--url" = {
+			"--url" = {
-						value = "$nginx_status_url$"
+				value = "$nginx_status_url$"
-						description = "Specific URL to use, instead of the default 'http://<nginx_status_hostname>/nginx_status'"
+				description = "Specific URL to use, instead of the default 'http://<nginx_status_hostname>/nginx_status'"
-				}
+			}
-				"--servername" = {
+			"--servername" = {
-						value = "$nginx_status_servername$"
+				value = "$nginx_status_servername$"
-						description = "ServerName, use it if you specified an IP in -H to match the good Virtualhost in your target"
+				description = "ServerName, use it if you specified an IP in -H to match the good Virtualhost in your target"
-				}
+			}
-				"--ssl" = {
+			"--ssl" = {
-						set_if = "$nginx_status_ssl$"
+				set_if = "$nginx_status_ssl$"
-						description = "Wether we should use HTTPS instead of HTTP"
+				description = "Wether we should use HTTPS instead of HTTP"
-				}
+			}
-				"--disable-sslverifyhostname" = {
+			"--disable-sslverifyhostname" = {
-						set_if = "$nginx_status_disable_sslverify$"
+				set_if = "$nginx_status_disable_sslverify$"
-						description = "Disable SSL hostname verification"
+				description = "Disable SSL hostname verification"
-				}
+			}
-				"--user" = {
+			"--user" = {
-						value = "$nginx_status_user$"
+				value = "$nginx_status_user$"
-						description = "Username for basic auth"
+				description = "Username for basic auth"
-				}
+			}
-				"--pass" = {
+			"--pass" = {
-						value = "$nginx_status_pass$"
+				value = "$nginx_status_pass$"
-						description = "Password for basic auth"
+				description = "Password for basic auth"
-				}
+			}
-				"--realm" = {
+			"--realm" = {
-						value = "$nginx_status_realm$"
+				value = "$nginx_status_realm$"
-						description = "Realm for basic auth"
+				description = "Realm for basic auth"
-				}
+			}
-				"--maxreach" = {
+			"--maxreach" = {
-						value = "$nginx_status_maxreach$"
+				value = "$nginx_status_maxreach$"
-						description = "Number of max processes reached (since last check) that should trigger an alert"
+				description = "Number of max processes reached (since last check) that should trigger an alert"
-				}
+			}
-				"--timeout" = {
+			"--timeout" = {
-						value = "$nginx_status_timeout$"
+				value = "$nginx_status_timeout$"
-						description = "timeout in seconds"
+				description = "timeout in seconds"
-				}
+			}
-				"--warn" = {
+			"--warn" = {
-						value = "$nginx_status_warn$"
+				value = "$nginx_status_warn$"
-						description = "number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING"
+				description = "number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING"
-				}
+			}
-				"--critical" = {
+			"--critical" = {
-						value = "$nginx_status_critical$"
+				value = "$nginx_status_critical$"
-						description = "number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL"
+				description = "number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL"
-				}
+			}
 		}
 
 		vars.nginx_status_host_address = "$check_address$"
@@ -561,4 +561,3 @@ object CheckCommand "ssl_cert" {
 	vars.ssl_cert_address = "$check_address$"
 	vars.ssl_cert_port = 443
 }
-