APIRef_tm_gtm_rule¶
mgmt/tm/gtm/rule
GTM iRule configuration
REST Endpoints
- Collection URI
/mgmt/tm/gtm/rule- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/gtm/rule/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service that the object belongs to. | |
check |
string | optional | read/write | This attribute is only used by the iRule parser. | |
tmPartition |
string | optional | read/write | Specifies the partition within which this object resides. | |
when |
string | optional | read/write | This attribute is only used by the iRule parser. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/metadata |
array_structure | optional | read/write | User defined generic data for the rule. It is a name and value pair. | |
/metadata/app-service |
string | optional | read/write | The application service that the object belongs to. | |
/metadata/persist |
string | true | optional | read/write | Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files. |
/metadata/value |
string | optional | read/write | Value of the rule metadata |
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.