Management::Folder¶
Introduced : BIG-IP_v11.0.0
A folder stores an arbitrary set of configuration objects. The system
uses folders to control access to objects and to control
synchronization of these objects within a device group. Folders are
organized in a tree heirarchy, much like the folders or directories on
a computer&aposs file system. Objects stored in folders are referenced
by the name of the individual object, preceded by its folder name,
preceded by the names of any parent folders, up to the root folder
(/), all separated by slashes (/), e.g., /george/server/virt-a. Note:
methods to access the active folder for a session are found in the
System::Session interface.
Methods¶
| Method | Description | Introduced |
| create | Creates a set of folders. | BIG-IP_v11.0.0 |
| delete_all_folders | Deletes all folders. | BIG-IP_v11.0.0 |
| delete_folder | Deletes a set of folders. | BIG-IP_v11.0.0 |
| get_description | Gets the description for a set of folders. | BIG-IP_v11.0.0 |
| get_device_group | Gets the device group for a set of folders. | BIG-IP_v11.0.0 |
| get_list | Gets the names of all folders. | BIG-IP_v11.0.0 |
| get_no_reference_check_state | Gets whether strict device group reference validation is performed during sync behavior on items in this folder. | BIG-IP_v11.2.0 |
| get_traffic_group | Gets the name of the folder&aposs traffic group. Note that if the keyword “default” was used to set the traffic group, the value returned here will be the actual name of the traffic group that was inherited. | BIG-IP_v11.2.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.0.0 |
| is_device_group_inherited | Gets whether the value returned by get_device_group was inherited from the parent folder. | BIG-IP_v11.2.0 |
| is_traffic_group_inherited | Gets a flag indicating whether the traffic group was inherited from the parent folder. | BIG-IP_v11.2.0 |
| set_description | Sets the description for a set of folders. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_device_group | Sets the device group for a set of folders. The device group specifies the set of devices for which the objects contained in the folder are kept synchronized. | BIG-IP_v11.0.0 |
| set_no_reference_check_state | Sets whether strict device group reference validation is performed during sync behavior on items in this folder. | BIG-IP_v11.2.0 |
| set_traffic_group | Sets the traffic group that will be used for failover. | BIG-IP_v11.2.0 |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.