GlobalLB::WideIPV2¶
Introduced : BIG-IP_v12.0.0
The WideIPV2 interface enables you to work with typed wide IPs and
their settings, along with their typed wide IP pools, wide IP aliases
and wide IP rules. This interface allows for greater flexibility and
more granular control over the responses that GTM sends. Typed wide
IPs (like A, AAAA, CNAME, MX, SRV, and NAPTR) may contain pools only
of the same type. There is one exception to this rule, where CNAME
pools can actually be added to a wide IP of any type, not just CNAME
type wide IPs. Typed wide IPs can also be used to back non-terminal
pool members. While previously in the GlobalLB::Pool interface,
members were only virtual servers, in the PoolV2 interface we also
have non-terminal type members which must correspond (exactly or via
wide IP wildcard match) to an existing wide IP of the appropriate
type. For the specifics of which type of wide IP is allowed to back
which type of non-terminal pool member, please see the
GlobalLB::PoolV2 documentation.
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_v12.0.0 |
| add_metadata | Adds the metadata for the specified wide IPs. | BIG-IP_v12.0.0 |
| add_wide_ip_pool | Adds/associates wide IP pools to the specified wide IPs. Typed wide IPs (like A, AAAA, CNAME, MX, SRV, and NAPTR) may contain pools only of the same type. There is one exception to this rule, where CNAME pools can be added to a wide IP of any type, not just CNAME type wide IPs. | BIG-IP_v12.0.0 |
| add_wide_ip_rule | Adds/associates wide IP rules to the specified wide IPs. A wide IP rule is a GTM iRule associated with a given wide IP. | BIG-IP_v12.0.0 |
| create | Creates the specified wide IPs with their respective load balancing methods. | BIG-IP_v12.0.0 |
| delete_all_wide_ips | Deletes all wide IPs. | BIG-IP_v12.0.0 |
| delete_wide_ip | Deletes the specified wide IPs. | BIG-IP_v12.0.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_v12.0.0 |
| get_all_statistics | Gets the statistics for all the wide IPs. | BIG-IP_v12.0.0 |
| get_description | Gets the descriptions for a set of wide IPs. | BIG-IP_v12.0.0 |
| get_enabled_state | Gets the enabled states for the specified wide IPs. | BIG-IP_v12.0.0 |
| get_failure_response_return_code | Gets the failure response return code of the specified wide IPs. | BIG-IP_v12.0.0 |
| get_failure_response_return_code_state | Gets the state indicating whether the system should return the failure response return code to failed wide IP requests. | BIG-IP_v12.0.0 |
| get_failure_response_return_code_ttl | Gets the failure response return code caching TTL values of the specified wide IPs. | BIG-IP_v12.0.0 |
| get_last_resort_pool | Gets the last resort pools for the specified wide IPs. | BIG-IP_v12.0.0 |
| get_lb_decision_log_verbosity | Gets the load balancing log verbosity for the specified wide IPs. | BIG-IP_v12.0.0 |
| get_lb_method | Gets the load balancing methods for the specified wide IPs. | BIG-IP_v12.0.0 |
| get_list | Gets a list of wide IPs. | BIG-IP_v12.0.0 |
| get_list_by_type | Gets a list of wide IPs of a specified type. | BIG-IP_v12.0.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 examples 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_v12.0.0 |
| get_metadata_description | Gets the metadata descriptions for the specified metadata. | BIG-IP_v12.0.0 |
| get_metadata_persistence | Gets the persistence for the specified metadata. | BIG-IP_v12.0.0 |
| get_metadata_value | Gets the metadata values for the specified metadata. | BIG-IP_v12.0.0 |
| get_minimal_response_state | Gets the minimal response state indicating whether GTM will return a minimal response (enabled) or GTM will attempt to chase the CNAME answers and/or enter A and AAAA records in the additional section of the response (disabled). | BIG-IP_v12.0.0 |
| get_object_status | Gets the statuses of the specified wide IPs. | BIG-IP_v12.0.0 |
| get_persistence_cidr_ipv4 | Gets the IPv4 CIDR mask that is used to group IPv4 LDNS addresseses to enable sharing a single persistence record. | BIG-IP_v12.0.0 |
| get_persistence_cidr_ipv6 | Gets the IPv6 CIDR mask that is used to group IPv6 LDNS addresseses to enable sharing a single persistence record. | BIG-IP_v12.0.0 |
| get_persistence_state | Gets the states indicating whether to maintain a connection between an LDNS and a particular virtual server. | BIG-IP_v12.0.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_v12.0.0 |
| get_statistics | Gets the statistics for the specified wide IPs. | BIG-IP_v12.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v12.0.0 |
| get_wide_ip | Gets the lists of wide IPs associated with the specified aliases. Each alias maps to exactly one wide IP. | BIG-IP_v12.0.0 |
| get_wide_ip_pool | Gets the lists of wide IP pools the specified wide IPs are associated with. | BIG-IP_v12.0.0 |
| get_wide_ip_pool_order | Gets the order of the specified wide IP pools on the specified wide IPs. | BIG-IP_v12.0.0 |
| get_wide_ip_pool_ratio | Gets the ratio of the specified wide IP pools on the specified wide IPs. | BIG-IP_v12.0.0 |
| get_wide_ip_rule | Gets the lists of wide IP rules the specified wide IPs are associated with. | BIG-IP_v12.0.0 |
| get_wide_ip_rule_priority | Gets the priority of the specified list of wide IP rules that the specified wide IPs are associated with. | BIG-IP_v12.0.0 |
| remove_alias | Removes aliases from the specified wide IPs. A given wide IP can have more than one alias. | BIG-IP_v12.0.0 |
| remove_all_aliases | Removes all aliases from the specified wide IPs. | BIG-IP_v12.0.0 |
| remove_all_metadata | Removes all the metadata instances for the specified wide IPs. | BIG-IP_v12.0.0 |
| remove_all_wide_ip_pools | Removes all wide IP pools from the specified wide IPs. | BIG-IP_v12.0.0 |
| remove_all_wide_ip_rules | Removes all wide IP rules from the specified wide IPs. | BIG-IP_v12.0.0 |
| remove_metadata | Removes the metadata for the specified wide IPs and names. | BIG-IP_v12.0.0 |
| remove_wide_ip_pool | Removes wide IP pools from the specified wide IPs. | BIG-IP_v12.0.0 |
| remove_wide_ip_rule | Removes wide IP rules from the specified wide IPs. | BIG-IP_v12.0.0 |
| reset_statistics | Resets the statistics for the specified wide IPs. | BIG-IP_v12.0.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_v12.0.0 |
| set_enabled_state | Sets the enabled states for the specified wide IPs. | BIG-IP_v12.0.0 |
| set_failure_response_return_code | Sets the failure response return code of the specified wide IPs. The default value is RETURN_CODE_NO_ERROR. | BIG-IP_v12.0.0 |
| set_failure_response_return_code_state | Sets the state indicating whether the system should return the failure response return code to failed wide IP requests. With this option enabled, the system responds faster to requests for which it does not have a pool or pool member available on the respective wide IP. The default is disabled. | BIG-IP_v12.0.0 |
| set_failure_response_return_code_ttl | Sets the failure response return code 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. The default value is 0. | BIG-IP_v12.0.0 |
| set_last_resort_pool | Sets the last resort pools for the specified wide IPs. This pool is used if all other wide IP pools are unavailable. | BIG-IP_v12.0.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_v12.0.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_v12.0.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. | BIG-IP_v12.0.0 |
| set_metadata_persistence | Sets the persistence for the specified metadata. | BIG-IP_v12.0.0 |
| set_metadata_value | Sets the values for the specified metadata. | BIG-IP_v12.0.0 |
| set_minimal_response_state | Sets the minimal response state indicating whether GTM will return a minimal response (enabled) or GTM will attempt to chase the CNAME answers and/or enter A and AAAA records in the additional section of the response (disabled). The default is enabled minimal response. | BIG-IP_v12.0.0 |
| set_persistence_cidr_ipv4 | Sets the mask, according to CIDR notation, that is used to group IPv4 LDNS addresses. This allows one persistence record to be shared by LDNS IPv4 addresses that match within this mask. The default is 32, i.e. no address overlap. | BIG-IP_v12.0.0 |
| set_persistence_cidr_ipv6 | Sets the mask, according to CIDR notation, that is used to group IPv6 LDNS addresses. This allows one persistence record to be shared by LDNS IPv6 addresses that match within this mask. The default is 128, i.e. no address overlap. | BIG-IP_v12.0.0 |
| set_persistence_state | Sets the states indicating whether to maintain a connection between an LDNS (local DNS server that makes DNS requests on behalf of a client) and a particular virtual server. | BIG-IP_v12.0.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_v12.0.0 |
| set_wide_ip_pool_order | Sets the order of the specified wide IP pools on the specified wide IPs. All wide IP pools on a given wide IP are reordered starting with 0, with no gaps, so the system maintains the relative order for load balancing purposes but not the absolute numbers originally specified for ordering. | BIG-IP_v12.0.0 |
| set_wide_ip_pool_ratio | Sets the ratio of the specified wide IP pools on the specified wide IPs. The ratio is used with the load balancing method LB_METHOD_RATIO to select pools according to the ratios assigned to each given wide IP pool. | BIG-IP_v12.0.0 |
| set_wide_ip_rule_priority | Sets the priority of the specified list of wide IP rules that the specified wide IPs are associated with. | BIG-IP_v12.0.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular wide IP.
A struct that describes wide IP statistics and timestamp.
Aliases¶
| Alias | Type | Description |
| 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.