WildFly Full 23 Model Reference

  1. home
  2. subsystem=modcluster

Configuration and runtime operations for mod_cluster subsystem.

Children (1)

  • 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.

Operations (15)

  • add Add the mod_cluster subsystem leaving the server in 'reload-required' state.
  • add-proxy Add a reverse proxy to the list of proxies to register with.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
    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.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
  • disable-context Tell reverse proxies that the context can't process new requests.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
    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.
  • enable Tell reverse proxies that all contexts on the node are ready to receive requests.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
  • enable-context Tell reverse proxies that the context is ready to receive requests.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
    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.
  • list-proxies List the reverse proxies this node is currently registered with.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.

    Reply properties

    type
    LIST
    Value Type
    STRING
  • read-proxies-configuration Send a DUMP command to the reverse proxies and display the result.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.

    Reply properties

    type
    LIST
    Value Type
    STRING
  • read-proxies-info Send an INFO command to the reverse proxies and display the result.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.

    Reply properties

    type
    LIST
    Value Type
    STRING
  • refresh Refresh the node sending a new CONFIG message to the reverse proxies.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
  • remove Remove the mod_cluster subsystem leaving the server in 'reload-required' state.
  • remove-proxy Remove the reverse proxy from the list of proxies to register with.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
    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.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
  • stop Tell reverse proxies that all contexts on the node can't process requests.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific 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.
  • stop-context Tell reverse proxies that the context can't process requests.
    Deprecated Since 6.0.0
    Deprecated. Use identical operation at an address of a specific proxy.
    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.