gtm pool srv
gtm pool srv(1) BIG-IP TMSH Manual gtm pool srv(1)
NAME
srv - Configures SRV load balancing pools for the Global Traffic Manager(tm).
MODULE
gtm pool
SYNTAX
Modify the Global Traffic Manager pool srv component within the gtm module using the syntax shown in the
following sections.
CREATE/MODIFY
create pool srv [name]
modify pool srv [name]
options:
alternate-mode [drop-packet | global-availability
| none | packet-rate | ratio | return-to-dns | round-robin
| static-persistence | topology | virtual-server-capacity
| virtual-server-score]
app-service [[string] | none]
description [string]
[disabled | enabled]
dynamic ratio [disabled | enabled]
fallback-mode [completion-rate | cpu | drop-packet
| fewest-hops | global-availability | kilobytes-per-second
| least-connections | lowest-round-trip-time | none
| packet-rate | quality-of-service | ratio | return-to-dns
| round-robin | static-persistence | topology
| virtual-server-capacity | virtual-server-score]
load-balancing-mode [completion-rate | cpu | drop-packet
| fewest-hops | global-availability
| kilobytes-per-second | least-connections
| lowest-round-trip-time | packet-rate | quality-of-service
| ratio | return-to-dns | round-robin | static-persistence
| topology | virtual-server-capacity | virtual-server-score]
manual-resume [disabled | enabled]
max-answers-returned [integer]
members none
members
[ add | delete | modify | replace-all-with ] {
[member-dname] {
options:
app-service [[string] | none]
description [string]
[disabled | enabled]
member-order [integer]
port [integer]
priority [integer]
ratio [integer]
weight [integer]
}...
}
metadata none
metadata
[add | delete | modify | replace-all-with] {
[metadata_name ... ] {
app-service [[string] | none]
persist [ true | false ]
value [ "value content" ]
}
}
qos-hit-ratio [integer]
qos-hops [integer]
qos-kilobytes-second [integer]
qos-lcs [integer]
qos-packet-rate [integer]
qos-rtt [integer]
qos-topology [integer]
qos-vs-capacity [integer]
qos-vs-score [integer]
ttl [integer]
verify-member-availability [disabled | enabled]
edit pool srv [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
reset-stats pool srv
reset-stats pool srv [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list pool srv
list pool srv [ [ [name] | [glob] | [regex] ] ... ]
show running-config pool srv
show running-config pool srv [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
members member-dname
one-line
partition
show pool srv
show pool srv [name]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
detail
field-fmt
DELETE
delete pool srv [name]
Note: You must remove all references to a pool before you can delete the pool.
DESCRIPTION
You can use the pool component to configure the SRV pool definitions on the Global Traffic Manager. You use a
pool to group member names together to use a common load balancing algorithm.
EXAMPLES
create pool srv mypool members add {
imap.mydomain.com {
port 143
priority 20
}
}
Creates a Global Traffic Manager SRV pool with one member imap.mydomain.com with port 143 and priority 20
using the Round Robin load balancing method.
delete pool srv my_pool
Deletes the pool my_pool.
show pool srv
Displays statistics for all SRV pools.
list pool srv my_pool
Displays settings of pool my_pool.
OPTIONS
alternate-mode
Specifies the load balancing mode that the system uses to load balance name resolution requests among the
members of this pool, if the preferred method is unsuccessful in picking a pool. You set the preferred
mode using the load-balancing-mode option. The default value is round-robin.
The options are:
drop-packet
Specifies that the Global Traffic Manager does nothing with the packet, and simply drops the
request.
global-availability
Specifies that the Global Traffic Manager distributes connection requests to virtual servers
included in the pool in the order in which they are listed.
none Specifies that the system skips the alternate load balancing mode and immediately tries the load
balancing mode specified in the fallback-mode option.
Note that if the value of the fallback-mode option is none, and you have multiple pools configured,
the Global Traffic Manager uses the next available pool.
packet-rate
Specifies that the Global Traffic Manager assigns connection requests to the virtual server that is
currently processing the fewest number of packets per second.
ratio
Specifies that the Global Traffic Manager distributes connection requests among a pool of virtual
servers using a weighted Round Robin load balancing method.
return-to-dns
Specifies that the Global Traffic Manager immediately returns connection requests to the Local DNS
for resolution.
round-robin
Specifies that the Global Traffic Manager distributes connection requests in a circular and
sequential pattern among the virtual servers in a pool.
static-persistence
Specifies that the Global Traffic Manager consistently maps an LDNS IP address to the same available
virtual server for the duration of a session.
topology
Specifies that the Global Traffic Manager uses proximity-based load balancing to distribute
connection requests.
virtual-server-capacity
Specifies that the Global Traffic Manager assigns connection requests to virtual servers based on a
user-defined ranking system.
virtual-server-score
Specifies that the Global Traffic Manager assigns connection requests to virtual servers based on a
user-defined ranking system.
app-service
Specifies the name of the application service to which this pool belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete this pool. Only the application service can modify or delete this pool.
description
User defined description.
[disabled | enabled]
Specifies whether this pool is available for load balancing. The default value is enabled.
dynamic-ratio
Enables or disables a dynamic ratio load balancing algorithm for this pool. This option is applicable
only when you also configure the load-balancing-mode option for the pool with one of these dynamic load
balancing modes: completion-rate, fewest-hops, kilobytes-per-second, least-connections, lowest-round-
trip-times, quality-of-service, virtual-server-capacity, or virtual-server-score.
When this option is disabled (the default), 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.
fallback-mode
Specifies the load balancing mode that the system uses to load balance name resolution requests among the
members of this pool, if the preferred and alternate modes are unsuccessful in picking a pool. You set
the preferred mode using the load-balancing-mode option, and the alternate mode using the alternate-mode
option. The default value is return-to-dns.
The options are:
completion-rate
Specifies that the Global Traffic Manager selects the virtual server that currently maintains the
least number of dropped or timed-out packets during a transaction between a data center and the
client LDNS.
cpu Specifies that the Global Traffic Manager selects the virtual server that currently has the most CPU
processing time available to handle name resolution requests.
drop-packet
Specifies that the Global Traffic Manager does nothing with the packet, and simply drops the
request.
fewest-hops
Specifies that the Global Traffic Manager distributes connection requests to the virtual server in
the data center that has the fewest router hops from the Local DNS.
global-availability
Specifies that the Global Traffic Manager distributes connection requests to virtual servers
included in the pool in the order in which they are listed.
kilobytes-per-second
Specifies that the Global Traffic Manager distributes connection requests to the virtual server that
is currently processing the fewest number of kilobytes per second.
least-connections
Specifies that the Global Traffic Manager distributes connection requests to the virtual server on
the Local Traffic Manager that currently hosts the fewest connections.
lowest-round-trip-time
Specifies that the Global Traffic Manager distributes connection requests to the virtual server with
the fastest measured round trip time between a data center and a client LDNS.
none Specifies that there is no fallback mode. If the system cannot use the preferred or alternate load
balancing modes, it uses the next pool to resolve the request. If there are no more pools available,
the result is the same as when the value for the fallback-mode option is return-to-dns.
packet-rate
Specifies that the Global Traffic Manager assigns connection requests to the virtual server that is
currently processing the fewest number of packets per second.
quality-of-service
Specifies that the Global Traffic Manager distributes connection requests using current performance
information to calculate an overall score for each virtual server, and then distributes connections
to the virtual servers based on these scores.
ratio
Specifies that the Global Traffic Manager distributes connection requests among a pool of virtual
servers using a weighted Round Robin load balancing method.
return-to-dns
Specifies that the Global Traffic Manager immediately returns connection requests to the Local DNS
for resolution.
round-robin
Specifies that the Global Traffic Manager distributes connection requests in a circular and
sequential pattern among the virtual servers in a pool.
static-persistence
Specifies that the Global Traffic Manager consistently maps an LDNS IP address to the same available
virtual server for the duration of a session.
topology
Specifies that the Global Traffic Manager uses proximity-based load balancing to distribute
connection requests.
virtual-server-capacity
Specifies that the Global Traffic Manager distributes connection requests by creating a list of the
virtual servers, weighted by capacity, then picks one of the virtual servers from the list. The
virtual servers with the greatest capacity are picked most often, but over time all virtual servers
are returned.
virtual-server-score
Specifies that the Global Traffic Manager assigns connection requests to virtual servers based on a
user-defined ranking system.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
load-balancing-mode
Specifies the preferred load balancing mode that the system uses to load balance name resolution requests
among the members of this pool. The default value is round-robin.
The options are:
completion-rate
Specifies that the Global Traffic Manager selects the virtual server that currently maintains the
least number of dropped or timed-out packets during a transaction between a data center and the
client LDNS.
cpu Specifies that the Global Traffic Manager selects the virtual server that currently has the most CPU
processing time available to handle name resolution requests.
drop-packet
Specifies that the Global Traffic Manager does nothing with the packet, and simply drops the
request.
fewest-hops
Specifies that the Global Traffic Manager distributes connection requests to the virtual server in
the data center that has the fewest router hops from the Local DNS.
global-availability
Specifies that the Global Traffic Manager distributes connection requests to virtual servers
included in the pool in the order in which they are listed.
kilobytes-per-second
Specifies that the Global Traffic Manager distributes connection requests to the virtual server that
is currently processing the fewest number of kilobytes per second.
least-connections
Specifies that the Global Traffic Manager distributes connection requests to the virtual server on
the Local Traffic Manager that currently hosts the fewest connections.
lowest-round-trip-time
Specifies that the Global Traffic Manager distributes connection requests to the virtual server with
the fastest measured round trip time between a data center and a client LDNS.
packet-rate
Specifies that the Global Traffic Manager assigns connection requests to the virtual server that is
currently processing the fewest number of packets per second.
quality-of-service
Specifies that the Global Traffic Manager distributes connection requests using current performance
information to calculate an overall score for each virtual server, and then distributes connections
to the virtual servers based on these scores.
ratio
Specifies that the Global Traffic Manager distributes connection requests among a pool of virtual
servers using a weighted Round Robin load balancing method.
return-to-dns
Specifies that the Global Traffic Manager immediately returns connection requests to the Local DNS
for resolution.
round-robin
Specifies that the Global Traffic Manager distributes connection requests in a circular and
sequential pattern among the virtual servers in a pool.
static-persistence
Specifies that the Global Traffic Manager consistently maps an LDNS IP address to the same available
virtual server for the duration of a session.
topology
Specifies that the Global Traffic Manager uses proximity-based load balancing to distribute
connection requests.
virtual-server-capacity
Specifies that the Global Traffic Manager distributes connection requests by creating a list of the
virtual servers, weighted by capacity, then picks one of the virtual servers from the list. The
virtual servers with the greatest capacity are picked most often, but over time all virtual servers
are returned.
virtual-server-score
Specifies that the Global Traffic Manager assigns connection requests to virtual servers based on a
user-defined ranking system.
manual-resume
Enables or disables the manual resume function for this pool. If you leave this option disabled (the
default), then a member of this pool automatically becomes available for load balancing when its status
changes from down to up. When the manual-resume option is enabled, if the status of a member of this pool
changes from up to down, the pool member remains disabled indefinitely until you manually re-enable it.
max-answers-returned
Specifies the maximum number of available virtual servers that the system lists in a response. The
default value is 1.
members
Specifies the member-dname of the pool members. The default value is none.
You can also use the following options with pool members:
app-service
Specifies the name of the application service to which this pool member belongs. The default value
is none. Note: If the strict-updates option is enabled on the application service that owns the
object, you cannot modify or delete this pool member. Only the application service can modify or
delete this pool member.
description
User defined description.
[enabled | disabled]
Specifies whether this pool member is available for load balancing. The default value is enabled.
member-order
Specifies the order number of the pool member. The system uses this number with load balancing
methods that involve prioritizing pool members, such as the Ratio load balancing method.
port Specifies the response resource record's port RDATA field value when this member is picked.
priority
Specifies the response resource record's priority RDATA field value when this member is picked. The
default value is 10.
ratio
Specifies the relative weight of the pool member for load balancing purposes.
weight
Specifies the response resource record's weight RDATA field value when this member is picked. The
default value is 10.
member-dname
Displays the member's DNAME.
metadata
Associates user defined data, each of which has name and value pair and persistence. Persistent(default)
means the data will be saved into config file.
name Specifies a unique name for the component. This option is required for the commands create and modify.
partition
Displays the partition within which the component resides.
qos-hit-ratio
Assigns a weight to the Hit Ratio performance factor for the Quality of Service dynamic load balancing
mode. The default value is 5.
qos-hops
Assigns a weight to the Hops performance factor when the value of the either the load-balancing-mode or
fallback-mode options is quality-of-service. The default value is 0 (zero).
qos-kilobytes-second
Assigns a weight to the Kilobytes per Second performance factor when the value of the either the load-
balancing-mode or fallback-mode options is quality-of-service. The default value is 3.
qos-lcs
Assigns a weight to the Link Capacity performance factor when the value of the either the load-balancing-
mode or fallback-mode options is quality-of-service. The default value is 30.
qos-packet-rate
Assigns a weight to the Packet Rate performance factor when the value of the either the load-balancing-
mode or fallback-mode options is quality-of-service. The default value is 1.
qos-rtt
Assigns a weight to the Round Trip Time performance factor when the value of the either the load-
balancing-mode or fallback-mode options is quality-of-service. The default value is 50.
qos-topology
Assigns a weight to the Topology performance factor when the value of the either the load-balancing-mode
or fallback-mode options is quality-of-service. The default value is 0 (zero).
qos-vs-capacity
Assigns a weight to the Virtual Server performance factor when the value of the either the load-
balancing-mode or fallback-mode options is quality-of-service. The default value is 0 (zero).
qos-vs-score
Assigns a weight to the Virtual Server Score performance factor when the value of the either the load-
balancing-mode or fallback-mode options is quality-of-service. The default value is 0 (zero).
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at
sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
a description of regular expression syntax.
ttl Specifies the number of seconds that the answer, once found, is valid. Once the time-to-live (TTL)
expires, the client has to request name resolution again. The valid values are 0 through 4294967295; the
default value is 30.
verify-member-availability
Specifies that the system verifies the availability of the members before sending a connection to those
resources. The default value is enabled.
SEE ALSO
cli admin-partitions, create, delete, edit, glob, list, ltm virtual, modify, regex, reset-stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2016. All rights reserved.
BIG-IP 2016-04-28 gtm pool srv(1)