Management API Reference for proxy

Proxy resource coupled with single Undertow listener (and server) specifying load balancer discovery, its configuration and load balance factor provider. Multiple proxy configuration can be specified.

Children (1)

load-provider
- dynamic
- simple

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.mod_cluster.service	true	none

Attributes (26)

advertise - Whether to enable multicast-based advertise mechanism.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to enable multicast-based advertise mechanism.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

advertise-security-key - If specified, reverse proxy advertisements checksums will be verified using this value as a salt.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "If specified, reverse proxy advertisements checksums will be verified using this value as a salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : { "credential" : {"type" : "core"}, "mod_cluster-security" : {"type" : "modcluster"} }}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

advertise-socket - Name of socket binding to use for the advertise socket.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of socket binding to use for the advertise socket.", "expressions-allowed" : true, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.network.socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

auto-enable-contexts - If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

balancer - The name of the balancer on the reverse proxy to register with.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the balancer on the reverse proxy to register with.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

excluded-contexts - List of contexts to exclude from registration with the reverse proxies.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "List of contexts to exclude from registration with the reverse proxies.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

flush-packets - Whether to enable packet flushing on the reverse proxy.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to enable packet flushing on the reverse proxy.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

flush-wait - Time to wait before flushing packets on the reverse proxy.

Type	INT
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Time to wait before flushing packets on the reverse proxy.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

listener - The name of Undertow listener that will be registered with the reverse proxy.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of Undertow listener that will be registered with the reverse proxy.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.undertow.listener", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

load-balancing-group - Name of the load balancing group this node belongs to.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the load balancing group this node belongs to.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

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

Type	INT
Default Value	1
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	0
Max	2147483647
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" : true, "required" : false, "nillable" : true, "default" : 1, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

node-timeout - Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning an error.

Type	INT
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning an error.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

ping - Number of seconds for which to wait for a pong answer to a ping.

Type	INT
Default Value	10
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Number of seconds for which to wait for a pong answer to a ping.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "unit" : "SECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

proxies - List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.network.outbound-socket-binding", "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}}, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

proxy-url - Base URL for MCMP requests.

Type	STRING
Default Value	/
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Base URL for MCMP requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "/", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

session-draining-strategy - Session draining strategy used during undeployment of a web application.

