ltm message-routing generic route

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

NAME
       route - Configures a static route the generic message parser uses to route generic message protocol messages.

MODULE
       ltm message-routing generic

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

   CREATE/MODIFY
	create route [name]
	modify route [name]
	  options:
	    app-service [[string] | none]
	    description [string]
	    destination-address [string]
	    peer-selection-mode [ sequential | ratio ]
	    peers { [peer-name] }
	    source-address [string]

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

	reset-stats route
	reset-stats route [ [ [name] | [glob] | [regex] ] ... ]

   DISPLAY
	list route
	list route [ [ [name] | [glob] | [regex] ] ... ]

   DELETE
	delete route [name]

DESCRIPTION
       You can use the route component to manage a generic message static route.

EXAMPLES
       create route my_route

       Creates a static route named my_route that uses a wildcard value for the source-address and destination-
       address parameters. This acts as a default route.

       create route my_route { destination-address helpdesk peers add { peer1 peer2 }

       Creates a static route named my_route that contains two peers, peer1 and peer2. Messages routed with a
       destination-address of helpdesk are routed to a pool member contained in peer1 or peer2, based on the
       specified peer-selection-mode.

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.

       destination-address
	    Specifies the destination address of the route. If this parameter is not present, the generic message
	    parser considers the destination-address as a wildcard that matches all message destination addresses.
	    The default value is none.

       description
	    User defined description.

       peer-selection-mode
	    Specifies the method the generic message parser uses to select a peer from the specified list of peers.
	    The default value is sequential.

	    sequential
		 Specifies that the generic message parser selects the first peer in the list of peers. If the
		 protocol retransmits the message, the generic message parser uses another pool member in the first
		 peer. If all pool members in a peer are unavailable, the generic message parser uses the next peer
		 in the list.

	    ratio
		 Specifies that the generic message parser selects a peer from a list of peers based on the relative
		 ratio values of each peer. For example if three peers have ratios of 1, 1, and 2, the first 2 peers
		 have a 25% (1/4) probability of being selected and the third peer has a 50% (2/4) probability of
		 being selected.

       peers
	    Specifies a list of peers.

       source-address
	    Specifies the source address of the route. If this parameter is not present, the generic message parser
	    considers the source-address as a wildcard that matches all message sources addresses. The default value
	    is none.

SEE ALSO
       create, delete, edit, glob, list, ltm virtual, modify, regex, reset-stats, tmsh, ltm message-routing generic
       peer ltm message-routing generic router

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 2012-2014. All rights reserved.

BIG-IP						      2017-03-15		 ltm message-routing generic route(1)