APIRef_tm_gtm_monitor_firepass

mgmt/tm/gtm/monitor/firepass

/tm/gtm/monitor

Firepass monitor configuration

REST Endpoints

Collection URI
/mgmt/tm/gtm/monitor/firepass
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/gtm/monitor/firepass/~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.
cipherlist string   optional read/write Specifies the list of ciphers for this monitor. The default list is HIGH:!ADH.
concurrencyLimit integer   optional read/write Specifies the maximum percentage of licensed connections currently in use under which the monitor marks the FirePass system up. As an example, a setting of 95 percent means that the monitor marks the FirePass system up until 95 percent of licensed connections are in use. When the number of in-use licensed connections exceeds 95 percent, the monitor marks the FirePass system down The default is 95.
defaultsFrom string   optional read/write Settings will be initialized from this monitor. The default is “firepass”.
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.
maxLoadAverage floating-point   optional read/write Specifies the number that the monitor uses to mark the FirePass system up or down. The system compares the Max Load Average setting against a one-minute average of the FirePass system load. When the FirePass system-load average falls within the specified Max Load Average, the monitor marks the FirePass system up. When the average exceeds the setting, the monitor marks the system down. The default is 12.0.
tmPartition string   optional read/write Displays the administrative partition within which the monitor resides.
password string   optional read/write Specifies the password, if the monitored target requires authentication.
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 is 90 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 flags the target as down immediately, without waiting for the timeout interval to expire. Note that the Timeout setting should be 3 times the Interval setting, plus 1 second.
username string   optional read/write Specifies the username, if the monitored target requires authentication.
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.