Type	STRING
Default Value	DEFAULT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	NEVER ALWAYS DEFAULT
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Session draining strategy used during undeployment of a web application.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "DEFAULT", "allowed" : [ "DEFAULT", "ALWAYS", "NEVER" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

smax - Soft maximum idle connection count for reverse proxy.

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Soft maximum idle connection count for reverse proxy.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

socket-timeout - Timeout to wait for the reverse proxy to answer a MCMP message.

Type	INT
Default Value	20
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Timeout to wait for the reverse proxy to answer a MCMP message.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 20, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

ssl-context - Reference to the SSLContext to be used by mod_cluster.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the SSLContext to be used by mod_cluster.", "expressions-allowed" : true, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.ssl-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"ssl-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

status-interval - Number of seconds a STATUS message is sent from the application server to the proxy.

Type	INT
Default Value	10
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Number of seconds a STATUS message is sent from the application server to the proxy.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

sticky-session - Indicates whether subsequent requests for a given session should be routed to the same node, if possible.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether subsequent requests for a given session should be routed to the same node, if possible.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

sticky-session-force - Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

sticky-session-remove - Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

stop-context-timeout - Maximum time to wait for context to process pending requests.

Type	INT
Default Value	10
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Maximum time to wait for context to process pending requests.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

ttl - Time to live (in seconds) for idle connections above smax.

Type	INT
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Time to live (in seconds) for idle connections above smax.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

worker-timeout - Number of seconds to wait for a worker to become available to handle a request.

Type	INT
Unit	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Number of seconds to wait for a worker to become available to handle a request.", "expressions-allowed" : true, "required" : false, "nillable" : true, "unit" : "SECONDS", "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (15)

add - Add a proxy resource requiring an Undertow listener reference leaving the server in 'reload-required' state.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
advertise	BOOLEAN	false	true	true	Whether to enable multicast-based advertise mechanism.
advertise-security-key	STRING	false	true		If specified, reverse proxy advertisements checksums will be verified using this value as a salt.
advertise-socket	STRING	false	true		Name of socket binding to use for the advertise socket.
auto-enable-contexts	BOOLEAN	false	true	true	If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).
balancer	STRING	false	true		The name of the balancer on the reverse proxy to register with.
excluded-contexts	STRING	false	true		List of contexts to exclude from registration with the reverse proxies.
flush-packets	BOOLEAN	false	true	false	Whether to enable packet flushing on the reverse proxy.
flush-wait	INT	false	true		Time to wait before flushing packets on the reverse proxy.
listener	STRING	true	true		The name of Undertow listener that will be registered with the reverse proxy.
load-balancing-group	STRING	false	true		Name of the load balancing group this node belongs to.
max-attempts	INT	false	true	1	Maximum number of failover attempts by reverse proxy when sending the request to the backend server.
node-timeout	INT	false	true		Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning an error.
ping	INT	false	true	10	Number of seconds for which to wait for a pong answer to a ping.
proxies	LIST	false	false		List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
proxy-url	STRING	false	true	/	Base URL for MCMP requests.
session-draining-strategy	STRING	false	true	DEFAULT	Session draining strategy used during undeployment of a web application.
smax	INT	false	true		Soft maximum idle connection count for reverse proxy.
socket-timeout	INT	false	true	20	Timeout to wait for the reverse proxy to answer a MCMP message.
ssl-context	STRING	false	true		Reference to the SSLContext to be used by mod_cluster.
status-interval	INT	false	true	10	Number of seconds a STATUS message is sent from the application server to the proxy.
sticky-session	BOOLEAN	false	true	true	Indicates whether subsequent requests for a given session should be routed to the same node, if possible.
sticky-session-force	BOOLEAN	false	true	false	Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.
sticky-session-remove	BOOLEAN	false	true	false	Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.
stop-context-timeout	INT	false	true	10	Maximum time to wait for context to process pending requests.
ttl	INT	false	true		Time to live (in seconds) for idle connections above smax.
worker-timeout	INT	false	true		Number of seconds to wait for a worker to become available to handle a request.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a proxy resource requiring an Undertow listener reference leaving the server in 'reload-required' state.",
    "request-properties" : {
        "advertise" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to enable multicast-based advertise mechanism.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "advertise-security-key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "If specified, reverse proxy advertisements checksums will be verified using this value as a salt.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "advertise-socket" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of socket binding to use for the advertise socket.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.network.socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "auto-enable-contexts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If false, the contexts are registered with the reverse proxy as disabled, they need to be enabled manually by 'enable-context' operation or via mod_cluster_manager console (if available).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "balancer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the balancer on the reverse proxy to register with.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "excluded-contexts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "List of contexts to exclude from registration with the reverse proxies.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "flush-packets" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to enable packet flushing on the reverse proxy.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "flush-wait" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Time to wait before flushing packets on the reverse proxy.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "listener" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of Undertow listener that will be registered with the reverse proxy.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.undertow.listener",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "load-balancing-group" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the load balancing group this node belongs to.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "max-attempts" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Maximum number of failover attempts by reverse proxy when sending the request to the backend server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1,
            "min" : 0,
            "max" : 2147483647,
            "stability" : "default"
        },
        "node-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning an error.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "ping" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Number of seconds for which to wait for a pong answer to a ping.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "unit" : "SECONDS",
            "stability" : "default"
        },
        "proxies" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.network.outbound-socket-binding",
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "proxy-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Base URL for MCMP requests.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "/",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "session-draining-strategy" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Session draining strategy used during undeployment of a web application.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "DEFAULT",
            "allowed" : [
                "DEFAULT",
                "ALWAYS",
                "NEVER"
            ],
            "stability" : "default"
        },
        "smax" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Soft maximum idle connection count for reverse proxy.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "socket-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Timeout to wait for the reverse proxy to answer a MCMP message.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 20,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "ssl-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the SSLContext to be used by mod_cluster.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.ssl-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "status-interval" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Number of seconds a STATUS message is sent from the application server to the proxy.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "sticky-session" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether subsequent requests for a given session should be routed to the same node, if possible.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "sticky-session-force" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether the reverse proxy should run an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "sticky-session-remove" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether the reverse proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if sticky sessions are disabled.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "stop-context-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Maximum time to wait for context to process pending requests.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "ttl" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Time to live (in seconds) for idle connections above smax.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "worker-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Number of seconds to wait for a worker to become available to handle a request.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "unit" : "SECONDS",
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

add-proxy - Add a reverse proxy to the list of proxies to register with.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
host	STRING	true	false		Host of the reverse proxy.
port	INT	true	false		Port of the reverse proxy accepting MCMP commands.

Raw DMR model


