GlobalLB::DataCenter¶
Introduced : BIG-IP_v9.2.0
The DataCenter interface enables you to manipulate the data center
attributes for a Global TM. For example, use the DataCenter interface
to add or remove a data center, transfer server assignments from one
data center to another, get and set data center attributes, remove a
server from a data center, and so on.
Methods¶
| Method | Description | Introduced |
| add_metadata | Adds the metadata for the specified data centers. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| create | Creates the specified data centers. | BIG-IP_v9.2.0 |
| delete_all_data_centers | Deletes all data centers. | BIG-IP_v9.2.0 |
| delete_data_center | Deletes the specified data centers. | BIG-IP_v9.2.0 |
| get_all_statistics | Gets the statistics for all the data centers. | BIG-IP_v9.2.0 |
| get_contact_information | Gets contact information for the specified data centers. | BIG-IP_v9.2.0 |
| get_description | Gets the descriptions for a set of data centers. | BIG-IP_v11.0.0 |
| get_enabled_state | Gets the enabled state of the specified data centers. | BIG-IP_v9.2.0 |
| get_link | Gets a list of links of the specified data centers. | BIG-IP_v9.2.0 |
| get_list | Gets a list of data centers. | BIG-IP_v9.2.0 |
| get_location_information | Gets location information for the specified data centers. | BIG-IP_v9.2.0 |
| get_metadata | Gets the user metadata for the specified data centers. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. | BIG-IP_v11.2.0 |
| get_metadata_description | Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_persistence | Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_value | Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_object_status | Gets the statuses of the specified data centers. | BIG-IP_v9.2.0 |
| get_prober_pool | Gets the prober pool for the specified data centers. | BIG-IP_v11.0.0 |
| get_prober_selection | Gets the prober selections for the specified data centers. | BIG-IP_v13.0.0 |
| get_server | Gets a list of servers of the specified data centers. | BIG-IP_v9.2.0 |
| get_statistics | Gets the statistics for the specified data centers. | BIG-IP_v9.2.0 |
| get_version | Get the version information for this interface. | BIG-IP_v9.2.0 |
| remove_all_metadata | Removes all the metadata instances for the specified data centers. | BIG-IP_v11.2.0 |
| remove_metadata | Removes the metadata for the specified data centers and names. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| reset_statistics | Resets the statistics for the specified data centers. | BIG-IP_v9.2.0 |
| set_contact_information | Sets contact information for the specified data centers. | BIG-IP_v9.2.0 |
| set_description | Sets the description for a set of data centers. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_enabled_state | Sets the enabled state of the specified data centers. | BIG-IP_v9.2.0 |
| set_location_information | Sets location information for the specified data centers. | BIG-IP_v9.2.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_persistence | Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_value | Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_prober_pool | Sets the prober pool for the specified data centers. (The system uses a Server&aposs Data Center prober pool, if specified, if a prober pool has not been set for the Server). | BIG-IP_v11.0.0 |
| set_prober_selection | Sets the prober selections for the specified data centers. Note that if prober selections are not set for a server, the prober selections for the data center are used. | BIG-IP_v13.0.0 |
Structures¶
Structure
Description
A struct that describes data center attributes: name, location, and contact information.
A struct that contains definition for the data center and the associated links.
A struct that contains definition for the data center and the associated servers.
A struct that describes statistics for a particular data center.
A struct that describes data center statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| DataCenterAttributeSequence | DataCenterAttribute [] | A sequence of data center attributes. |
| DataCenterLinkSequence | DataCenterLinkDefinition [] | A sequence of DataCenterLinkDefinition&aposs. |
| DataCenterServerSequence | DataCenterServerDefinition [] | A sequence of DataCenterServerDefinition&aposs. |
| DataCenterStatisticEntrySequence | DataCenterStatisticEntry [] | A sequence of DataCenter statistics. |
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.