ltm message-routing mqtt profile sessionΒΆ

ltm message-routing mqtt profile session(1)	  BIG-IP TMSH Manual	  ltm message-routing mqtt profile session(1)

NAME
       session - Configures a MQTT Session profile.

MODULE
       ltm message-routing mqtt profile

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

   CREATE/MODIFY
	create session [name]
	modify session [name]
	  options:
	    app-service [[string] | none]
	    defaults-from [[name] | none]
	    description [string]

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

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

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

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

   DELETE
	delete session [name]

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

EXAMPLES
       create session my_session_profile defaults-from session

       Creates a MQTT session profile named my_session_profile using the system defaults.

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 session.

       description
	    User defined description.

       clientid-prefix
	    Specifies the client-id prefix that will be used when sending the CONNECT message to the broker.

       keepalive-int
	    Specifies the keepalive interval that will be used when sending the CONNECT message to the broker.

       peered-session-mode
	    Set this option to peer a client session with server session. When either side terminates the peered
	    session will terminate immediately.

       proxy-topic-prefix
	    Specifies a prefix that will be added to topic of messages that belong to the proxy.

       client-will-handling-mode
	    Specifies the will handling mode to control will action for ungraceful shutdown of the client session.

       server-will-handling-mode
	    Specifies the will handling mode to control will action for ungraceful shutdown of proxy's session with
	    the broker.

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

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

       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.

       partition
	    Displays the administrative partition within which the component resides.

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						      2018-10-20	  ltm message-routing mqtt profile session(1)