Management API Reference for balancer

Runtime representation of a mod_cluster balancer

Stability Level: default

Children (2)

Attributes (7)

max-attempts - Maximum number of failover attempts by reverse proxy when sending the request to the backend server.

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Maximum number of failover attempts by reverse proxy when sending the request to the backend server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sticky-session - If sticky sessions are enabled

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If sticky sessions are enabled", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

- The session cookie name

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The session cookie name", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sticky-session-force - If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sticky-session-path - The path of the sticky session cookie

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path of the sticky session cookie", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sticky-session-remove - Remove the session cookie if the request cannot be routed to the correct host

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Remove the session cookie if the request cannot be routed to the correct host", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

wait-worker - The number of seconds to wait for an available worker

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of seconds to wait for an available worker", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`