GlobalLB::WideIP¶
Introduced : BIG-IP_v9.2.0
The WideIP interface enables you to work with wide IPs, as well as
with the pools and the virtual servers that make them up. For example,
use the WideIP interface to get a list of wide IPs, to add a wide IP,
or to remove a wide IP.
Methods¶
| Method | Description | Introduced |
| add_alias | Adds/associates aliases to the specified wide IPs. A given wide IP can have more than one alias. | BIG-IP_v9.2.0 |
| add_metadata | Adds the metadata for the specified wide IPs. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| add_wideip_pool | Adds/associates wide IP pools to the specified wide IPs. | BIG-IP_v9.2.0 |
| add_wideip_rule | Adds/associates wide IP rules to the specified wide IPs. | BIG-IP_v9.2.0 |
| create | Creates the specified wide IPs with some basic attributes. | BIG-IP_v9.2.0 |
| delete_all_wideips | Deletes all wide IPs. | BIG-IP_v9.2.0 |
| delete_wideip | Deletes the specified wide IPs. | BIG-IP_v9.2.0 |
| get_alias | Gets the lists of aliases the specified wide IPs are associated with. A given wide IP can have more than one alias. | BIG-IP_v9.2.0 |
| get_all_statistics | Gets the statistics for all the wide IPs. | BIG-IP_v9.2.0 |
| get_application | Gets the names of the applications for the specified wide IPs. | BIG-IP_v9.2.0 |
| get_description | Gets the descriptions for a set of wide IPs. | BIG-IP_v11.0.0 |
| get_enabled_state | Gets the enabled states for the specified wide IPs. | BIG-IP_v9.2.0 |
| get_ipv6_no_error_negative_ttl | Gets the NoError negative caching TTL values of the specified wide IPs. | BIG-IP_v11.3.0 |
| get_ipv6_no_error_response_state | Gets the state indicating whether the system should return a NoError response to IPv6 wide IP requests. | BIG-IP_v11.0.0 |
| get_last_resort_pool | Gets the names of the last resort pools for the specified wide IPs. | BIG-IP_v9.2.0 |
| get_lb_decision_log_verbosity | Gets the load balancing log verbosity for the specified wide IPs. | BIG-IP_v11.3.0 |
| get_lb_method | Gets the load balancing methods for the specified wide IPs. | BIG-IP_v9.2.0 |
| get_list | Gets a list of wide IPs. | BIG-IP_v9.2.0 |
| get_metadata | Gets the user metadata for the specified wide IPs. 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 wide IPs. | BIG-IP_v9.2.0 |
| get_persistence_state | Gets the states indicating whether to maintain a connection between an LDNS and a particular virtual server. | BIG-IP_v9.2.0 |
| get_persistence_ttl | Gets the persistence TTL values of the specified wide IPs. These values (in seconds) indicate the time to maintain a connection between an LDNS and a particular virtual server. | BIG-IP_v9.2.0 |
| get_statistics | Gets the statistics for the specified wide IPs. | BIG-IP_v9.2.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.2.0 |
| get_wideip | Gets the lists of wide IPs associated with the specified aliases. Each alias maps to exactly one wide IP. | BIG-IP_v9.2.0 |
| get_wideip_pool | Gets the lists of wide IP pools the specified wide IPs are associated with. | BIG-IP_v9.2.0 |
| get_wideip_rule | Gets the lists of wide IP rules the specified wide IPs are associated with. | BIG-IP_v9.2.0 |
| remove_alias | Removes aliases from the specified wide IPs. A given wide IP can have more than one alias. | BIG-IP_v9.2.0 |
| remove_all_aliases | Removes all aliases from the specified wide IPs. | BIG-IP_v9.2.0 |
| remove_all_metadata | Removes all the metadata instances for the specified wide IPs. | BIG-IP_v11.2.0 |
| remove_all_wideip_pools | Removes all wide IP pools from the specified wide IPs. | BIG-IP_v9.2.0 |
| remove_all_wideip_rules | Removes all wide IP rules from the specified wide IPs. | BIG-IP_v9.2.0 |
| remove_metadata | Removes the metadata for the specified wide IPs and names. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| remove_wideip_pool | Removes wide IP pools from the specified wide IPs. | BIG-IP_v9.2.0 |
| remove_wideip_rule | Removes wide IP rules from the specified wide IPs. | BIG-IP_v9.2.0 |
| reset_application | Resets the names of the applications for the specified wide IPs (i.e., sets them to nothing). This function disassociates each wide IP given from any application. | BIG-IP_v9.4.8 |
| reset_statistics | Resets the statistics for the specified wide IPs. | BIG-IP_v9.2.0 |
| set_application | Sets the names of the applications for the specified wide IPs. | BIG-IP_v9.2.0 |
| set_description | Sets the description for a set of wide IPs. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_enabled_state | Sets the enabled states for the specified wide IPs. | BIG-IP_v9.2.0 |
| set_ipv6_no_error_negative_ttl | Sets the NoError negative caching TTL values of the specified wide IPs. These values (in seconds) indicate the time to maintain the negative answer by a downstream DNS cache. | BIG-IP_v11.3.0 |
| set_ipv6_no_error_response_state | Sets the state indicating whether the system should return a NoError response to IPv6 wide IP requests. This response is an authoritative empty answer from the system to AAAA record requests. With this option enabled, the system responds faster to IPv6 requests for which it does not have AAAA records configured. The default is disabled. | BIG-IP_v11.0.0 |
| set_last_resort_pool | Sets the names of the last resort pools for the specified wide IPs. | BIG-IP_v9.2.0 |
| set_lb_decision_log_verbosity | Sets the load balancing log verbosity for the specified wide IPs. The log reveals the reason why GTM makes a load-balancing decision. | BIG-IP_v11.3.0 |
| set_lb_method | Sets the load balancing methods for the specified wide IPs. This is used by the wide IPs when picking a pool to use when responding to a DNS request. | 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_persistence_state | Sets the states indicating whether to maintain a connection between an LDNS and a particular virtual server. | BIG-IP_v9.2.0 |
| set_persistence_ttl | Sets the persistence TTL values of the specified wide IPs. These values (in seconds) indicate the time to maintain a connection between an LDNS and a particular virtual server. | BIG-IP_v9.2.0 |
Structures¶
Structure
Description
A struct that describes a wide IP&aposs pool.
A struct that describes a wide IP&aposs rule.
A struct that describes statistics for a particular wide IP.
A struct that describes wide IP statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| LBDecisionLogVerbosity | An enum describing load balancing log verbosity. If a sequence of LBDecisionLogVerbosity contains duplicates (eg. [&aposLB_DECISION_PM_SELECTION&apos, &aposLB_DECISION_PM_SELECTION&apos]), they will be deduplicated. Note: If you set LB_DECISION_LOG_NONE or LB_DECISION_LOG_ALL, that must be the only specification. |
Aliases¶
| Alias | Type | Description |
| LBDecisionLogVerbositySequence | LBDecisionLogVerbosity [] | A sequence of LBDecisionLogVerbosity enums. |
| LBDecisionLogVerbositySequenceSequence | LBDecisionLogVerbosity [] [] | A sequence of sequence of LBDecisionLogVerbosity enums. |
| WideIPPoolSequence | WideIPPool [] | A sequence of wide IP&aposs pools. |
| WideIPPoolSequenceSequence | WideIPPool [] [] | An alias for a sequence of wide IP&aposs pools. |
| WideIPRuleSequence | WideIPRule [] | A sequence of wide IP&aposs rules. |
| WideIPRuleSequenceSequence | WideIPRule [] [] | An alias for a sequence of wide IP&aposs rules. |
| WideIPStatisticEntrySequence | WideIPStatisticEntry [] | A sequence of WideIP statistics. |
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.