Attribute | Value |
---|---|
Default Value | true |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | false |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Capability reference | |
Type | STRING |
Nillable | false |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | 1 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 0 |
Max | 2,147,483,647 |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | 10 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Capability reference | |
Type | LIST |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | / |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | DEFAULT |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Allowed Values | DEFAULT ALWAYS NEVER |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | 20 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Capability reference | |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | 10 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | true |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | false |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | false |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | 10 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Min | 1 |
Max | 2,147,483,647 |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
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-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. |
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. |
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. |
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. |
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. |
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. |
STRING
STRING
STRING
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. |
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. |
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. |