APIRef_tm_gtm_monitor_external

mgmt/tm/gtm/monitor/external

/tm/gtm/monitor

External monitor configuration.

REST Endpoints

Collection URI
/mgmt/tm/gtm/monitor/external
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/gtm/monitor/external/~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.
args string   optional read/write Specifies any command-line arguments that the external program requires.
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 30 seconds.
tmPartition string   optional read/write Displays the administrative partition within which the monitor resides.
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.
run string   optional read/write Specifies the path and file name of a program to run as the external monitor, for example /config/monitors/myMonitor.
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 120 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 environment variables that the external program requires. The value of userDefined should be two strings enclosed in double quotes, and separated by a space. To express this as JSON data, you need to escape the double quotes, and enclose the resulting string in a new set of double quotes. See examples below.

userDefined Examples

restcurl -u admin:admin /mgmt/tm/gtm/monitor/external/gtmexternalmonitor -X PATCH -d '{ "userDefined":"\"envname\" \"value\"" }'
Note that the resulting object will show the environment variables as a list under an object called apiRawValues. This cannot be modified directly - PATCH and PUT operations must operate on the userDefined object instead, which is then converted internally into apiRawValues.
# restcurl -u admin:admin /mgmt/tm/gtm/monitor/external/gtmexternalmonitor -X PATCH -d '{ "userDefined":"\"envname\" \"value\"" }'
{
  "kind": "tm:gtm:monitor:external:externalstate",
  "name": "gtmexternalmonitor",
  "fullPath": "gtmexternalmonitor",
  "generation": 0,
  "selfLink": "https://localhost/mgmt/tm/gtm/monitor/external/gtmexternalmonitor?ver\u003d15.1.0.4",
  "defaultsFrom": "/Common/external",
  "destination": "*:*",
  "ignoreDownResponse": "disabled",
  "interval": 30,
  "probeTimeout": 5,
  "timeout": 120,
  "apiRawValues": {
    "userDefined envname": "value"
  }
}
To remove a single environment value, set the value to “none”, for example:
restcurl -u admin:admin /mgmt/tm/gtm/monitor/external/gtmexternalmonitor -X PATCH -d '{ "userDefined":"\"envname\" \"none\"" }'


iControl Reference Index
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.