ltm message-routing sip route

ltm message-routing sip route(1)		  BIG-IP TMSH Manual		     ltm message-routing sip route(1)

NAME
       route - Configures a static route for use in Session Initiation Protocol (SIP) message routing.

MODULE
       ltm message-routing sip

SYNTAX
       Configure the route component within the ltm message-routing sip module using the syntax shown in the
       following sections.

   CREATE/MODIFY
	create route [name]
	modify route [name]
	  options:
	    app-service [[string] | none]
	    description [string]
	    from-uri [string]
	    peer-selection-mode [ratio | sequential]
	    peers { [none | [peer_name ... ] }
	    request-uri [string]
	    to-uri [string]
	    virtual-server [virtual-server_name]

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

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

	show route
	show route [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    (default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
	    field-fmt

   DELETE
	delete route [name]

DESCRIPTION
       You can use the route component to define the URI's, virtual server, peers and peer selection mode of a
       message routing SIP static route.

EXAMPLES
       create route my_route

       Creates a route instance named my_route using the system defaults.

       create route my_route peers { peer1 peer2 }

       Creates a route instance named my_route that will use two peers for forwarding messages.

OPTIONS
       app-service
	    Specifies the name of the application service to which the object 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 object. Only the application service can modify or delete the object.

       description
	    User defined description.

       from-uri
	    Specifies the patterns to be matched against the From field of a SIP message. This URI will be matched as
	    a case insignificant method. It should be in the form of user@domain. The "sip:" prefix should not be
	    present. Any additional modifiers (for example port or transport) should also not be present. It may
	    begin with a wildcard, "*". If empty, it will be treated as if the entire URI was a wildcard (matching
	    all From-URIs).

       peer-selection-mode
	    Specifies the mode of selecting a peer from a list of peers. The options are:

	    ratio
		 Peers are selected based on their weights in comparison with other peers.

	    sequential
		 Peers are selected in the order listed. All traffic will route the first peer unless all pool
		 members in the peer are marked down.

       peers
	    Specifies an ordered list of peers to use for forwarding messages.

       request-uri
	    Specifies the patterns to be matched against the request-uri field of a SIP message. This URI will be
	    matched as a case insensitive method. It should be in the form of user@domain. The "sip:" prefix
	    should not be present. Any additional modifiers (for example port or transport) should also not be
	    present. It may begin with a wildcard, * "*". If empty, it will be treated as if the entire URI was a *
	    wildcard (matching all Request-URIs).

       to-uri
	    Specifies the patterns to be matched against the To field of a SIP message. This URI will be matched as a
	    case insensitive method. It should be in the form of user@domain. The "sip:" prefix should not be
	    present. Any additional modifiers (for example port or transport) should also not be present. It may
	    begin with a wildcard, "*". If empty, it will be treated as if the entire URI was a wildcard (matching
	    all To-URIs).

       virtual-server
	    Specifies the virtual server on which connections will be routed to this route. If the virtual server is
	    unset, messages originating on any connection may be routed to the route.

SEE ALSO
       create, delete, edit, glob, list, ltm virtual, modify, regex, show, tmsh, ltm message-routing sip route

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 2013-2014, 2016. All rights reserved.

BIG-IP						      2016-03-14		     ltm message-routing sip route(1)