]> granicus.if.org Git - icinga2/commitdiff
Description modified for command plugins 5363/head
authorPetr Ruzicka <petr.ruzicka@gmail.com>
Mon, 19 Jun 2017 13:22:19 +0000 (15:22 +0200)
committerPetr Ruzicka <petr.ruzicka@gmail.com>
Tue, 20 Jun 2017 11:38:31 +0000 (13:38 +0200)
itl/command-plugins-manubulon.conf
itl/command-plugins-windows.conf
itl/command-plugins.conf

index 40216656fcfd48b6a48ed0809daef7c068dc9bb7..74c3cbc3c7a809912e0d97cbee0494b7056a85a8 100644 (file)
@@ -25,35 +25,53 @@ template CheckCommand "snmp-manubulon-command" {
        import "ipv4-or-ipv6"
 
        arguments = {
-               "-H" = "$snmp_address$"
+               "-H" = {
+                       value = "$snmp_address$"
+                       description = "Name or IP address of host to check"
+               }
                "-C" = {
                        set_if = "$snmp_nocrypt$"
                        value = "$snmp_community$"
+                       description = "Community name for the host's SNMP agent (implies v1 protocol)"
+               }
+               "-p" = {
+                       value = "$snmp_port$"
+                       description = "SNMP port (Default 161)"
                }
-               "-p" = "$snmp_port$"
                "-2" = {
                        set_if = "$snmp_v2$"
+                       description = "Use snmp v2c"
                }
                "-l" = {
                        set_if = "$snmp_v3$"
                        value = "$snmp_login$"
+                       description = "Login and auth password for snmpv3 authentication"
                }
                "-x" = {
                        set_if = "$snmp_v3$"
                        value = "$snmp_password$"
+                       description = "Priv password"
                }
                "-L" = {
                        set_if = "$snmp_v3_use_authprotocol$"
                        value = "$snmp_authprotocol$"
+                       description = "<authproto>,<privproto> - <Authentication protocol (md5|sha : default md5)>,<Priv protocole (des|aes : default des)>"
                }
                "-X" = {
                        set_if = "$snmp_v3_use_privpass$"
                        value = "$snmp_privpass$"
+                       description = "Priv password for snmpv3 (AuthPriv protocol)"
+               }
+               "-w" = {
+                       value = "$snmp_warn$"
+               }
+               "-c" = {
+                       value = "$snmp_crit$"
+               }
+               "-t" = {
+                       value = "$snmp_timeout$"
+                       description = "Timeout for SNMP in seconds (Default: 5)"
                }
-
-               "-w" = "$snmp_warn$"
-               "-c" = "$snmp_crit$"
-               "-t" = "$snmp_timeout$"
        }
 
        vars.snmp_address = "$check_address$"
@@ -80,9 +98,13 @@ object CheckCommand "snmp-load" {
        command = [ ManubulonPluginDir + "/check_snmp_load.pl" ]
 
        arguments += {
-               "-T" = "$snmp_load_type$"
+               "-T" = {
+                       value = "$snmp_load_type$"
+                       description = "CPU check"
+               }
                "-f" = {
                        set_if = "$snmp_perf$"
+                       description = "Perfparse compatible output"
                }
        }
 
@@ -108,6 +130,7 @@ object CheckCommand "snmp-memory" {
        arguments += {
                "-f" = {
                        set_if = "$snmp_perf$"
+                       description = "Performance data output"
                }
                "-I" = {
                        set_if = "$snmp_is_cisco$"
@@ -136,9 +159,13 @@ object CheckCommand "snmp-storage" {
        command = [ ManubulonPluginDir + "/check_snmp_storage.pl" ]
 
        arguments += {
-               "-m" = "$snmp_storage_name$"
+               "-m" = {
+                       value = "$snmp_storage_name$"
+                       description = "Name in description OID (can be mounpoints '/home' or 'Swap Space'...)"
+               }
                "-f" = {
                        set_if = "$snmp_perf$"
+                       description = "Perfparse compatible output"
                }
        }
 
@@ -160,38 +187,57 @@ object CheckCommand "snmp-interface" {
        command = [ ManubulonPluginDir + "/check_snmp_int.pl" ]
 
        arguments += {
-               "-n" = "$snmp_interface$"
+               "-n" = {
+                       value = "$snmp_interface$"
+                       description = "Name in description OID (eth0, ppp0 ...). This is treated as a regexp : -n eth will match eth0,eth1,..."
+               }
                "-k" = {
                        set_if = "$snmp_interface_perf$"
+                       description = "Check the input/ouput bandwidth of the interface"
+               }
+               "--label" = {
+                       value = "$snmp_interface_label$"
+                       description = "Add label before speed in output : in=, out=, errors-out=, etc..."
                }
-               "--label" = "$snmp_interface_label$"
                "-Y" = {
                        set_if = "$snmp_interface_bits_bytes$"
+                       description = "Output performance data in bits/s or Bytes/s"
                }
                "-y" = {
                        set_if = "$snmp_interface_percent$"
+                       description = "Output performance data in % of max speed"
                }
                "-B" = {
                        set_if = "$snmp_interface_kbits$"
+                       description = "Make the warning and critical levels in K|M|G Bits/s instead of K|M|G Bytes/s"
                }
                "-M" = {
                        set_if = "$snmp_interface_megabytes$"
+                       description = "Make the warning and critical levels in Mbps"
                }
                "--64bits" = {
                        set_if = "$snmp_interface_64bit$"
+                       description = "Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps"
                }
                "-e" = {
                        set_if = "$snmp_interface_errors$"
+                       description = "Add error & discard to Perfparse output"
                }
                "-i" = {
                        set_if = "$snmp_interface_inverse$"
+                       description = "Make critical when up"
                }
                "-r" = {
                        set_if = "$snmp_interface_noregexp$"
+                       description = "Do not use regexp to match NAME in description OID"
+               }
+               "-d" = {
+                       value = "$snmp_interface_delta$"
+                       description = "Make an average of <delta> seconds (default 300=5min)"
                }
-               "-d" = "$snmp_interface_delta$"
                "-u" = {
                        set_if = "$snmp_interface_warncrit_percent$"
+                       description = "Make the warning and critical levels in % of reported interface speed"
                }
                "-N" = {
                        set_if = "$snmp_interface_ifname$"
@@ -201,6 +247,7 @@ object CheckCommand "snmp-interface" {
                }
                "-f" = {
                        set_if = "$snmp_perf$"
+                       description = "Perfparse compatible output (no output when interface is down)"
                }
        }
 
@@ -235,24 +282,26 @@ object CheckCommand "snmp-process" {
 
        arguments += {
                "-n" = {
-                       description = "Regex service name eg. ^apache2$"
                        value = "$snmp_process_name$"
+                       description = "Regex service name eg. ^apache2$"
                }
                "-F" = {
                        set_if = "$snmp_perf$"
+                       description = "Add performance output (outputs : memory_usage, num_process, cpu_usage)"
                }
                "-A" = {
                        set_if = "$snmp_process_use_params$"
+                       description = "Add parameters to select processes (ex : 'named.*-t /var/named/chroot' will only select named process with this parameter)"
                }
                "-m" = {
-                       description = "Checks memory usage. Values warning and critical in Mb eg. 512,1024"
                        set_if = "$snmp_process_mem_usage$"
                        value = "$snmp_process_mem_threshold$"
+                       description = "Checks memory usage. Values warning and critical in Mb eg. 512,1024"
                }
                "-u" = {
-                       description = "Checks CPU usage. Values warning and critical in % (value can be > 100% : 100%=1 CPU) eg. 15,50"
                        set_if = "$snmp_process_cpu_usage$"
                        value = "$snmp_process_cpu_threshold$"
+                       description = "Checks CPU usage. Values warning and critical in % (value can be > 100% : 100%=1 CPU) eg. 15,50"
                }
        }
 
index a23aa1f02cbe6777b2ecd10590ff0d2acbd20120..626c7ec9364ade14e0c710ad201c9fa1265d121d 100644 (file)
@@ -133,12 +133,10 @@ object CheckCommand "perfmon-windows" {
                        value = "$perfmon_win_syntax$"
                        description = "Use this instead of the counter name in the perfomance data"
                }
-
        }
 
        vars.performance_win_wait = 1000
        vars.perfmon_win_type = "double"
-       //The default values
 }
 
 
@@ -171,7 +169,6 @@ template CheckCommand "ping-common-windows" {
 
        vars.ping_win_packets = "5"
        vars.ping_win_timeout = "1000"
-       //The default values
 }
 
 object CheckCommand "ping-windows" {
@@ -251,7 +248,6 @@ object CheckCommand "swap-windows" {
        }
 
        vars.swap_win_unit = "mb"
-       //The default
 }
 
 object CheckCommand "update-windows" {
@@ -294,7 +290,6 @@ object CheckCommand "uptime-windows" {
        }
 
        vars.uptime_win_unit = "s"
-       //The default
 }
 
 object CheckCommand "users-windows" {
index 12b59a0cbaff0425865541067ed382782d599aaa..03b364344061b80d50349a269830f5b4e29b771a 100644 (file)
@@ -747,7 +747,7 @@ object CheckCommand "smtp" {
                "-P" = {
                        value = "$smtp_authpass$"
                        description = "SMTP AUTH password"
-                       }
+               }
                "-q" = {
                        value = "$smtp_ignore_quit$"
                        description = "Ignore failure when sending QUIT command to server"
@@ -1382,138 +1382,113 @@ object CheckCommand "disk" {
                        required = true
                        order = -3
                }
-
                "-c" = {
                        value = "$disk_cfree$"
                        description = "Exit with CRITICAL status if less than INTEGER units of disk are free or Exit with CRITCAL status if less than PERCENT of disk space is free"
                        required = true
                        order = -3
                }
-
                "-W" = {
                        value = "$disk_inode_wfree$"
                        description = "Exit with WARNING status if less than PERCENT of inode space is free"
                }
-
                "-K" = {
                        value = "$disk_inode_cfree$"
                        description = "Exit with CRITICAL status if less than PERCENT of inode space is free"
                }
-
                "-p" = {
                        value = "$disk_partitions$"
                        description = "Path or partition (may be repeated)"
                        repeat_key = true
                        order = 1
                }
-
                "-p_old" = {
                        key = "-p"
                        value = "$disk_partition$"
                        order = 1
                }
-
                "-x" = {
                        value = "$disk_partitions_excluded$"
                        description = "Ignore device (only works if -p unspecified)"
                }
-
                "-x_old" = {
                        key = "-x"
                        value = "$disk_partition_excluded$"
                }
-
                "-C" = {
                        set_if = "$disk_clear$"
                        description = "Clear thresholds"
                }
-
                "-E" = {
                        set_if = "$disk_exact_match$"
                        description = "For paths or partitions specified with -p, only check for exact paths"
                }
-
                "-e" = {
                        set_if = "$disk_errors_only$"
                        description = "Display only devices/mountpoints with errors"
                }
-
                "-f" = {
                        set_if = "$disk_ignore_reserved$"
                        description = "Don't account root-reserved blocks into freespace in perfdata"
                }
-
                "-g" = {
                        value = "$disk_group$"
                        description = "Group paths. Thresholds apply to (free-)space of all partitions together"
                }
-
                "-k" = {
                        set_if = "$disk_kilobytes$"
                        description = "Same as --units kB"
                }
-
                "-l" = {
                        set_if = "$disk_local$"
                        description = " Only check local filesystems"
                }
-
                "-L" = {
                        set_if = "$disk_stat_remote_fs$"
                        description = "Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles)"
                }
-
                "-M" = {
                        set_if = "$disk_mountpoint$"
                        description = "Display the mountpoint instead of the partition"
                }
-
                "-m" = {
                        set_if = "$disk_megabytes$"
                        description = "Same as --units MB"
                }
-
                "-A" = {
                        set_if = "$disk_all$"
                        description = "Explicitly select all paths. This is equivalent to -R .*"
                }
-
                "-R" = {
                        value = "$disk_eregi_path$"
                        description = "Case insensitive regular expression for path/partition (may be repeated)"
                        repeat_key = true
                }
-
                "-r" = {
                        value = "$disk_ereg_path$"
                        description = "Regular expression for path or partition (may be repeated)"
                        repeat_key = true
                }
-
                "-I" = {
                        value = "$disk_ignore_eregi_path$"
                        description = "Regular expression to ignore selected path/partition (case insensitive) (may be repeated)"
                        repeat_key = true
                        order = 2
                }
-
                "-i" = {
                        value = "$disk_ignore_ereg_path$"
                        description = "Regular expression to ignore selected path or partition (may be repeated)"
                        repeat_key = true
                        order = 2
                }
-
                "-t" = {
                        value = "$disk_timeout$"
                        description = "Seconds before connection times out (default: 10)"
                }
-
                "-u" = {
                        value = "$disk_units$"
                        description = "Choose bytes, kB, MB, GB, TB (default: MB)"
                }
-
                "-X" = {
                        value = "$disk_exclude_type$"
                        description = "Ignore all filesystems of indicated type (may be repeated)"
@@ -2295,19 +2270,17 @@ object CheckCommand "nrpe" {
        arguments = {
                "-H" = {
                        value = "$nrpe_address$"
-                       description = ""
+                       description = "The address of the host running the NRPE daemon"
                }
                "-p" = {
                        value = "$nrpe_port$"
-                       description = ""
                }
                "-c" = {
                        value = "$nrpe_command$"
-                       description = ""
                }
                "-n" = {
                        set_if = "$nrpe_no_ssl$"
-                       description = "Do not use SSL."
+                       description = "Do not use SSL"
                }
                "-u" = {
                        set_if = "$nrpe_timeout_unknown$"
@@ -2315,7 +2288,7 @@ object CheckCommand "nrpe" {
                }
                "-t" = {
                        value = "$nrpe_timeout$"
-                       description = ""
+                       description = "<interval>:<state> = <Number of seconds before connection times out>:<Check state to exit with in the event of a timeout (default=CRITICAL)>"
                }
                "-a" = {
                        value = "$nrpe_arguments$"
@@ -2792,13 +2765,26 @@ object CheckCommand "negate" {
        command = [ PluginDir + "/negate" ]
 
        arguments = {
-               "-t" = "$negate_timeout$"
-               "-T" = "$negate_timeout_result$"
-               "-o" = "$negate_ok$"
-               "-w" = "$negate_warning$"
-               "-c" = "$negate_critical$"
+               "-t" = {
+                       value = "$negate_timeout$"
+                       description = "Seconds before plugin times out (default: 11)"
+               }
+               "-T" = {
+                       value = "$negate_timeout_result$"
+                       description = "Custom result on Negate timeouts"
+               }
+               "-o" = {
+                       value = "$negate_ok$"
+               }
+               "-w" = {
+                       value = "$negate_warning$"
+               }
+               "-c" = {
+                       value = "$negate_critical$"
+               }
                "-s" = {
                        set_if = "$negate_substitute$"
+                       description = "Substitute output text as well. Will only substitute text in CAPITALS"
                }
                "--wrapped-plugin" = {
                        value = {{
@@ -2971,16 +2957,46 @@ object CheckCommand "mysql_query" {
        command = [ PluginDir + "/check_mysql_query" ]
 
        arguments = {
-               "-H" = "$mysql_query_hostname$"
-               "-P" = "$mysql_query_port$"
-               "-u" = "$mysql_query_username$"
-               "-p" = "$mysql_query_password$"
-               "-d" = "$mysql_query_database$"
-               "-f" = "$mysql_query_file$"
-               "-g" = "$mysql_query_group$"
-               "-q" = "$mysql_query_execute$"
-               "-w" = "$mysql_query_warning$"
-               "-c" = "$mysql_query_critical$"
+               "-H" = {
+                       value = "$mysql_query_hostname$"
+                       description = "Host name, IP Address, or unix socket (must be an absolute path)"
+               }
+               "-P" = {
+                       value = "$mysql_query_port$"
+                       description = "Port number (default: 3306)"
+               }
+               "-u" = {
+                       value = "$mysql_query_username$"
+                       description = "Username to login with"
+               }
+               "-p" = {
+                       value = "$mysql_query_password$"
+                       description = "Password to login with"
+               }
+               "-d" = {
+                       value = "$mysql_query_database$"
+                       description = "Database to check"
+               }
+               "-f" = {
+                       value = "$mysql_query_file$"
+                       description = "Read from the specified client options file"
+               }
+               "-g" = {
+                       value = "$mysql_query_group$"
+                       description = "Use a client options group"
+               }
+               "-q" = {
+                       value = "$mysql_query_execute$"
+                       description = "SQL query to run. Only first column in first row will be read"
+               }
+               "-w" = {
+                       value = "$mysql_query_warning$"
+                       description = "Warning range (format: start:end). Alert if outside this range"
+               }
+               "-c" = {
+                       value = "$mysql_query_critical$"
+                       description = "Critical range"
+               }
        }
 
        vars.mysql_query_hostname = "$check_address$"
@@ -2994,12 +3010,25 @@ object CheckCommand "radius" {
        ]
 
        arguments = {
-               "-H" = "$radius_address$",
-               "-F" = "$radius_config_file$",
-               "-u" = "$radius_username$",
-               "-p" = "$radius_password$",
+               "-H" = {
+                       value = "$radius_address$",
+                       description = "Host name, IP Address, or unix socket (must be an absolute path)"
+               }
+               "-F" = {
+                       value = "$radius_config_file$",
+                       description = "Configuration file"
+               }
+               "-u" = {
+                       value = "$radius_username$",
+                       description = "The user to authenticate"
+               }
+               "-p" = {
+                       value = "$radius_password$",
+                       description = "Password for authentication"
+               }
                "-P" = {
                        value = "$radius_port$",
+                       description = "Port number (default: 1645)"
                },
                "-n" = {
                        value = "$radius_nas_id$",