APIRef_tm_gtm_monitor_sip¶
mgmt/tm/gtm/monitor/sip
SIP monitor configuration.
REST Endpoints
- Collection URI
/mgmt/tm/gtm/monitor/sip- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/gtm/monitor/sip/~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. | |
cert |
string | optional | read/write | Specifies a fully-qualified path for a client certificate that the monitor sends to the target SSL server. | |
cipherlist |
string | optional | read/write | Specifies the list of ciphers for this monitor. The default value is “DEFAULT:+SHA:+3DES:+kEDH”. | |
compatibility |
string | optional | read/write | Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. | |
debug |
string | optional | read/write | Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. The default setting is no. You can use the log information to help diagnose and troubleshoot unsuccessful health checks. The options are: no (Specifies that the system does not redirect error messages and additional information related to this monitor.) and yes (Specifies that the system redirects error messages and additional information to the /var/log/monitors/<monitor_name>-<node_name>-<port>.log file.). | |
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.). | |
filter |
string | optional | read/write | Specifies the SIP status codes that the target can return to be considered up. By default the system always accepts status codes whose value is in the 100, 200 or 300s. The options are none (Specifies that the monitor does not accept any other SIP status codes.), any (Specifies that the monitor accepts any SIP status codes.), and status (Specifies one or more status codes that you want to add to the monitor.) | |
filterNeg |
string | optional | read/write | Specifies the SIP status codes that the target can return to be considered down. By default the system always accepts status codes according to sip-monitor.filter. After checking that, the status code is checked against this key. The options are none (Specifies that the monitor does not specifically reject any other SIP status codes.), any (Specifies that the monitor rejects all SIP status codes that are not in the sip-monitor.filter property.), and status (Specifies one or more status codes that you want to add to the monitor.) If a code is also in sip-monitor.filter, the node will be marked up. | |
headers |
string | optional | read/write | Specifies the set of SIP headers in the SIP message that is sent to the target. Each header should be separated by a newline. | |
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. | |
key |
string | optional | read/write | Specifies the key if the monitored target requires authentication. | |
mode |
string | optional | read/write | Specifies the protocol that the monitor uses to communicate with the target. The options are tcp (the monitor uses TCP to communicate with the target) tls (the monitor uses TLS to communicate with the target) sips (the monitor uses TLS to communicate with the target, and the SIP URI is SIPS) and udp (the monitor uses UDP to communicate with the target) | |
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. | |
request |
string | optional | read/write | Specifies the SIP request line in the SIP message that is sent to the target. | |
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. |
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.