APIRef_tm_gtm_monitor_snmp-link¶

mgmt/tm/gtm/monitor/snmp-link

SNMP Link monitor configuration.

REST Endpoints

Collection URI: /mgmt/tm/gtm/monitor/snmp-link
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/gtm/monitor/snmp-link/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name, partition, subPath

Properties

Name	Type	Required	Access	Description
`appService`	string	optional	read/write	The application service to which the object belongs.
`community`	string	optional	read/write	Specifies the community to which the SNMP Link monitor belongs.
`defaultsFrom`	string	optional	read/write	Specifies the existing monitor from which the system imports settings for the new monitor.
`description`	string	optional	read/write	User defined description.
`destination`	string	optional	read/write	Specifies the IP address of the resource that is the destination of this monitor. The default value is . Possible values are: (Specifies to perform a health check on the IP address of the node) or <IP> (Specifies to perform a health check on the IP address that you specify, route the check through the IP address of the associated node, and mark the IP address of the associated node up or down accordingly.).
`ignoreDownResponse`	string	optional	read/write	Specifies whether the monitor ignores a down response from the system it is monitoring. The default value is disabled.
`interval`	integer	optional	read/write	Specifies the frequency at which the system issues the monitor check. The default value is 10 seconds.
`tmPartition`	string	optional	read/write	Displays the administrative partition within which the monitor resides.
`port`	integer	optional	read/write	Specifies the port number to which this monitor sends SNMP traps. The default port is 161.
`probeAttempts`	integer	optional	read/write	Specifies the number of times the BIG-IP system attempts to probe the host server, after which the BIG-IP system considers the host server down or unavailable. The default value is 3 attempts.
`probeInterval`	integer	optional	read/write	Specifies the frequency at which the BIG-IP system probes the host server. The default value is 1 second.
`probeTimeout`	integer	optional	read/write	Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP system. The default value is 5 seconds.
`timeout`	integer	optional	read/write	Specifies the number of seconds the target has in which to respond to the monitor request. The default value is 30 seconds. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. Also, if the target responds with a RESET packet, the system immediately flags the target as down without waiting for the timeout interval to expire.
`version`	string	optional	read/write	Specifies the SNMP version the monitor uses.

iControl Reference Index

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.