ltm message-routing mqtt profile router

ltm message-routing mqtt profiBIG-IPltmSmessage-routing mqtt profile router(1)



NAME
       router - Configures a MQTT Router profile.

MODULE
       ltm message-routing mqtt profile

SYNTAX
       Configure the router component within the ltm message-routing mqtt
       profile module using the syntax shown in the following sections.

   CREATE/MODIFY
	create router [name]
	modify router [name]
	  options:
	    app-service [[string] | none]
	    defaults-from [[name] | none]
	    description [string]
	    max-pending-bytes [integer]
	    max-payload-pending-bytes [integer]
	    max-pending-messages [integer]
	    max-retries [integer]
	    route [add | default | delete | none | replace-all-with] [route_name]
	    traffic-group [[string] | default | non-default | none]
	    use-local-connection [disabled | enabled]

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

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

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

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

   DELETE
	delete router [name]

DESCRIPTION
       You can use the router component to manage a MQTT router profile.

EXAMPLES
       create router my_router_profile defaults-from router

       Creates a MQTT router profile named my_router_profile using the system
       defaults.

       create router my_router_profile route route1

       Creates a MQTT router profile named my_router_profile with a static
       route.

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.

       defaults-from
	    Specifies the profile that you want to use as the parent profile.
	    Your new profile inherits all of the settings and values from the
	    specified parent profile. The default value is router.

       description
	    User defined description.

       glob Displays the items that match the glob expression. See help glob
	    for a description of glob expression syntax.

       max-pending-bytes
	    Specifies the maximum number of bytes contained within pending
	    messages that will be held while waiting for a connection to a
	    peer to be created. Once reached any additional messages to the
	    peer will be flagged as undeliverable and returned to the
	    originator.

       max-payload-pending-bytes
	    Specifies the maximum number of payload bytes contained within
	    pending messages that will be held before exerting flow control
	    and eventually closing the TCP window.

       max-pending-messages
	    Specifies the maximum number of pending messages that will be held
	    while waiting for a connection to a peer to be created. Once
	    reached any additional messages to the peer will be flagged as
	    undeliverable and returned to the originator.

       max-retries
	    This attribute sets the maximum number of time a message may be
	    resubmitted for rerouting by the MR::retry iRule command. The
	    default value is 1.

       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.

       route
	    Specifies a static route.

       traffic-group
	    Specifies the traffic group on which the router is active. The
	    default traffic group is inherited from the containing folder.

       inherited-traffic-group
	    Read-only property that indicates if the traffic-group is
	    inherited from the parent folder.

       use-local-connection
	    Enables or disables a preference for local connections established
	    by the ingress TMM over connections established by other TMM's
	    when selecting the egress connection to destination peer.

SEE ALSO
       create, delete, edit, glob, list, ltm virtual, modify, regex, reset-
       stats, 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 2013-2014, 2016-2017. All rights
       reserved.



BIG-IP				  20ltm0message-routing mqtt profile router(1)