gtm monitor sip
gtm monitor sip(1) BIG-IP TMSH Manual gtm monitor sip(1)
NAME
sip - Configures a Session Initiation Protocol (SIP) monitor.
MODULE
gtm monitor
SYNTAX
Configure the sip component within the gtm monitor module using the
syntax in the following sections.
CREATE/MODIFY
create sip [name]
modify sip [name]
options:
cert [ [cert list] | none]
cipherlist [list]
compatibility [enabled | disabled]
debug [ no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
filter [any | none | status]
filter-neg [any | none | status]
headers [ [new line separated headers] | none]
ignore-down-response [enabled | disabled]
interval [integer]
key [ [key] | none]
mode [sips | tcp | tls | udp]
probe-timeout [integer]
request [none | [string] ]
username [ [name] | none]
edit sip [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list sip
list sip [ [ [name] | [glob] | [regex] ] ... ]
show running-config sip
show running-config sip [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete sip [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the sip component to configure a custom monitor, or you can
use the default SIP monitor that the Global Traffic Manager provides.
This type of monitor checks the status of SIP Call-ID services on a
device. The SIP protocol enables real-time messaging, voice, data, and
video.
EXAMPLES
create sip my_sip defaults-from sip
Creates a monitor named my_sip that inherits properties from the
default SIP monitor.
list sip
Displays the properties of all of the SIP monitors.
OPTIONS
cert Specifies a fully-qualified path for a client certificate that the
monitor sends to the target SSL server. The default value is none.
cipherlist
Specifies the list of ciphers for this monitor. The default value
is none.
compatibility
Specifies, when enabled, that the SSL options setting (in OpenSSL)
is set to ALL. The default value is enabled.
debug
Specifies whether the monitor sends error messages and additional
information to a log file created and labeled specifically for
this monitor. You can use the log information to help diagnose and
troubleshoot unsuccessful health checks. The default value is no.
The options are:
no Specifies that the system does not redirect error messages
and additional information related to this monitor.
yes Specifies that the system redirects error messages and
additional information to the
/var/log/monitors/--.log file.
defaults-from
Specifies the name of the monitor from which you want your custom
monitor to inherit settings. The default value is sip.
description
User defined description.
destination
Specifies the IP address and service port 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 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.
IP address: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
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 100s, 200s, or 300s.
The options are:
any Specifies that the monitor accepts any SIP status codes.
none Specifies that the monitor does not accept any other SIP
status codes. This is the default value.
status
Specifies one or more status codes that you want to add to
the monitor.
filter-neg
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. If a code is also in
sip-monitor.filter, the node is marked up.
The options are:
any Specifies that the monitor rejects all SIP status codes that
are not in sip-monitor.filter.
none Specifies that the monitor does not specifically reject any
other SIP status codes. This is the default value.
status
Specifies one or more status codes that you want to add to
the monitor.
glob Displays the items that match the glob expression. See help glob
for a description of glob expression syntax.
headers
Specifies the set of SIP headers in the SIP message that is sent
to the target. Separate each header with a new line. The default
value is none.
ignore-down-response
Specifies whether the monitor ignores a down response from the
system it is monitoring. The default value is disabled.
interval
Specifies the frequency at which the system issues the monitor
check. The default value is 30 seconds.
key Specifies the key if the monitored target requires authentication.
The default value is none.
mode Specifies the protocol that the monitor uses to communicate with
the target. The options are:
sips Specifies that the monitor uses SIPS to communicate with the
target.
tcp Specifies that the monitor uses TCP to communicate with the
target.
tls Specifies that the monitor uses TLS to communicate with the
target, and the SIP URI is SIPS.
udp Specifies that the monitor uses UDP to communicate with the
target.
name Specifies a unique name for the component. This option is required
for the commands create, delete, and modify.
partition
Displays the administrative partition within which the component
resides.
probe-timeout
Specifies the number of seconds after which the BIG-IP(r) system
times out the probe request to the BIG-IP system. The default
value is 5 seconds.
regex
Displays the items that match the regular expression. The regular
expression must be preceded by an at sign (@[regular expression])
to indicate that the identifier is a regular expression. See help
regex for a description of regular expression syntax.
request
Specifies the SIP request line in the SIP message that is sent to
the target. The default value is none.
timeout
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.
SEE ALSO
create, delete, edit, glob, gtm pool, list, modify, regex, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2013-2014, 2016. All
rights reserved.
BIG-IP 2017-08-15 gtm monitor sip(1)