APIRef_tm_sys_folder¶
mgmt/tm/sys/folder
Folder configuration
REST Endpoints
- Collection URI
/mgmt/tm/sys/folder- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/folder/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service that the object belongs to. | |
description |
string | optional | read/write | User-defined description of the folder | |
deviceGroup |
string | default | optional | read/write | Associate this folder with a device failover group or device sync group. ‘default’ to associate this folder with its parent’s device group. ‘non-default’ to leave this field’s value untouched but disassociate this folder from its parent. |
hidden |
string | false | optional | read/write | Specifies if this folder will be hidden. If set to ‘true’, this folder will be hidden from standard command usage. Administrators can display, modify or remove hidden folders using the ‘-hidden’ option. |
inheritedDevicegroup |
string | false | optional | read/write | Read-only. Shows whether this folder will automatically remain with the same device-group as its parent folder. Use ‘device-group default’ or ‘device-group non-default’ to set this. |
inheritedTrafficGroup |
string | false | optional | read/write | Read-only. Shows whether this folder will automatically remain with the same traffic-group as its parent folder. Use ‘traffic-group default’ or ‘traffic-group non-default’ to set this. |
noRefCheck |
string | optional | read/write | Specifies whether strict device group reference validation is performed during sync behavior on items in this folder | |
trafficGroup |
string | default | optional | read/write | Associate this folder with a network failover group. ‘default’ to associate this folder with its parent’s device group. ‘non-default’ to leave this field’s value untouched but disassociate this folder from its parent. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.