Pool (object)

Declares a service pool

Properties (* = required):

name	type(s)	default	allowed values	description
allowNATEnabled	boolean	true	true, false	If true (default), NATs are automatically enabled for any connections using this pool.
allowSNATEnabled	boolean	true	true, false	If true (default), SNATs are automatically enabled for any connections using this pool.
class*	string		“Pool”
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
loadBalancingMode	string	“round-robin”	“dynamic-ratio-member”, “dynamic-ratio-node”, “fastest-app-response”, “fastest-node”, “least-connections-member”, “least-connections-node”, “least-sessions”, “observed-member”, “observed-node”, “predictive-member”, “predictive-node”, “ratio-least-connections-member”, “ratio-least-connections-node”, “ratio-member”, “ratio-node”, “ratio-session”, “round-robin”, “weighted-least-connections-member”, “weighted-least-connections-node”	Load-balancing mode
members	array			Set of Pool members
metadata	object			Useful datapoints for tracking, tagging, and organizing declarations.
minimumMembersActive	integer	1	0 - 65535	Pool is down when fewer than this number of members are up
minimumMonitors				Member is down when fewer than minimum monitors report it healthy. Specify ‘all’ to require all monitors to be up.
monitors	array			List of health monitors (each by name or BIG-IP AS3 pointer)
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
reselectTries	integer	0	0 - 65535	Maximum number of attempts to find a responsive member for a connection
serviceDownAction	string	“none”	“drop”, “none”, “reselect”, “reset”	Specifies connection handling when member is non-responsive
slowRampTime	integer	10	0 - 900	BIG-IP AS3 slowly the connection rate to a newly-active member slowly during this interval (seconds)

Pool.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

name	type(s)	default	allowed values	description
/*/	object

Pool.metadata./*/ (object)

Properties (* = required):

name	type(s)	default	allowed values	description
persist	boolean	true	true, false
value*	string

Basic_Monitor ()

Monitor definition

Pool_Member (object)

Declares a service-pool member

Properties (* = required):

name	type(s)	default	allowed values	description
/*/
addressDiscovery	string, object	“static”		Selects how server (node) addresses are discovered
adminState	string	“enable”	“enable”, “disable”, “offline”	Setting adminState to enable will create the node in an operational state. Set to disable to disallow new connections but allow existing connections to drain. Set to offline to force immediate termination of all connections.
bigip	string		“f5bigip” formatted string	If defined, pathname of existing BIG-IP node
connectionLimit	integer	0	0 - 2147483647	Maximum concurrent connections to member
dynamicRatio	integer	1	0 - 100	Specifies a range of numbers that you want the system to use in conjunction with the ratio load balancing method
enable	boolean	true	true, false	Maps to BIG-IP pool member state
metadata	object			Useful datapoints for tracking, tagging, and organizing declarations.
minimumMonitors				Member is down when fewer than minimum monitors report it healthy
monitors	array			List of monitors (each by name or BIG-IP AS3 pointer)
priorityGroup	integer	0	0 - 65535	Specifies the priority group within the pool for this pool member
rateLimit	integer	-1	-1 - 2147483647	Value zero prevents use of member
ratio	integer	1	0 - 100	Specifies the weight of the pool member for load balancing purposes
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
routeDomain	integer		0 - 65534	The Route Domain to use for the pool member
servicePort*	integer		0 - 65535	Service L4 port (optional port-discovery may override)
shareNodes	boolean	false	true, false	If enabled, nodes are created in /Common instead of the tenant’s partition

Pool_Member.addressDiscovery (string, object)

Selects how server (node) addresses are discovered

Default: “static”

Pool_Member.metadata (object)

Useful datapoints for tracking, tagging, and organizing declarations.

Properties (* = required):

name	type(s)	default	allowed values	description
/*/	object

Pool_Member.metadata./*/ (object)

Properties (* = required):

name	type(s)	default	allowed values	description
persist	boolean	true	true, false
value*	string