APIRef_tm_ltm_monitor_snmp-dca-base¶
mgmt/tm/ltm/monitor/snmp-dca-base
SNMP monitor configuration.
REST Endpoints
- Collection URI
/mgmt/tm/ltm/monitor/snmp-dca-base- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/ltm/monitor/snmp-dca-base/~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 name that the BIG-IP system must use to authenticate with the host server through SNMP. The default value is public. | |
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.). | |
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. | |
timeUntilUp |
integer | optional | read/write | Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. The default setting is 0. | |
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. | |
userDefined |
string | optional | read/write | Specifies user defined variables for the monitor. The name and value of the variable must be specified. If “none” is specified as the value then the variable is removed. | |
version |
string | optional | read/write | Specifies the version of SNMP that the host server 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.