GlobalLB::Link¶
Introduced : BIG-IP_v9.2.0
The Link interface enables you to work with links within a data
center.
Methods¶
| Method | Description | Introduced |
| add_cost_segment | Adds the cost segments for the specified links. | BIG-IP_v9.2.0 |
| add_ip | Adds the IP addresses to the specified links. | BIG-IP_v9.2.0 |
| create | Creates the specified links. | BIG-IP_v9.2.0 |
| delete_all_links | Deletes all links. | BIG-IP_v9.2.0 |
| delete_link | Deletes the specified links. | BIG-IP_v9.2.0 |
| get_all_statistics | Gets the statistics for all the links. | BIG-IP_v9.2.0 |
| get_cost_segment | Gets the list of cost segments for the specified links. | BIG-IP_v9.2.0 |
| get_data_center | Gets the data centers that the specified links belong to. | BIG-IP_v9.2.0 |
| get_description | Gets the descriptions for a set of links. | BIG-IP_v11.0.0 |
| get_duplex_state | Gets the states indicating whether the specified links use duplex. | BIG-IP_v9.2.0 |
| get_enabled_state | Gets the enabled state of the specified links. | BIG-IP_v9.2.0 |
| get_inbound_limit | Gets the inbound limits for link metrics. | BIG-IP_v9.2.0 |
| get_ip | Gets the IP addresses that belong to the specified links. | BIG-IP_v9.2.0 |
| get_isp_name | Gets the ISP names for the specified links. | BIG-IP_v9.2.0 |
| get_list | Gets a list of links. | BIG-IP_v9.2.0 |
| get_monitor_association | Gets the monitor associations for the specified links, i.e. the monitor rules used by the links. | BIG-IP_v9.2.0 |
| get_object_status | Gets the statuses of the specified links. | BIG-IP_v9.2.0 |
| get_outbound_limit | Gets the outbound limits for link metrics. | BIG-IP_v9.2.0 |
| get_prepaid_traffic | Gets the prepaid traffic bandwidth values for the specified links. | BIG-IP_v9.2.0 |
| get_ratio | Gets the ratios used to load-balance the traffic for the specified links. | BIG-IP_v9.2.0 |
| get_statistics | Gets the statistics for the specified links. | BIG-IP_v9.2.0 |
| get_total_limit | Gets the total limits for link metrics. | BIG-IP_v9.2.0 |
| get_uplink_address | Gets the IP addresses on the uplink side of the router, used for SNMP probing only. | BIG-IP_v9.2.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.2.0 |
| get_weight_type | Gets the weight types for the specified links. | BIG-IP_v9.4.0 |
| remove_all_cost_segments | Removes any and all cost segment of the specified links. | BIG-IP_v9.2.0 |
| remove_cost_segment | Removes the cost segments for the specified links. | BIG-IP_v9.2.0 |
| remove_ip | Removes the IP addresses from the specified links. | BIG-IP_v9.2.0 |
| remove_monitor_association | Removes the monitor associations for the specified links. This basically deletes the monitor associations between a link and a monitor rule, i.e. the specified links will no longer be monitored. | BIG-IP_v9.2.0 |
| reset_statistics | Resets the statistics for the specified links. | BIG-IP_v9.2.0 |
| set_data_center | Moves the specified links to the new data centers. | BIG-IP_v9.2.0 |
| set_description | Sets the description for a set of links. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_duplex_state | Sets the states indicating whether the specified links use duplex. | BIG-IP_v9.2.0 |
| set_enabled_state | Sets the enabled state of the specified links. | BIG-IP_v9.2.0 |
| set_inbound_limit | Sets the inbound limits for link metrics. | BIG-IP_v9.2.0 |
| set_isp_name | Sets the ISP names for the specified links. | BIG-IP_v9.2.0 |
| set_monitor_association | Sets/creates the monitor associations for the specified links. This basically creates the monitor associations between a link and a monitor rule. | BIG-IP_v9.2.0 |
| set_outbound_limit | Sets the outbound limits for link metrics. | BIG-IP_v9.2.0 |
| set_prepaid_traffic | Sets the prepaid traffic bandwidth values for the specified links. | BIG-IP_v9.2.0 |
| set_ratio | Sets the ratios used to load-balance the traffic for the specified links. | BIG-IP_v9.2.0 |
| set_total_limit | Sets the total limits for link metrics. | BIG-IP_v9.2.0 |
| set_uplink_address | Sets the IP addresses on the uplink side of the router, used for SNMP probing only. | BIG-IP_v9.2.0 |
| set_weight_type | Sets the weight types for the specified links. | BIG-IP_v9.4.0 |
Structures¶
Structure
Description
A struct that contains definition for the link cost segment.
A struct that contains definition for the link and the associated IP addresses.
A struct that contains metric limits for a link.
A struct that describes statistics for a particular link.
A struct that describes link statistics and timestamp.
A struct that describes a link&aposs monitor association.
Aliases¶
| Alias | Type | Description |
| LinkCostSegmentSequence | LinkCostSegment [] | A sequence of LinkCostSegment&aposs. |
| LinkCostSegmentSequenceSequence | LinkCostSegment [] [] | An alias for a sequence of LinkCostSegment&aposs. |
| LinkIPSequence | LinkIPDefinition [] | A sequence of LinkIPDefinition&aposs. |
| LinkMetricLimitSequence | LinkMetricLimit [] | A sequence of LinkMetricLimit&aposs. |
| LinkStatisticEntrySequence | LinkStatisticEntry [] | A sequence of Link statistics. |
| MonitorAssociationSequence | MonitorAssociation [] | A sequence of monitor associations. |
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.