ltm monitor sipΒΆ

ltm monitor sip(1)					BIG-IP TMSH Manual					ltm monitor sip(1)

NAME
       sip - Configures a Session Initiation Protocol (SIP) monitor.

MODULE
       ltm monitor

SYNTAX
       Configure the sip component within the ltm monitor module using the syntax in the following sections.

   CREATE/MODIFY
	create sip [name]
	modify sip [name]
	  options:
	    app-service [[string] | none]
	    cert [ [cert list] | none]
	    cipherlist [string]
	    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]
	    interval [integer]
	    key [ [key] | none]
	    manual-resume [enabled | disabled]
	    mode [sips | tcp | tls | udp | mr-tls | mr-sips | mr-tcp | mr-udp | mr-sctp]
	    request [none | [string] ]
	    time-until-up [integer]
	    up-interval [integer]
	    username [ [name] | none]

	edit sip [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list sip
	list sip [ [ [name] | [glob] | [regex] ] ... ]
	show sip [ [ [name] | [glob] | [regex] ] ... ]
	show running-config sip
	show running-config sip [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line
	    partition
	    test-result

   DELETE
	delete sip [name]

       Note: You cannot delete default monitors.

   RUN
	run sip [name] [ destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ] ]

   STOP
	stop sip [name]

DESCRIPTION
       You can use the sip component to configure a custom monitor, or you can use the default SIP monitor that the Local 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.

       You can test a custom monitor configuration against a specified target destination by using the run command, and view the
       results of such a test by using the show command with the test-result option.

       The following user roles (in addition to the root user) have permissions to run and stop an ltm monitor test:

	    admin, application-editor, manager, operator, resource-admin

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.

       run sip my_sip destination 10.10.10.10:80

       Runs a one-shot test of the custom monitor my_sip against a target node at 10.10.10.10:80.

       stop sip my_sip

       Cancels a one-shot test of the custom monitor my_sip in progress.

       show sip my_sip test-result

       Displays the result of the most recent one-shot test of the custom monitor my_sip.

OPTIONS
       app-service
	    Specifies the name of the application service to which the monitor belongs. The default value is none. Note: If the
	    strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
	    monitor. Only the application service can modify or delete the monitor.

       cert Specifies a fully-qualified path for a client certificate that the monitor sends to the target SSL server. The default
	    value is none. Currently ignored for "mr-" modes.

       cipherlist
	    Specifies the list of ciphers for this monitor. The default value is DEFAULT:+SHA:+3DES:+kEDH. Currently ignored for
	    "mr-" modes.

       compatibility
	    Specifies, when enabled, that the SSL options setting (in OpenSSL) is set to ALL. The default value is enabled.
	    Currently ignored for "mr-" modes.

       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.

	    This option is required for the command run, unless an IP address and service port are specified in the destination
	    option for the specified custom monitor.

       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 100, 200 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.

       interval
	    Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or
	    the status of the resource is unknown. The default value is 5 seconds.

	    Important: F5 Networks recommends that when you configure this option and the up-interval option, whichever value is
	    greater be a multiple of the lesser value to allow for an even distribution of monitor checks among all monitors.

       key  Specifies the key if the monitored target requires authentication. The default value is none. Currently ignored for
	    "mr-" modes.

       manual-resume
	    Specifies whether the system automatically changes the status of a resource to up at the next successful monitor
	    check. The default value of the manual-resume option is disabled.

	    Note that if you set the manual-resume option to enabled, you must manually mark the resource as up before the system
	    can use it for load balancing connections.

       mode Specifies the transport protocol that the monitor uses to communicate with the target. The default mode is udp. 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.

	    mr-tls
		 Specifies that the monitor uses TLS with the message-routing framework to communicate with the target. This is
		 serverside SSL over TCP. Note: Customizing the SSL-related options (cert, cipherlist, compatibility, key) is
		 currently ignored for this mode, and the monitor will operate with the default values.

	    mr-sips
		 Specifies that the monitor uses SIPS with the message-routing framework to communicate with the target. This is
		 TLS mode with "sips" replacing "sip" in the SIP message headers. Note: Customizing the SSL-related options (cert,
		 cipherlist, compatibility, key) is currently ignored for this mode, and the monitor will operate with the default
		 values.

	    mr-tcp
		 Specifies that the monitor uses TCP with the message-routing framework to communicate with the target.

	    mr-udp
		 Specifies that the monitor uses UDP with the message-routing framework to communicate with the target.

	    mr-sctp
		 Specifies that the monitor uses SCTP with the message-routing framework to communicate with the target.

	    The modes beginning with "mr-" use an in-TMM monitor based on the message-routing framework (MRF). The other modes use
	    the legacy monitor based on message-based load balancing (MBLB).

       name Specifies a unique name for the component. This option is required for the commands create, delete, modify, run and
	    stop.

       partition
	    Displays the administrative partition within which the component resides.

       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.

       test-result
	    Displays the result of the most recent one-shot test of the specified monitor(s), if any such test has been performed
	    since BIG-IP was started.

       time-until-up
	    Specifies the amount of time, in seconds, after the first successful response before a node is marked up. A value of 0
	    (zero) causes a node to be marked up immediately after a valid response is

       timeout
	    Specifies the number of seconds the target has in which to respond to the monitor request. The default value is 16
	    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.

       up-interval
	    Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. The default
	    value is 0 (zero), which specifies that the system uses the value of the interval option whether the resource is up or
	    down.

	    Important: F5 Networks recommends that when you configure this option and the interval option, whichever value is
	    greater be a multiple of the lesser value to allow for an even distribution of monitor checks among all monitors.

SEE ALSO
       create, delete, edit, glob, list, modify, regex, run, show, stop, 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, 2012-2014, 2016, 2017. All rights reserved.

BIG-IP							    2019-10-28						ltm monitor sip(1)