ltm monitor inband

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

NAME
       inband - Configures an Inband (passive) monitor.

MODULE
       ltm monitor

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

   CREATE/MODIFY
	create inband [name]
	modify inband [name]
	  options:
	    app-service [[string] | none]
	    defaults-from [name]
	    description [string]
	    failure-interval [integer]
	    failures [integer]
	    response-time [integer]
	    retry-time [integer]

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

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

   DELETE
	delete inband [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the inband component to configure a custom monitor, or you can use the default Inband monitor that
       the Local Traffic Manager provides. With this type of monitor the BIG-IP(r) system can perform passive
       monitoring as part of client requests.

EXAMPLES
       create inband my_inband defaults-from inband

       Creates a monitor named my_inband that inherits properties from the default Inband monitor.

       list inband

       Displays the properties of all of the Inband monitors.

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.

       defaults-from
	    Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
	    default value is inband.

       description
	    User defined description.

       failure-interval
	    Specifies an interval, in seconds. If the number of failures specified in the failures option occurs
	    within this interval, the system marks the pool member as being unavailable. The default value is 30.

       failures
	    Specifies the number of failures that the system allows to occur, within the time period specified in the
	    failure-interval option, before marking a pool member unavailable. The default value is 3, which means
	    that the system marks the pool member unavailable at the fourth failure. The multiple tmm processes use a
	    per-process number to calculate failures, depending on the specified load.	For example, for the Round
	    Robin load balancing method, if there are N tmm processes and M pool members, and the Failures setting is
	    set to L, then up to N*M*L+1 failures can occur before the system marks the node as down.

	    Specifying a value of 0 (zero) disables this option.

	    A failure can be either a failure to connect or a failure of the pool member to respond within the time
	    specified in the response-time option.

       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.

       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.

       response-time
	    Specifies an amount of time, in seconds. If the pool member does not respond with data after the
	    specified amount of time has passed, the number of failures in this interval increments by 1. Specifying
	    a value of 0 (zero) disables this option.

       retry-time
	    Specifies the amount of time in seconds after the pool member has been marked unavailable before the
	    system retries to connect to the pool member. Specifying a value of 0 (zero) disables this option.

SEE ALSO
       create, delete, edit, glob, list, modify, regex, 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 2008-2010, 2012-2013, 2015. All rights reserved.

BIG-IP						      2017-04-05				ltm monitor inband(1)