sys folder

sys folder(1)					  BIG-IP TMSH Manual					sys folder(1)

NAME
       folder - Configure folders (directory structure) on the BIG-IP(r) system.

MODULE
       sys

SYNTAX
       Configure the folder component within the sys module using the syntax in the following sections.

   CREATE/MODIFY
	create folder [name]
	modify folder [name]
	  options:
	    app-service [[string] | none]
	    description [string]
	    device-group [[string] | default | non-default | none]
	    no-ref-check [false | true]
	    traffic-group [[string] | default | non-default | none]

   DISPLAY
	list folder
	list folder [ [name] | [glob] | [regex] | [recursive] ]

   DELETE
	delete folder [name]

DESCRIPTION
       The folder system enables users to create logical containers for the purpose of granular control of
       synchronization to other devices in a device group.

       The folder system is hierarchical, with folders and sub-folders, in a parent-to-child relationship. The
       highest level folder in the system is called root. For every administrative partition on the BIG-IP system,
       there is a top-level folder. Top-level folders always have root as the parent. Users can create sub-folders to
       any folder in the system.

EXAMPLES
       create sys folder sub-folder1 device-group dg1 traffic-group none

       Creates a new sub-folder to the current working folder called sub-folder1, associates the folder with a
       device-group called dg1, and sets the traffic-group to no association.

       modify sys folder /Common/sub-folder1/subfolder2 description "store pools for the B2 server configuration"

       Changes the description property of the folder indicated by its full name.

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.

       description
	    User defined description.

       device-group
	    Adds this folder and all configuration items in this folder to a device group for device failover or
	    config-sync purposes. The options are:

	    default
		 Indicates that this folder should use the device group setting of its parent folder. If the parent
		 folder's associated device group is changed, this folder's device group will change as well.

	    non-default
		 Disassociates this folder from its parent folder's device group setting. This folder's device group
		 field can then be set independently of the parent folder's field.

       hidden
	    Folders may be hidden by setting this property to true. The -hidden command-line option will allow you to
	    view hidden folders, but is not required to use or modify a folder. The -hidden command-line option only
	    affects output from the list command and the results of tab completing a configuration item. If set to
	    false, the folder will always be visible as long as the user has the appropriate permissions.

       inherited-devicegroup
	    Specifies, when set to true, that this folder uses the device group setting of its parent folder. If the
	    parent folder's associated device group is changed then this folder's device group will change as well.
	    This field is read-only.

       inherited-traffic-group
	    Specifies, when set to true, that this folder uses the traffic group setting of its parent folder. If the
	    parent folder's associated traffic group is changed then this folder's traffic group will change as well.
	    This field is read-only.

       no-ref-check
	    Specifies whether strict device group reference validation is performed on configuration items in the
	    folder. The options are:

	    false
		 Requires configuration items in the folder to sync to a super-set of the devices that are associated
		 with any configuration that refers to configuration items in the folder. This is the default value.

	    true Disables this check. It is then assumed that any dependent configuration items contained in the
		 folder will be created locally on the other devices.

       traffic-group
	    Adds this folder and its configuration items to an existing traffic group. The values default and non-
	    default work as they do for the device-group option.

SEE ALSO
       create, delete, glob, list, modify, regex, tmsh

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or
       mechanical, include 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 2011-2013, 2015-2016. All rights reserved.

BIG-IP						      2016-03-14					sys folder(1)