Management::DeviceGroup¶
Methods¶
| Method | Description | Introduced |
| add_device | Add devices to device groups. | BIG-IP_v11.0.0 |
| create | Creates device groups. | BIG-IP_v11.0.0 |
| delete_device_group | Deletes device groups. | BIG-IP_v11.0.0 |
| get_all_preferred_active | Gets the “all preferred active” flag for each device group. | BIG-IP_v11.0.0 |
| get_autosync_enabled_state | Gets the state of autosync for the device groups. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions of the device groups. | BIG-IP_v11.0.0 |
| get_device | Get devices from device groups. | BIG-IP_v11.0.0 |
| get_device_sync_status | Gets the sync status of the specified members in the specified device groups. | BIG-IP_v11.4.0 |
| get_failover_status | Gets the failover status of the system. This shows whether this device is active on any traffic groups (that is, currently handling traffic for them) or standby (ready to handle traffic if the active device fails over). | BIG-IP_v11.4.0 |
| get_full_load_on_sync_state | Gets the full load on sync states for each device group. | BIG-IP_v11.4.0 |
| get_incremental_config_sync_size_maximum | Gets the maximum number of kilobytes the system will devote to caching transactions for the specified device groups for incremental config sync. | BIG-IP_v11.4.0 |
| get_list | Gets a list of all device groups. | BIG-IP_v11.0.0 |
| get_network_failover_enabled_state | Gets the state of network failover for the device groups. | BIG-IP_v11.0.0 |
| get_sync_status | Gets the sync status of the specified device groups. | BIG-IP_v11.4.0 |
| get_sync_status_overview | Gets the sync status of the system. This gets the status of the current device&aposs presence in all device groups in which it is a member. If there is a communication problem with any device group, then this method will note it. Use the get_sync_status method in this interface to get information about connectivity and sync status for a particular device group. | BIG-IP_v11.4.0 |
| get_type | Gets the type of device group. | BIG-IP_v11.0.0 |
| get_version | Gets the interface version | BIG-IP_v11.0.0 |
| remove_all_devices | Remove all devices from device groups. | BIG-IP_v11.0.0 |
| remove_device | Remove devices from device groups. | BIG-IP_v11.0.0 |
| set_autosync_enabled_state | Sets the state of autosync for the device groups. If set, allows automatic synchronization between the devices in the device group. | BIG-IP_v11.0.0 |
| set_description | Sets the descriptions for the device groups. | BIG-IP_v11.0.0 |
| set_full_load_on_sync_state | Sets the full load on sync states for each device group. When enabled, device group members will perform a full load when synchronizing a configuration. When disabled, device group members will attempt incremental configuration synchronization and will automatically fall back to a full load when incremental configuration synchronization fails. | BIG-IP_v11.4.0 |
| set_incremental_config_sync_size_maximum | Sets the maximum number of kilobytes the system will devote to caching transactions for the specified device groups for incremental config sync. Users who make large changes to the configuration, or multiple changes to the configuration before synchronizing, may benefit from a larger value. The default value is 1024 KB. | BIG-IP_v11.4.0 |
| set_network_failover_enabled_state | Sets the state of network failover for the device groups. If set, allows failover daemon to communicate with the devices in the device group to determine whether they are running. | BIG-IP_v11.0.0 |
Structures¶
Structure
Description
A representation of a particular revision of the configuration.
A representation of a device&aposs sync status in a given device group.
A representation of the current device&aposs failover status. status, summary, and details are descriptive strings and are not meant for programmatic use. Their formats are subject to change in future BIG-IP releases.
The sync status summary of the BIG-IP, or of a single device group on the BIG-IP. status, summary, and details are descriptive strings and are not meant for programmatic use. Their formats are subject to change in future BIG-IP releases.
Enumerations¶
| Enumeration | Description |
| DeviceSyncType | An enum of device sync types. |
| MemberState | An enum of device group member states. |
| StatusColor | An enum of device status colors. |
| Type | A enum of device group types. |
Aliases¶
| Alias | Type | Description |
| DeviceSyncStatusSequence | DeviceSyncStatus [] | A sequence of device group member sync status entries. |
| DeviceSyncStatusSequenceSequence | DeviceSyncStatus [] [] | A sequence of sequences of device group member sync status entries. |
| SyncStatusSequence | SyncStatus [] | A sequence of sync status summaries. |
| TypeSequence | Type [] | A sequence of device group types. |
See Also¶
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.