GlobalLB::PoolV2¶
Introduced : BIG-IP_v12.0.0
The PoolV2 interface enables you to work with typed pools and their
attributes. Typed pools (like A, AAAA, CNAME, MX, SRV, and NAPTR) may
contain members of the same type. This allows for greater flexibility
and more granular control over the responses that GTM sends.
Previously, in the GlobalLB::Pool interface, members were only virtual
servers. Now, in the PoolV2 interface, members can be virtual servers
(for type A or AAAA type pools) or non-terminal type members (for type
CNAME, MX, SRV, or NAPTR type pools). Non-terminal members are
specified with a required dname and some optional settings that depend
upon the type of non-terminal member. Except in the case of a CNAME
member with the static-target setting enabled, all non-terminal
members are backed by a corresponding wide IP. The dname of the
non-terminal member is non-folderized and must be a fully-qualified
domain name. The dname of the non-terminal member must match (exactly
or via wide IP wildcard match) the name of a corresponding wide IP
(without the folder name), except in the case mentioned above where
the non-terminal is a CNAME type member with static-target enabled.
Methods¶
| Method | Description | Introduced |
| add_member | Adds terminal members to the specified pools. Terminal members are virtual servers that have been added as members of an address type pool, A or AAAA. Terminal members representing IPv4 addresses can only be added to pools of type A and terminal members representing IPv6 addresses can only be added to pools of type AAAA. All members, both terminal and non-terminal, are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. | BIG-IP_v12.0.0 |
| add_member_dependency | Adds virtual server dependencies to the specified terminal members of the specified pools. If you add virtual servers as a dependency on a pool member, that pool member is only considered to be available if all of the member&aposs virtual server dependencies are also available. | BIG-IP_v12.0.0 |
| add_metadata | Adds the metadata for the specified pools. 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 uniquely 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 more information. | BIG-IP_v12.0.0 |
| add_non_terminal_member_cname | Adds CNAME type non-terminal members with their specified orders and static-target states. The parent pools must be of type CNAME. In the PoolV2 interface members can now also be non-terminal type members (no longer only virtual servers). Non-terminal members are specified with a required dname. The dname of the non-terminal member is non-folderized and must be a fully-qualified domain name. The dname of the non-terminal member must match (exactly or via wide IP wildcard match) the name of a corresponding wide IP of the correct type (without the folder name). Note that in the special case where static-target is enabled on a CNAME member, this member is not backed by a wide IP. The dname of CNAME type non-terminal members (with static-target disabled) must match the name of an existing A, AAAA, CNAME, MX, SRV, or NAPTR type wide IP. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. If static-target is enabled it means the non-terminal member is not backed by a wide IP and instead when the member is picked it simply returns the dname of the member as a static answer. Note: the default static-target setting is disabled. | BIG-IP_v12.0.0 |
| add_non_terminal_member_mx | Adds MX type non-terminal members with their specified orders. The parent pools must be of type MX. In the PoolV2 interface members can now also be non-terminal type members (no longer only virtual servers). Non-terminal members are specified with a required dname. The dname of the non-terminal member is non-folderized and must be a fully-qualified domain name. The dname of the non-terminal member must match (exactly or via wide IP wildcard match) the name of a corresponding wide IP of the correct type (without the folder name). The dname of MX type non-terminal members must match the name of an existing A or AAAA type wide IP. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. | BIG-IP_v12.0.0 |
| add_non_terminal_member_naptr | Adds NAPTR type non-terminal members with their specified orders, RDATA flags, and RDATA services. The parent pools must be of type NAPTR. In the PoolV2 interface members can now also be non-terminal type members (no longer only virtual servers). Non-terminal members are specified with a required dname. The dname of the non-terminal member is non-folderized and must be a fully-qualified domain name. The dname of the non-terminal member must match (exactly or via wide IP wildcard match) the name of a corresponding wide IP of the correct type (without the folder name). The dname of NAPTR type non-terminal members using the &aposs&apos flag must match the name of an existing SRV type wide IP. The dname of NAPTR type non-terminal members using the &aposa&apos flag must match the name of an existing A or AAAA type wide IP. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. The RDATA flags field must be specified and valid input is either &aposa&apos for address type or &aposs&apos for service type. The RDATA service field must be specified. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| add_non_terminal_member_srv | Adds SRV type non-terminal members with their specified orders, and RDATA ports. The parent pools must be of type SRV. In the PoolV2 interface members can now also be non-terminal type members (no longer only virtual servers). Non-terminal members are specified with a required dname. The dname of the non-terminal member is non-folderized and must be a fully-qualified domain name. The dname of the non-terminal member must match (exactly or via wide IP wildcard match) the name of a corresponding wide IP of the correct type (without the folder name). The dname of SRV type non-terminal members must match the name of an existing A or AAAA type wide IP. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. The RDATA port must be specified. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| create | Creates the specified pools. | BIG-IP_v12.0.0 |
| delete_all_pools | Deletes all pools. | BIG-IP_v12.0.0 |
| delete_pool | Deletes the specified pools. | BIG-IP_v12.0.0 |
| get_all_statistics | Gets the statistics for all the pools. | BIG-IP_v12.0.0 |
| get_alternate_lb_method | Gets the alternate load balancing methods for the specified pools. | BIG-IP_v12.0.0 |
| get_description | Gets the descriptions for a set of pools. | BIG-IP_v12.0.0 |
| get_dynamic_ratio_state | Gets the states to indicate whether to use dynamic ratio to modify the behavior of QOS. | BIG-IP_v12.0.0 |
| get_enabled_state | Gets the enabled state of the specified pools. | BIG-IP_v12.0.0 |
| get_fallback_ip | Gets the fallback/emergency failure address for the specified pools. | BIG-IP_v12.0.0 |
| get_fallback_lb_method | Gets the fallback load balancing methods for the specified pools. | BIG-IP_v12.0.0 |
| get_limit | Gets all metrics limits for a sequence of pools. | BIG-IP_v12.0.0 |
| get_list | Gets a list of all pools. | BIG-IP_v12.0.0 |
| get_list_by_type | Gets a list of pools of the specified GTM query types. | BIG-IP_v12.0.0 |
| get_manual_resume_state | Gets the states indicating whether to disable pool members when their pool member status goes from Green to Red. | BIG-IP_v12.0.0 |
| get_member | Gets the terminal members of a set of pools. | BIG-IP_v12.0.0 |
| get_member_dependency | Gets the virtual server dependencies from the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_member_description | Gets the description of a set of terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_member_enabled_state | Gets the enabled states for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_member_limit | Gets the metric limits for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_member_monitor_rule | Gets the monitor rules for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_member_monitor_rule_v2 | Gets the monitor rules for the specified terminal members of the specified pools. | BIG-IP_v13.0.0 |
| get_member_object_status | Gets the statuses for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_member_order | Gets the orders for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_member_ratio | Gets the ratios for the specified terminal members of the specified pools. This is used in weighting pool members for load balancing decisions. | BIG-IP_v12.0.0 |
| get_member_statistics | Gets the statistics for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_metadata | Gets the user metadata for the specified pools. | 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_monitor_rule | Gets the monitor rules for the specified pools. | BIG-IP_v12.0.0 |
| get_monitor_rule_v2 | Gets the monitor rules for the specified pools. | BIG-IP_v13.0.0 |
| get_non_terminal_member | Gets the non-terminal members of a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_description | Gets the description of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_enabled_state | Gets the enabled states for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_object_status | Gets the statuses for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_order | Gets the orders for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_ratio | Gets the ratios for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_flags | Gets the RDATA flags of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_order | Gets the RDATA order of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_port | Gets the RDATA port of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_preference | Gets the RDATA preference of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_priority | Gets the RDATA priority of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_service | Gets the RDATA service of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_rdata_weight | Gets the RDATA weight of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_static_target_state | Gets the static target state of a set of non-terminal pool members in a set of pools. | BIG-IP_v12.0.0 |
| get_non_terminal_member_statistics | Gets the statistics for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| get_object_status | Gets the availability statuses of the specified pools. | BIG-IP_v12.0.0 |
| get_preferred_lb_method | Gets the preferred load balancing methods for the specified pools. | BIG-IP_v12.0.0 |
| get_qos_coefficient_hit_ratio | Gets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_hops | Gets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_kbps | Gets the relative weight for kilobytes per second when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_link_capacity | Gets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_packet_rate | Gets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_rtt | Gets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_topology | Gets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_vs_capacity | Gets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_qos_coefficient_vs_score | Gets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS. | BIG-IP_v12.0.0 |
| get_returned_answers_count | Gets the number of answers to return for the specified pools. | BIG-IP_v12.0.0 |
| get_statistics | Gets the statistics for the specified pools. | BIG-IP_v12.0.0 |
| get_ttl | Gets the TTL values for the specified pools. | BIG-IP_v12.0.0 |
| get_verify_member_availability_state | Gets the states to indicate whether to check the availability of a pool member before using it. | BIG-IP_v12.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v12.0.0 |
| remove_all_member_dependencies | Removes all virtual server dependencies from the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| remove_all_members | Removes all members, both terminal and non-terminal, from the specified pools. | BIG-IP_v12.0.0 |
| remove_all_metadata | Removes all the metadata instances for the specified pools. | BIG-IP_v12.0.0 |
| remove_member | Removes terminal members from the specified pools. | BIG-IP_v12.0.0 |
| remove_member_dependency | Removes virtual server dependencies from the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| remove_metadata | Removes the metadata for the specified pools and names. | BIG-IP_v12.0.0 |
| remove_monitor_rule | Removes the monitor rules for the specified pools. The specified pools will no longer be monitored. | BIG-IP_v12.0.0 |
| remove_non_terminal_member | Removes non-terminal members from the specified pools. | BIG-IP_v12.0.0 |
| reset_member_statistics | Resets the statistics for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| reset_non_terminal_member_statistics | Resets the statistics for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| reset_statistics | Resets the statistics for the specified pools. | BIG-IP_v12.0.0 |
| set_alternate_lb_method | Sets the alternate load balancing methods for the specified pools. | BIG-IP_v12.0.0 |
| set_description | Sets the description for a set of pools. This is an arbitrary field which can be used for any purpose. | BIG-IP_v12.0.0 |
| set_dynamic_ratio_state | Sets the states to indicate whether to use dynamic ratio to modify the behavior of QOS. This option is disabled by default, and in that case the system uses only the server or virtual server with the best metrics, or highest quality of service (QoS) score, for load balancing. When dynamic ratio is enabled, the system treats QoS scores as ratios, and it uses each server or virtual server in proportion to the ratio determined by the QoS calculation. This option only applies when you are also using one of the following load balancing method on the given pool: LB_METHOD_HIT_RATIO, LB_METHOD_LOWEST_HOPS, LB_METHOD_BPS, LB_METHOD_LEAST_CONN, LB_METHOD_LOWEST_RTT, LB_METHOD_QOS, LB_METHOD_VS_CAPACITY, or LB_METHOD_VS_SCORE. | BIG-IP_v12.0.0 |
| set_enabled_state | Sets the enabled state of the specified pools. | BIG-IP_v12.0.0 |
| set_fallback_ip | Sets the fallback/emergency failure address for the specified pools. Note that this is only allowed and relevant to type A and AAAA pools. In such a case, you may only specify a sinlge address that matches the respective pool type, namely IPv4 for A and IPv6 for AAAA. | BIG-IP_v12.0.0 |
| set_fallback_lb_method | Sets the fallback load balancing methods for the specified pools. Note that the fallback IP load balancing method is only allowed and relevant to type A and AAAA pools. In that case there will only be a single address specified matching the respective pool type. | BIG-IP_v12.0.0 |
| set_limit | Sets the metric limits for a list of pools. The metric limits let users configure the allowed metric maximums for virtual servers that back terminal pool members on the given pool. If the allowed maximum for a given (enabled) limit is exceeded for a pool member, that pool member becomes unavailable until the virtual server backing it reports metrics that are less than the allowed maximums. Three types of limits can be set. These are the data throughput rate (in bits per second), the number of current connections, and the data transfer rate (in packets per second). The metric limits also allow the user to toggle the enforcement of these numerical limits between enabled and disabled. By default all three types of limits are disabled. | BIG-IP_v12.0.0 |
| set_manual_resume_state | Sets the states indicating whether to disable pool members when their pool member status goes from Green to Red. | BIG-IP_v12.0.0 |
| set_member_description | Sets the description of a set of pool terminal members in a set of pools. This is an arbitrary field which can be used for any purpose. | BIG-IP_v12.0.0 |
| set_member_enabled_state | Sets the enabled states for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| set_member_limit | Sets the metric limits for the specified terminal members of the specified pools. The metric limits let users configure the allowed metric maximums for virtual servers that back the given terminal pool members. If the allowed maximum for a given (enabled) limit is exceeded for a pool member, that pool member becomes unavailable until the virtual server backing it reports metrics that are less than the allowed maximums. Three types of limits can be set. These are the data throughput rate (in bits per second), the number of current connections, and the data transfer rate (in packets per second). The metric limits also allow the user to toggle the enforcement of these numerical limits between enabled and disabled. By default all three types of limits are disabled. | BIG-IP_v12.0.0 |
| set_member_monitor_rule | Sets the monitor rules for the specified terminal members of the specified pools. | BIG-IP_v12.0.0 |
| set_member_monitor_rule_v2 | Sets the monitor rules for the specified terminal members of the specified pools. | BIG-IP_v13.0.0 |
| set_member_order | Sets the orders for the specified terminal members of the specified pools. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. | BIG-IP_v12.0.0 |
| set_member_ratio | Sets the ratios for the specified terminal members of the specified pools. This is used in weighting pool members for load balancing decisions. | BIG-IP_v12.0.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. This is an arbitrary field which can be used for any purpose. | 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_monitor_rule | Sets/creates the monitor rules for the specified pools. The &aposnone&apos monitor is no longer a valid monitor_template for a MonitorRule. Any monitor rules created using the keyword &aposnone&apos will be adjusted and the &aposnone&apos monitor removed. | BIG-IP_v12.0.0 |
| set_monitor_rule_v2 | Sets/creates the monitor rules for the specified pools. The &aposnone&apos monitor is no longer a valid monitor_template for a MonitorRule. Any monitor rules created using the keyword &aposnone&apos will be adjusted and the &aposnone&apos monitor removed. | BIG-IP_v13.0.0 |
| set_non_terminal_member_description | Sets the description of a set of non-terminal pool members in a set of pools. This is an arbitrary field which can be used for any purpose. | BIG-IP_v12.0.0 |
| set_non_terminal_member_enabled_state | Sets the enabled states for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| set_non_terminal_member_order | Sets the orders for the specified non-terminal members of the specified pools. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. | BIG-IP_v12.0.0 |
| set_non_terminal_member_ratio | Sets the ratios for the specified non-terminal members of the specified pools. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_flags | Sets the RDATA flags of a set of non-terminal pool members in a set of pools. Note this is only valid for NAPTR type pool members. There is no default value. If specified, valid input is either &aposa&apos for address type or &aposs&apos for service type. The dname of NAPTR type non-terminal members using the &aposs&apos flag must match the name of an existing SRV type wide IP. The dname of NAPTR type non-terminal members using the &aposa&apos flag must match the name of an existing A or AAAA type wide IP. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_order | Sets the RDATA order of a set of non-terminal pool members in a set of pools. Note this is only valid for NAPTR type pool members. The default is 10. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_port | Sets the RDATA port of a set of non-terminal pool members in a set of pools. Note this is only valid for SRV type pool members. There is no default value. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_preference | Sets the RDATA preference of a set of non-terminal pool members in a set of pools. Note this is only valid for NAPTR type pool members. The default is 10. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_priority | Sets the RDATA priority of a set of non-terminal pool members in a set of pools. Note this is only valid for MX or SRV type pool members. The default is 10. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_service | Sets the RDATA service of a set of non-terminal pool members in a set of pools. Note this is only valid for NAPTR type pool members. There is no default value. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_rdata_weight | Sets the RDATA weight of a set of non-terminal pool members in a set of pools. Note this is only valid for SRV type pool members. The default is 10. RDATA is a field in a DNS resource record (RR). The contents of the RDATA field depend on the type of RR. For example an A type RR would contain an IPv4 address in the RDATA section while a CNAME type RR would contain the string name of an alias domain name. | BIG-IP_v12.0.0 |
| set_non_terminal_member_static_target_state | Sets the static target state of a set of non-terminal pool members in a set of pools. Note this is only valid for CNAME type pool members. The default is disabled (false). The dname of CNAME type non-terminal members (with static-target disabled) must match the name of an existing A, AAAA, CNAME, MX, SRV, or NAPTR type wide IP. | BIG-IP_v12.0.0 |
| set_preferred_lb_method | Sets the preferred load balancing methods for the specified pools. | BIG-IP_v12.0.0 |
| set_qos_coefficient_hit_ratio | Sets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS. The default is 5. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_hops | Sets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS. The default is 0. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_kbps | Sets the relative weight for virtual server performance metric kilobytes per second when the load balancing mode is set to LB_METHOD_QOS. The default is 3. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_link_capacity | Sets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS. The default is 30. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_packet_rate | Sets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS. The default is 1. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_rtt | Sets the relative weight for round-trip time performance factor when the load balancing mode is set to LB_METHOD_QOS. The default is 50. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (i.e. pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_topology | Sets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS. The default is 0. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_vs_capacity | Sets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS. The default is 0. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_qos_coefficient_vs_score | Sets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS. The default is 0. These weights help determine the importance of a given QoS (Quality of Service) metric in calculating a score that is used to pick pool members. For example, if you increase the RTT QoS coefficient on a given pool, the rtt performance metric will have a larger effect on the overall scores of the pool&aposs pool members (ie pool members with better/lower rtts will now be more likely to be picked). | BIG-IP_v12.0.0 |
| set_returned_answers_count | Sets the maximum number of answers to return for a given query answered from the specified pools. The default value is 1 and the maximum value is 16. Any answers returned beyond the first one are put in the additional records section of the response. For example, for an A or AAAA type query answered from a pool that is set to return 2 answers, an IP address is added to the response in the answer section and a second IP address is added to the additional record section of the response. The types of answers returned will vary with the type of the request. Note that for a CNAME type pool, setting the number of answers to return to a value greater than 1 is not allowed and will result in an error. | BIG-IP_v12.0.0 |
| set_ttl | Sets the TTL values for the specified pools. The TTL is the number of seconds that the answer is valid after it is found. When the TTL expires, the client has to request answer resolution again. The valid range for TTL is 0 though 4294967295 seconds; the default TTL is 30 seconds. | BIG-IP_v12.0.0 |
| set_verify_member_availability_state | Sets the states to indicate whether to check the availability of a pool member before using it. | BIG-IP_v12.0.0 |
Structures¶
Structure
Description
A struct that describes pool member statistics and a timestamp.
A struct that describes statistics for a particular pool.
A struct that describes pool statistics and a timestamp.
Aliases¶
| Alias | Type | Description |
| PoolStatisticEntrySequence | PoolStatisticEntry [] | A sequence of pool 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.