GSLB_Pool (object)¶
Declares a pool to use for load balancing
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
class* | string | “GSLB_Pool” | ||
enabled | boolean | true | true, false | Specifies whether the pool and its resources are available for load balancing |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
lbModeAlternate | string | “round-robin” | “drop-packet”, “fallback-ip”, “global-availability”, “packet-rate”, “ratio”, “return-to-dns”, “round-robin”, “static-persistence”, “topology”, “virtual-server-capacity”, “virtual-server-score”, “none” | Alternate Load Balancing mode |
lbModeFallback | string | “return-to-dns” | “completion-rate”, “cpu”, “drop-packet”, “fallback-ip”, “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”, “none” | Fallback Load Balancing mode |
lbModePreferred | string | “round-robin” | “completion-rate”, “cpu”, “drop-packet”, “fallback-ip”, “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” | Preferred Load Balancing mode |
manualResumeEnabled | boolean | false | true, false | Specifies whether you must manually restart a pool member that goes down |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks | |
resourceRecordType* | string | “A”, “AAAA”, “CNAME”, “MX” | Specifies the type of resource records for this domain | |
ttl | integer | 30 | 0 - 4294967295 | Specifies the number of seconds the IP address, once found, is valid. Once the time-to-live (TTL) expires, the client has to request the IP address resolution again |
verifyMemberEnabled | boolean | true | true, false | Specifies the system verifies the availability of the pool members before sending a connection to those resources |
GSLB_Pool_Member_A (object)¶
Declares member of the GSLB pool
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
dependsOn | string, array | Specifies the name of the virtual server on which this pool member depends. | ||
enabled | boolean | true | true, false | When true (default), the system can use the pool member and its resources for load balancing requests |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
ratio | integer | 1 | 0 - 65535 | Specifies the ratio weight assigned to the pool member. This weight determines the frequency at which the pool member is selected for load balancing |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks | |
server* | object | Reference to a GSLB server | ||
virtualServer* | Specifies that the Global Traffic Manager assigns connection requests to virtual servers based on a user-defined ranking system. |
GSLB_Pool_Member_A.server (object)¶
Reference to a GSLB server
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP GSLB server | |
use | string | AS3 pointer to GSLB server declaration |
GSLB_Pool_Member_AAAA (object)¶
Declares member of the GSLB pool
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
dependsOn | string, array | Specifies the name of the virtual server on which this pool member depends. | ||
enabled | boolean | true | true, false | When true (default), the system can use the pool member and its resources for load balancing requests |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
ratio | integer | 1 | 0 - 65535 | Specifies the ratio weight assigned to the pool member. This weight determines the frequency at which the pool member is selected for load balancing |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks | |
server* | object | Reference to a GSLB server | ||
virtualServer* | Specifies that the Global Traffic Manager assigns connection requests to virtual servers based on a user-defined ranking system. |
GSLB_Pool_Member_AAAA.server (object)¶
Reference to a GSLB server
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP GSLB server | |
use | string | AS3 pointer to GSLB server declaration |
GSLB_Pool_Member_CNAME (object)¶
Declares member of the GSLB pool
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
domainName* | Specifies the domain name for this pool member | |||
enabled | boolean | true | true, false | When true (default), the system can use the pool member and its resources for load balancing requests |
isDomainNameStatic | boolean | false | true, false | Specifies that the member’s name specifies a static domain name rather than a name linked to a domain defined on the system. This might be required if the target domainName is not owned by the organization or configured on the BIG-IP. One side-effect of using a static target is that the member is always considered available for load balancing. The default is (false) disabled |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
ratio | integer | 1 | 0 - 65535 | Specifies the ratio weight assigned to the pool member. This weight determines the frequency at which the pool member is selected for load balancing |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks |
GSLB_Pool_Member_MX (object)¶
Declares member of the GSLB pool
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
domainName* | Specifies the domain name for this pool member | |||
enabled | boolean | true | true, false | When true (default), the system can use the pool member and its resources for load balancing requests |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
priority | integer | 10 | 0 - 65535 | Specifies the MX resource record priority |
ratio | integer | 1 | 0 - 65535 | Specifies the ratio weight assigned to the pool member. This weight determines the frequency at which the pool member is selected for load balancing |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks |