WildFly Full 23 Model Reference

  1. home
  2. subsystem=modcluster
  3. 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 (2)

  • load-provider Load provider provides load calculations.
    • dynamic Configuration and runtime operations for mod_cluster subsystem.
    • simple Simple load provider returns constant pre-configured load balancing factor.
  • ssl The SSL configuration to client MCMP logic.
    • configuration Configuration and runtime operations for mod_cluster subsystem.

Provided capabilities(1)

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

none

Attributes (29)

  • advertise Whether to enable multicast-based advertise mechanism.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • advertise-security-key If specified, reverse proxy advertisements checksums will be verified using this value as a salt.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • advertise-socket Name of socket binding to use for the advertise socket.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    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).
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • balancer The name of the balancer on the reverse proxy to register with.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connector The name of Undertow listener that will be registered with the reverse proxy.
    • Deprecated Since 6.0.0
    Deprecated. Functions as alias for the 'listener' attribute.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • excluded-contexts List of contexts to exclude from registration with the reverse proxies.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • flush-packets Whether to enable packet flushing on the reverse proxy.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • flush-wait Time to wait before flushing packets on the reverse proxy.
    • Attribute Value
    Default Value -1
    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
  • listener The name of Undertow listener that will be registered with the reverse proxy.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • load-balancing-group Name of the load balancing group this node belongs to.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-attempts Maximum number of failover attempts by reverse proxy when sending the request to the backend server.
    • 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
  • 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.
    • Attribute Value
    Default Value -1
    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
  • ping Number of seconds for which to wait for a pong answer to a ping.
    • Attribute Value
    Default Value 10
    Type INT
    Nillable true
    Expressions Allowed true
    Unit SECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • proxies List of reverse proxies for mod_cluster to register with defined by 'outbound-socket-binding' in 'socket-binding-group'.
    • Attribute Value
    Capability reference
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • proxy-list List of reverse proxies to register with. Format (hostname:port) separated with commas.
    • Deprecated Since 2.0.0
    The 'proxy-list' attribute has been deprecated in favor of proxies (list of references to outbound-socket-binding)
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • proxy-url Base URL for MCMP requests.
    • Attribute Value
    Default Value /
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • session-draining-strategy Session draining strategy used during undeployment of a web application.
    • 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
  • simple-load-provider Simple load provider returns constant pre-configured load balancing factor.
    • Deprecated Since 6.0.0
    Deprecated. Alias for child resource load-balancer=simple.
    Attribute Value
    Type INT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • smax Soft maximum idle connection count for reverse proxy.
    • Attribute Value
    Default Value -1
    Type INT
    Nillable true
    Expressions Allowed true
    Min -1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • socket-timeout Timeout to wait for the reverse proxy to answer a MCMP message.
    • 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
  • ssl-context Reference to the SSLContext to be used by mod_cluster.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • status-interval Number of seconds a STATUS message is sent from the application server to the proxy.
    • 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
  • sticky-session Indicates whether subsequent requests for a given session should be routed to the same node, if possible.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • stop-context-timeout Maximum time to wait for context to process pending requests.
    • 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
  • ttl Time to live (in seconds) for idle connections above smax.
    • Attribute Value
    Default Value -1
    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
  • worker-timeout Number of seconds to wait for a worker to become available to handle a request.
    • Attribute Value
    Default Value -1
    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

Operations (19)

  • 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 -1 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 -1 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-list STRING false true List of reverse proxies to register with. Format (hostname:port) separated with commas.
    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 -1 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.
    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 -1 Time to live (in seconds) for idle connections above smax.
    worker-timeout INT false true -1 Number of seconds to wait for a worker to become available to handle a request.
    ssl-context STRING false true Reference to the SSLContext to be used by mod_cluster.
    connector STRING false false The name of Undertow listener that will be registered with the reverse proxy.
    simple-load-provider INT false false Simple load provider returns constant pre-configured load balancing factor.
  • add-custom-metric Add new custom metric to the dynamic load balance factor provider.
    Deprecated Since 6.0.0
    Deprecated. Use regular 'add' management operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    class STRING true true Class of custom metric.
    weight INT false true 1 Weight of the metric.
    capacity DOUBLE false true 1.0 Capacity of the metric.
    property OBJECT false true Properties for the metric.
  • add-metric Add new metric to the dynamic load balance factor provider.
    Deprecated Since 6.0.0
    Deprecated. Use regular 'add' management operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    type STRING true false Type of the metric.
    weight INT false true 1 Weight of the metric.
    capacity DOUBLE false true 1.0 Capacity of the metric.
    property OBJECT false true Properties for the metric.
  • 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.
  • disable Tell reverse proxies that all contexts of the node can't process new requests.

    Reply properties

    type
    BOOLEAN
  • 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
  • enable Tell reverse proxies that all contexts on the node are ready to receive requests.

    Reply properties

    type
    BOOLEAN
  • 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
  • list-proxies List the reverse proxies this node is currently registered with.

    Reply properties

    type
    LIST
    Value Type
    STRING
  • read-proxies-configuration Send a DUMP command to the reverse proxies and display the result.

    Reply properties

    type
    LIST
    Value Type
    STRING
  • read-proxies-info Send an INFO command to the reverse proxies and display the result.

    Reply properties

    type
    LIST
    Value Type
    STRING
  • refresh Refresh the node sending a new CONFIG message to the reverse proxies.
  • remove Remove a proxy resource leaving the server in 'reload-required' state.
  • remove-custom-metric Remove a custom metric from the dynamic load balance factor provider.
    Deprecated Since 6.0.0
    Deprecated. Use regular 'remove' management operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    class STRING true true Class of custom metric.
  • remove-metric Remove a metric from the dynamic load balance factor provider.
    Deprecated Since 6.0.0
    Deprecated. Use regular 'remove' management operation.
    Request Parameter Type Required Expressions Allowed Default value Description
    type STRING true false Type of the metric.
  • 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.
  • reset Reset the node's connection to the reverse proxies.
  • 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
  • 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