GlobalLB::Topology¶
Introduced : BIG-IP_v9.2.0
The Topology interface enables you to work with topology attributes.
For example, you can create and delete a topology. You can also use
the Topology interface to add virtual server entries to, or remove
virtual server entries from, a topology.
Methods¶
| Method | Description | Introduced |
| create | Adds or creates the specified topology records. | BIG-IP_v9.2.0 |
| delete_all_topology_records | Deletes all topology records. | BIG-IP_v9.2.0 |
| delete_topology_record | Deletes the specified topology records. | BIG-IP_v9.2.0 |
| get_description | Gets the description of the given topology records. | BIG-IP_v11.0.0 |
| get_list | Gets a list of of topology records. | BIG-IP_v9.2.0 |
| get_order | Gets the sort orders for the specified topology records. | BIG-IP_v9.2.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.2.0 |
| get_weight | Gets the weights for the specified links. | BIG-IP_v9.2.0 |
| set_description | Sets the description of the given topology records. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_order | Sets the sort orders used when longest match sorting is not available for the specified topology records. Note: As of version 11.0.0, the system computes the sort orders automatically, overriding any setting made here, when longest match sorting is enabled (and it is enabled by default; see GlobalLB::Globals). In previous releases, the orders set here were ignored then, but not recomputed. | BIG-IP_v9.2.0 |
| set_weight | Sets the weights for the specified topology records. | BIG-IP_v9.2.0 |
Structures¶
Structure
Description
A struct that describes a topology record&aposs end point
A struct that describes a record in topology list.
Aliases¶
| Alias | Type | Description |
| TopologyEndpointSequence | TopologyEndpoint [] | A sequence of Topology endpoints |
| TopologyRecordSequence | TopologyRecord [] | A sequence of Topology entries |
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.