APIRef_tm_gtm_monitor_snmpΒΆ
mgmt/tm/gtm/monitor/snmp
SNMP monitor configuration.
REST Endpoints
- Collection URI
/mgmt/tm/gtm/monitor/snmp- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/gtm/monitor/snmp/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | 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 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 and service port of the resource that is the destination of this monitor. Possible values are: *:* (Specifies to perform a health check on the IP address and port supplied by a pool member), *:port (Specifies to perform a health check on the server with the IP address supplied by the pool member and the port you specify.), and <IP>:<port> (Specifies to mark a pool member up or down based on the response of the server at the IP address and port you specify.). | |
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 90 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 1 attempt. | |
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 180 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. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.