Management::TrafficGroup¶
Introduced : BIG-IP_v11.0.0
The Traffic Group interface contains the methods for creating and
manipulating traffic groups. Traffic groups are a means to associate
network objects with devices used in device failover.
Methods¶
| Method | Description | Introduced |
| add_ha_order | Adds/associates HA orders to the specified traffic groups. | BIG-IP_v11.4.0 |
| create | Creates traffic groups. | BIG-IP_v11.0.0 |
| delete_traffic_group | Deletes traffic groups. | BIG-IP_v11.0.0 |
| get_auto_failback_enabled_state | Gets the auto failback enabled states for the specified traffic groups. | BIG-IP_v11.0.0 |
| get_auto_failback_time | Gets the traffic group auto failback times for the specified traffic groups. | BIG-IP_v11.0.0 |
| get_default_device | This method has been deprecated, replaced by get_ha_order. Gets the default devices for the specified traffic groups. See the comments in the set_default_device method. The default device methods still work. The concept of default device has been replaced by the first device in the HA order list. Therefore, this get_default_device method returns the device in the HA order list that has order zero if there is such an entry. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions for the specified traffic groups. | BIG-IP_v11.0.0 |
| get_failover_method | Gets the failover method for the specified traffic groups. | BIG-IP_v13.0.0 |
| get_ha_group | This method has been deprecated. Please use get_monitor_ha_group instead. Gets the HA group for the specified traffic groups. | BIG-IP_v11.5.0 |
| get_ha_load_factor | Gets the traffic group HA load factors for the specified traffic groups. | BIG-IP_v11.4.0 |
| get_ha_order | Gets the lists of HA orders the specified traffic groups are associated with. If a specified traffic group is not associated with any HA order, then the list of HA order entries for that traffic group will be empty. | BIG-IP_v11.4.0 |
| get_is_floating | Gets the is floating state of the specified traffic group. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all traffic groups. | BIG-IP_v11.0.0 |
| get_mac_masquerade_address | Gets the MAC masquerade addresses for the specified traffic groups. | BIG-IP_v11.0.0 |
| get_monitor_ha_group | Gets the HA group monitor for the specified traffic groups. | BIG-IP_v13.0.0 |
| get_unit_id | Gets the unit IDs for the specified traffic groups. | BIG-IP_v11.0.0 |
| get_version | Gets the interface version. | BIG-IP_v11.0.0 |
| remove_all_ha_orders | Removes all HA order entries from the specified traffic groups. | BIG-IP_v11.4.0 |
| remove_ha_order | Removes HA order entries from the specified traffic groups. | BIG-IP_v11.4.0 |
| set_auto_failback_enabled_state | Sets the auto failback states for the specified traffic groups. | BIG-IP_v11.0.0 |
| set_auto_failback_time | Sets the auto failback times for the specified traffic groups. | BIG-IP_v11.0.0 |
| set_default_device | This method has been deprecated, please use add_ha_order instead. Sets the default devices for the specified traffic groups. The traffic group default device was used in earlier versions to indicate the device that had the highest priority to become active when a new active device needed to be chosen. This functionality has been subsumed and enhanced by a new traffic group attribute, the HA order. The HA order allows the user to specify a list of devices from the failover device group in the order in which they should become active for the traffic group (see the new HA order methods). The concept of default device has been replaced by the first device in the HA order list. Therefore, this set_default_device method places the device first in the HA order list after deleting any prior entries in the HA order list. | BIG-IP_v11.0.0 |
| set_description | Sets the description for the specified traffic groups. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_failover_method | Sets the failover method for the specified traffic groups. HA group must exist before this association. | BIG-IP_v13.0.0 |
| set_ha_group | This method has been deprecated. Please use set_monitor_ha_group instead. Using this deprecated method will also set the failover method to HA score. Sets and hence associates the HA groups with the specified traffic groups. If there is no such assocation, set the HA group name to “”. HA group must exist before this association. | BIG-IP_v11.5.0 |
| set_ha_load_factor | Sets the HA load factor for the specified traffic groups. The HA load factor has a value between 1 and 1000 inclusive and represents the amount of load (traffic, etc) the traffic group presents to the system. | BIG-IP_v11.4.0 |
| set_mac_masquerade_address | Sets the MAC masquerade addresses for the specified traffic groups. | BIG-IP_v11.0.0 |
| set_monitor_ha_group | Sets a HA group as monitor for the specified traffic groups. This attribute together with the failover method attribute determine the algorithm used to decide when the current device is not healthy enough and the new device that will take take over the respective traffic groups. The HA group must exist before this association. | BIG-IP_v13.0.0 |
Structures¶
Structure
Description
A struct that associates a devices with an ordinal value. A list of these structs is passed to the failover daemon. The list specifies the order in which the device will become active for the traffic group. It is optional so may have no entries or any number of entries up to the number of devices in the failover device group. In this interface the user is responsible for managing the order value. Undefined behaviour may result if the user specifies the same order value for two different devices for the same traffic group.
Enumerations¶
| Enumeration | Description |
| FailoverMethod | A enum of failover method. Specifies what mechanism to use to decide which device will take over when the current has failed. |
Aliases¶
| Alias | Type | Description |
| FailoverMethodSequence | FailoverMethod [] | A sequence of failover methods. |
| HAOrderSequence | HAOrder [] | A sequence of device orders. |
| HAOrderSequenceSequence | HAOrder [] [] | An alias of sequence of device orders. |
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.