{
    "operation-name" : "add-proxy",
    "description" : "Add a reverse proxy to the list of proxies to register with.",
    "request-properties" : {
        "host" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Host of the reverse proxy.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "port" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Port of the reverse proxy accepting MCMP commands.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min" : 1,
            "max" : 65535,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

disable - Tell reverse proxies that all contexts of the node can't process new requests.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "disable",
    "description" : "Tell reverse proxies that all contexts of the node can't process new requests.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

disable-context - Tell reverse proxies that the context can't process new requests.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
virtualhost	STRING	true	false		Name of the virtual host to disable context on.
context	STRING	true	false		Name of the context to disable.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "disable-context",
    "description" : "Tell reverse proxies that the context can't process new requests.",
    "request-properties" : {
        "virtualhost" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the virtual host to disable context on.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the context to disable.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

enable - Tell reverse proxies that all contexts on the node are ready to receive requests.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "enable",
    "description" : "Tell reverse proxies that all contexts on the node are ready to receive requests.",
    "request-properties" : {},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

enable-context - Tell reverse proxies that the context is ready to receive requests.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
virtualhost	STRING	true	false		Name of the virtual host to enable context for.
context	STRING	true	false		Name of the context to enable.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "enable-context",
    "description" : "Tell reverse proxies that the context is ready to receive requests.",
    "request-properties" : {
        "virtualhost" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the virtual host to enable context for.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the context to enable.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

list-proxies - List the reverse proxies this node is currently registered with.

Reply properties

Type

LIST

Value Type


STRING

Raw DMR model


{
    "operation-name" : "list-proxies",
    "description" : "List the reverse proxies this node is currently registered with.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        }
    },
    "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

read-proxies-configuration - Send a DUMP command to the reverse proxies and display the result.

Reply properties

Type

LIST

Value Type


STRING

Raw DMR model


{
    "operation-name" : "read-proxies-configuration",
    "description" : "Send a DUMP command to the reverse proxies and display the result.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        }
    },
    "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

read-proxies-info - Send an INFO command to the reverse proxies and display the result.

Reply properties

Type

LIST

Value Type


STRING

Raw DMR model


{
    "operation-name" : "read-proxies-info",
    "description" : "Send an INFO command to the reverse proxies and display the result.",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        }
    },
    "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

refresh - Refresh the node sending a new CONFIG message to the reverse proxies.

Raw DMR model


{
    "operation-name" : "refresh",
    "description" : "Refresh the node sending a new CONFIG message to the reverse proxies.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - Remove a proxy resource leaving the server in 'reload-required' state.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a proxy resource leaving the server in 'reload-required' state.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove-proxy - Remove the reverse proxy from the list of proxies to register with.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
host	STRING	true	false		Host of the reverse proxy.
port	INT	true	false		Port of the reverse proxy.

Raw DMR model


{
    "operation-name" : "remove-proxy",
    "description" : "Remove the reverse proxy from the list of proxies to register with.",
    "request-properties" : {
        "host" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Host of the reverse proxy.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "port" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Port of the reverse proxy.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min" : 1,
            "max" : 65535,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "access-constraints" : {"sensitive" : {"mod_cluster-proxies" : {"type" : "modcluster"}}},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

reset - Reset the node's connection to the reverse proxies.

Raw DMR model


{
    "operation-name" : "reset",
    "description" : "Reset the node's connection to the reverse proxies.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

stop - Tell reverse proxies that all contexts on the node can't process requests.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
waittime	INT	false	false	10	Number of seconds for which to wait for sessions to drain before stopping all contexts if session draining is in effect. Negative or zero timeout value will wait indefinitely.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "stop",
    "description" : "Tell reverse proxies that all contexts on the node can't process requests.",
    "request-properties" : {"waittime" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "INT"
        },
        "description" : "Number of seconds for which to wait for sessions to drain before stopping all contexts if session draining is in effect. Negative or zero timeout value will wait indefinitely.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "default" : 10,
        "unit" : "SECONDS",
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

stop-context - Tell reverse proxies that the context can't process requests.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
virtualhost	STRING	true	false		Name of the virtual host to stop the context on.
context	STRING	true	false		Name of the context to stop.
waittime	INT	false	false	10	Number of seconds for which to wait for sessions to drain before stopping the context if session draining is in effect. Negative or zero timeout value will wait indefinitely.

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "stop-context",
    "description" : "Tell reverse proxies that the context can't process requests.",
    "request-properties" : {
        "virtualhost" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the virtual host to stop the context on.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the context to stop.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "waittime" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Number of seconds for which to wait for sessions to drain before stopping the context if session draining is in effect. Negative or zero timeout value will wait indefinitely.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "unit" : "SECONDS",
            "stability" : "default"
        }
    },
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.modcluster.proxy

        
<feature spec="subsystem.modcluster.proxy">
  <param name="proxy" value="{resource name}"/>
  <param name="advertise" value="{value}"/>
  <param name="advertise-security-key" value="{value}"/>
  <param name="advertise-socket" value="{value}"/>
  <param name="auto-enable-contexts" value="{value}"/>
  <param name="balancer" value="{value}"/>
  <param name="excluded-contexts" value="{value}"/>
  <param name="flush-packets" value="{value}"/>
  <param name="flush-wait" value="{value}"/>
  <param name="listener" value="{value}"/>
  <param name="load-balancing-group" value="{value}"/>
  <param name="max-attempts" value="{value}"/>
  <param name="node-timeout" value="{value}"/>
  <param name="ping" value="{value}"/>
  <param name="proxies" value="{value}"/>
  <param name="proxy-url" value="{value}"/>
  <param name="session-draining-strategy" value="{value}"/>
  <param name="smax" value="{value}"/>
  <param name="socket-timeout" value="{value}"/>
  <param name="ssl-context" value="{value}"/>
  <param name="status-interval" value="{value}"/>
  <param name="sticky-session" value="{value}"/>
  <param name="sticky-session-force" value="{value}"/>
  <param name="sticky-session-remove" value="{value}"/>
  <param name="stop-context-timeout" value="{value}"/>
  <param name="ttl" value="{value}"/>
  <param name="worker-timeout" value="{value}"/>
<feature/>