Search Exchange
Search All Sites
Nagios Live Webinars
Let our experts show you how Nagios can help your organization.Login
Directory Tree
check_tl_health
1.1
2013-10-08
- Nagios 1.x
- Nagios 2.x
- Nagios 3.x
- Nagios XI
GPL
34696
Meet The New Nagios Core Services Platform
Built on over 25 years of monitoring experience, the Nagios Core Services Platform provides insightful monitoring dashboards, time-saving monitoring wizards, and unmatched ease of use. Use it for free indefinitely.
Monitoring Made Magically Better
- Nagios Core on Overdrive
- Powerful Monitoring Dashboards
- Time-Saving Configuration Wizards
- Open Source Powered Monitoring On Steroids
- And So Much More!
Usage: check_tl_health [ -v|--verbose ] [ -t ] --mode --hostname --community ...]
-?, --usage
Print usage information
-h, --help
Print detailed help screen
-V, --version
Print version information
-t, --timeout=INTEGER
Seconds before plugin times out (default: 15)
-v, --verbose
Show details for command-line debugging (can repeat up to 3 times)
--blacklist
Blacklist some (missing/failed) components
--hostname
Hostname or IP-address of the switch or router
--port
The SNMP port to use (default: 161)
--domain
The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6)
--protocol
The SNMP protocol to use (default: 2c, other possibilities: 1,3)
--community
SNMP community of the server (SNMP v1/2 only)
--username
The securityName for the USM security model (SNMPv3 only)
--authpassword
The authentication password for SNMPv3
--authprotocol
The authentication protocol for SNMPv3 (md5|sha)
--privpassword
The password for authPriv security level
--privprotocol
The private protocol for SNMPv3 (des|aes|aes128|3des|3desde)
--warning
The warning threshold
--mode
A keyword which tells the plugin what to do
uptime (Check the uptime of the device)
hardware-health (Check the status of environmental equipment (fans, temperatures, power))
cpu-load (Check the CPU load of the device)
memory-usage (Check the memory usage of the device)
interface-usage (Check the utilization of interfaces)
interface-errors (Check the error-rate of interfaces (errors+discards per sec))
interface-status (Check the status of interfaces)
list-interfaces (Show the interfaces of the device and update the name cache)
list-interfaces-detail (Show the interfaces of the device and some details)
interface-availability (Show the availability (oper != up) of interfaces)
link-aggregation-availability (Check the percentage of up interfaces in a link aggregation)
create-shinken-service (Create a Shinken service definition)
ha-role (Check the role in a ha group)
check-licenses (Check the installed licences/keys)
walk (Show snmpwalk command with the oids necessary for a simulation)
--name
The name of an interface (ifDescr)
--alias
The alias name of a 64bit-interface (ifAlias)
--regexp
A flag indicating that --name is a regular expression
--ifspeedin
Override the ifspeed oid of an interface (only inbound)
--ifspeedout
Override the ifspeed oid of an interface (only outbound)
--ifspeed
Override the ifspeed oid of an interface
--units
One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
--role
The role of this device in a hsrp group (active/standby/listen)
--report
Can be used to shorten the output
--lookback
The amount of time you want to look back when calculating average rates.
Use it for mode interface-errors or interface-usage. Without --lookback
the time between two runs of check_tl_health is the base for calculations.
If you want your checkresult to be based for example on the past hour,
use --lookback 3600.
--critical
The critical threshold
--mitigation
The parameter allows you to change a critical error to a warning.
--servertype
The type of the network device: cisco (default). Use it if auto-detection
is not possible
--statefilesdir
An alternate directory where the plugin can save files
--snmpwalk
A file with the output of a snmpwalk (used for simulation)
Use it instead of --hostname
--oids
A list of oids which are downloaded and written to a cache file.
Use it together with --mode oidcache
--offline
The maximum number of seconds since the last update of cache file before
it is considered too old
--multiline
Multiline output
-?, --usage
Print usage information
-h, --help
Print detailed help screen
-V, --version
Print version information
-t, --timeout=INTEGER
Seconds before plugin times out (default: 15)
-v, --verbose
Show details for command-line debugging (can repeat up to 3 times)
--blacklist
Blacklist some (missing/failed) components
--hostname
Hostname or IP-address of the switch or router
--port
The SNMP port to use (default: 161)
--domain
The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6)
--protocol
The SNMP protocol to use (default: 2c, other possibilities: 1,3)
--community
SNMP community of the server (SNMP v1/2 only)
--username
The securityName for the USM security model (SNMPv3 only)
--authpassword
The authentication password for SNMPv3
--authprotocol
The authentication protocol for SNMPv3 (md5|sha)
--privpassword
The password for authPriv security level
--privprotocol
The private protocol for SNMPv3 (des|aes|aes128|3des|3desde)
--warning
The warning threshold
--mode
A keyword which tells the plugin what to do
uptime (Check the uptime of the device)
hardware-health (Check the status of environmental equipment (fans, temperatures, power))
cpu-load (Check the CPU load of the device)
memory-usage (Check the memory usage of the device)
interface-usage (Check the utilization of interfaces)
interface-errors (Check the error-rate of interfaces (errors+discards per sec))
interface-status (Check the status of interfaces)
list-interfaces (Show the interfaces of the device and update the name cache)
list-interfaces-detail (Show the interfaces of the device and some details)
interface-availability (Show the availability (oper != up) of interfaces)
link-aggregation-availability (Check the percentage of up interfaces in a link aggregation)
create-shinken-service (Create a Shinken service definition)
ha-role (Check the role in a ha group)
check-licenses (Check the installed licences/keys)
walk (Show snmpwalk command with the oids necessary for a simulation)
--name
The name of an interface (ifDescr)
--alias
The alias name of a 64bit-interface (ifAlias)
--regexp
A flag indicating that --name is a regular expression
--ifspeedin
Override the ifspeed oid of an interface (only inbound)
--ifspeedout
Override the ifspeed oid of an interface (only outbound)
--ifspeed
Override the ifspeed oid of an interface
--units
One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
--role
The role of this device in a hsrp group (active/standby/listen)
--report
Can be used to shorten the output
--lookback
The amount of time you want to look back when calculating average rates.
Use it for mode interface-errors or interface-usage. Without --lookback
the time between two runs of check_tl_health is the base for calculations.
If you want your checkresult to be based for example on the past hour,
use --lookback 3600.
--critical
The critical threshold
--mitigation
The parameter allows you to change a critical error to a warning.
--servertype
The type of the network device: cisco (default). Use it if auto-detection
is not possible
--statefilesdir
An alternate directory where the plugin can save files
--snmpwalk
A file with the output of a snmpwalk (used for simulation)
Use it instead of --hostname
--oids
A list of oids which are downloaded and written to a cache file.
Use it together with --mode oidcache
--offline
The maximum number of seconds since the last update of cache file before
it is considered too old
--multiline
Multiline output
Reviews (1)
byeduardohki, March 29, 2016
Tested also with MSL 2024, works fine!