listΒΆ

list(1) 		      BIG-IP TMSH Manual		       list(1)



NAME
       list command - Displays components that you have permission to view.

MODULE
       All tmsh modules.

SYNTAX
       Use the list command within a tmsh module to display the properties of
       the components in that module. To display the properties of the
       components in one module from within another module, use the full path
       to the component.

	list [component]
	list [component] [name]
	list [component] [name] [property]
	list / [module...module] [component] [name] [property]
	  options:
	    all-properties
	    current-module
	    non-default-properties
	    one-line
	    partition
	    recursive

DESCRIPTION
       When the default Read partition is All, use the list command to display
       all of the components that you have permission to view within a tmsh
       module. When you specify a Read partition, the list command displays:

       o    Only the components that you have permission to view in the
	    current partition

       o    All of the components that are not in partitions

       o    All of the components in partition Common

EXAMPLES
       list / ltm

       From within the gtm module, displays the properties of all of the
       components in the ltm module, including the components in the ltm
       monitor, ltm persistence, and ltm profile modules.

       list / ltm current-module

       From within the gtm module, displays the properties of all of the
       components in the ltm module, not including the components in the ltm
       monitor, ltm persistence, and ltm profile modules.

       list pool

       From within the gtm module, displays the properties of all of the
       Global Traffic Manager pools.

       list pool all-properties

       From within the gtm module, displays all of the properties of all of
       the Global Traffic Manager pools.

       list pool monitor

       From within the gtm module, displays the monitor associated with each
       Global Traffic Manager pool.

       list / ltm pool

       From within the gtm module, displays the properties of all of the Local
       Traffic Manager pools.

OPTIONS
       all-properties
	    Displays the values of all of the properties of the specified
	    component.

       component
	    Specifies the component that you want to display.

       current-module
	    Specifies to display only the components that reside in the
	    specified module, not the components that reside in the sub-
	    modules of that module.

	    For example, from within the ltm module to display only the
	    components in the gtm module, and not the components in the gtm
	    monitor and gtm settings sub-modules, use the following command
	    sequence: list / gtm current-module.

       module
	    Specifies the module within which the component that you want to
	    display resides.

	    Note: When you use the command list at the module level, by
	    default, the system does not display all of the components that
	    reside in the specified module. To display the properties of some
	    components you must explicitly specify the component. For example,
	    from the ltm module, to display the virtual addresses for the
	    Local Traffic Manager, use this command sequence:

	    list virtual-address

	    For more information about displaying the properties of a
	    component, see the man page for the component.

       name Specifies the unique name of the component.

       non-default-properties
	    Displays the values of all of the properties for which a user
	    changed the value from the default value for the specified
	    component.

       one-line
	    Displays the configuration for each object on one line.
	    Configuration that consists of scripts will not be formatted on to
	    a single line. This include ltm and gtm iRules and tmsh scripts.

       partition
	    Displays the administrative partition within which the specified
	    component exists.

       property
	    Specifies the property of the component that you want to display.

       recursive
	    Specifies to display the components not only from the current
	    folder but also from all sub-folders recursively.

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



BIG-IP				  2016-03-14			       list(1)