JBoss EAP 6.3 Model Reference

  1. JBoss EAP 6.3
  2. subsystem=modcluster
  3. mod-cluster-config=configuration

The common modcluster configuration.

Children (2)

  • dynamic-load-provider Dynamic load provider
  • ssl The SSL configuration to client MCMP logic.

Attributes (25)

  • advertise Use Advertise logic or not.
    • 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 String containing the security key for the Advertise logic.
    • 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
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • auto-enable-contexts Enable contexts even if disabled in mod_cluster_manger (httpd).
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • balancer The balancer name.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • connector Name of the web connector used to communicate with the load balancer.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • excluded-contexts List of contexts mod_cluster should ignore, Format String separated with commas.
    • Attribute Value
    Default Value ROOT,invoker,jbossws,juddi,console
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • flush-packets Enables/disables packet flushing in httpd.
    • 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 in httpd.
    • 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
  • load-balancing-group loadBalancingGroup name.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • max-attempts Max attempts to process an idempotent request.
    • 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
  • node-timeout Timeout (in seconds) for proxy connections to a node.
    • 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 Time (in seconds) in 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
  • proxy-list List of proxies, Format (hostname:port) separated with comas.
    • 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
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • smax Soft maximum idle connection count in httpd
    • 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 httpd 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
  • sticky-session Use sticky sessions for requests.
    • 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 Don't failover a request with session information.
    • 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 Remove session information on failover.
    • 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 Max 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 Timeout to wait in httpd for an available worker to process the requests.
    • 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 (6)

  • add Adds configuration resource
    Request Parameter Type Required Expressions Allowed Default value Description
    advertise-socket STRING false false Name of Socket binding to use for the Advertise socket.
    advertise BOOLEAN false true true Use Advertise logic or not.
    proxy-list STRING false true List of proxies, Format (hostname:port) separated with comas.
    stop-context-timeout INT false true 10 Max time to wait for context to process pending requests.
    worker-timeout INT false true -1 Timeout to wait in httpd for an available worker to process the requests.
    auto-enable-contexts BOOLEAN false true true Enable contexts even if disabled in mod_cluster_manger (httpd).
    sticky-session-force BOOLEAN false true false Don't failover a request with session information.
    max-attempts INT false true 1 Max attempts to process an idempotent request.
    ping INT false true 10 Time (in seconds) in which to wait for a pong answer to a ping.
    smax INT false true -1 Soft maximum idle connection count in httpd
    simple-load-provider INT false true Simple load provider
    flush-packets BOOLEAN false true false Enables/disables packet flushing in httpd.
    sticky-session-remove BOOLEAN false true false Remove session information on failover.
    ttl INT false true -1 Time to live (in seconds) for idle connections above smax
    node-timeout INT false true -1 Timeout (in seconds) for proxy connections to a node.
    excluded-contexts STRING false true ROOT,invoker,jbossws,juddi,console List of contexts mod_cluster should ignore, Format String separated with commas.
    balancer STRING false true The balancer name.
    advertise-security-key STRING false true String containing the security key for the Advertise logic.
    load-balancing-group STRING false true loadBalancingGroup name.
    connector STRING true false Name of the web connector used to communicate with the load balancer.
    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
    sticky-session BOOLEAN false true true Use sticky sessions for requests.
    socket-timeout INT false true 20 Timeout to wait for httpd to answer a MCMP message.
    flush-wait INT false true -1 Time to wait before flushing packets in httpd.
  • add-custom-metric Add new custom metric to the load balancer provider.
    Request Parameter Type Required Expressions Allowed Default value Description
    class STRING true false 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 load balancer provider.
    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.
  • remove Removes configuration resource
  • remove-custom-metric Remove a custom metric from the load balancer provider.
    Request Parameter Type Required Expressions Allowed Default value Description
    class STRING true false Class of custom metric
  • remove-metric Remove a metric from the load balancer provider.
    Request Parameter Type Required Expressions Allowed Default value Description
    type STRING true false Type of the metric