APIRef_tm_cm_traffic-groupΒΆ
mgmt/tm/cm/traffic-group
Traffic-group configuration
REST Endpoints
- Collection URI
/mgmt/tm/cm/traffic-group- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/cm/traffic-group/~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. | |
autoFailbackEnabled |
string | optional | read/write | Set to true to enable auto-failback | |
autoFailbackTime |
integer | 60 | optional | read/write | Sets the time for auto-failback |
defaultDevice |
string | optional | read/write | ||
description |
string | optional | read/write | User-defined description | |
failoverMethod |
string | ha-order | optional | read/write | The failover method for this traffic group |
haGroup |
string | optional | read/write | Deprecated since v13.0.0. Please use monitor and failover-method instead. | |
haLoadFactor |
integer | 1 | optional | read/write | A value of the load the traffic-group presents the system relative to other traffic-groups. |
isFloating |
string | true | optional | read/write | Indicates whether the traffic group can fail over to other devices in the device group |
mac |
string | optional | read/write | Mac Address for the traffic-group | |
tmPartition |
string | Common | optional | read/write | Device administrative partition |
unitId |
integer | optional | read/write | Failover unit-id used by the traffic-group |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
haOrder (cm/device) |
array_structure | optional | read/write | The order in which devices will become active for the traffic-group |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/monitor |
array_structure | optional | read/write | ||
/monitor/ha-group |
string | optional | read/write | The name of HA group used to monitor this traffic group | |
/monitor/ha-group |
string | optional | read/write | The name of HA group used to monitor this traffic group |
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.