2.6. mod_cluster Service

Table 2.275. Overview
Description:	mod_cluster plugin
Singleton:	yes
Plugin:	mod_cluster

Table 2.277. Metrics
Name	Type	Description	Internal Name
Proxy Information	trait	Proxy Information	ProxyInformation

Table 2.278. Metrics
Name	Description
Reset the node	Move this application server out of an error state.
Refresh configuration	Refresh configuration for this application server.

2.6.1. Catalina Service
复制链接

Overview

Expand

Table 2.279. Overview
Description:	Catalina Service
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.280.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Expand

Table 2.281. Metrics
Name	Type	Description	Internal Name
Proxy Configuration	trait	Proxy Configuration	proxyConfiguration
Proxy Info	trait	Proxy Info	proxyInfo
Type of the modeled resource	trait	Type of the modeled resource	modelerType
Fully qualified class name of the managed object	trait	Fully qualified class name of the managed object	className
Enable autodiscovery of httpd servers.	trait	Enable autodiscovery of httpd servers.	advertise

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Expand

Table 2.282.
Name	Description	Required	Internal Name
Worker Timeout	Timeout to wait for an available worker (default is no wait).	yes	workerTimeout
Sticky Session	Enables sticky session for the cluster.	yes	stickySession
Sticky Session Remove	Remove session when the request cannot be routed to the right node for this cluster.	yes	stickySessionRemove
Smax	Maximum time on seconds for idle connections above smax.	yes	smax
Max Attempts	Maximum number of attempts to send the request to the backend server.	yes	maxAttempts
Advertise Security Key	Security key for discovery.	no	advertiseSecurityKey
Sticky Session Force	Return an error when the request cannot be routed to the right node.	yes	stickySessionForce
Balancer	Name of the balancer.	no	balancer
Flush Packets	Allows controlling flusing of packets.	yes	flushPackets
Socket Timeout	Connection timeout for communication with the proxy.	yes	socketTimeout
Advertise Port	Multicast port for discovery	no	advertisePort
Advertise Group Address	Multicast address for discovery.	no	advertiseGroupAddress
Flush Wait	Time in ms to wait before flushing packets.	yes	flushWait
Ping	Time in s to wait for a pong answer to a ping.	yes	ping

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Expand

Table 2.283. Metrics
Name	Description
Add a proxy	Add a proxy.
Remove a proxy	Remove a proxy.
Disable all webpapps	Disable all webapps for all virtual hosts of this application server.
Enable all webapps	Enable all webapps for all virtual hosts of this application server.
Stop all webapps	Gracefully stops all webapps for all virtual hosts of this application server.

Package Types

none

2.6.2. Dynamic Load Balancer Factor Service
复制链接

Overview

Expand

Table 2.284. Overview
Description:	Dynamic Load balancer factor for mod_cluster
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.285.
Name	Required	Internal Name
Object Name	yes	objectName
Class Name	yes	className
Name Template	yes	nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

Expand

Table 2.286.
Name	Description	Required	Internal Name
Decay Factor	The number of historical load values used to determine load factor.	no	decayFactor
History	The exponential decay factor for historical load values.	no	history

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.6.3. HA Service
复制链接

Overview

Expand

Table 2.287. Overview
Description:	HA Service
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.288.
Name	Required	Internal Name
Object Name	yes	objectName
Name Template	yes	nameTemplate
Class Name	yes	className
Proxy Info Property	yes	proxyInfoProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Expand

Table 2.289. Metrics
Name	Type	Description	Internal Name
Master Node	trait	Master Node	MasterNode
Proxy Configuration	trait	Proxy Configuration	ProxyConfiguration
Proxy Info	trait	Proxy Info	ProxyInfo

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Expand

Table 2.290.
Name	Description	Required	Internal Name
Process Status Frequency	Process status frequency.	no	processStatusFrequency

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Expand

Table 2.291. Metrics
Name	Description
Disable domain	Disables all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped.
Enable domain	Enable all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped.
Stop domain	Gracefully stops all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped.
Ping httpd	Ping httpd and determine whether each proxy is accessible and healthy. Returns the PING_RSP grouped by proxy address.
Ping node by JVM Route	Ping a node from httpd and returns the PING_RSP grouped by proxy address. Dtermines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address.
Ping node by address	Ping a node from httpd and returns the PING_RSP grouped by proxy address. Determines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address.
Add a proxy	Add a proxy.
Remove a proxy	Remove a proxy.
Disable all webpapps	Disable all webapps for all virtual hosts of this application server.
Enable all webapps	Enable all webapps for all virtual hosts of this application server.
Stop all webapps	Gracefully stops all webapps for all virtual hosts of this application server.

Package Types

none

2.6.4. HA Service Configuration Service
复制链接

Overview

Expand

Table 2.292. Overview
Description:	HA Service Configuration
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.293.
Name	Required	Internal Name
Object Name	yes	objectName
Name Template	yes	nameTemplate
Class Name	yes	className
Dependency Class Name	yes	dependencyClassName
Proxy Info Property	yes	proxyInfoProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

Expand

Table 2.294.
Name	Description	Required	Internal Name
Master Per Load Balancing Group	Enable current node to be master in the load balancing group.	no	masterPerLoadBalancingGroup
Advertise	Enable autodiscovery of httpd servers.	no	advertise
Advertise Group Address	Multicast address on which to listen for advertisements.	yes	advertiseGroupAddress
Advertise Port	Multicast port for discovery	no	advertisePort
Advertise Interface	Multicast interface for discovery	no	advertiseInterface
Advertise Security Key	Security key for discovery.	no	advertiseSecurityKey
Proxy List	Comma separated list of address:port listing the httpd servers where mod_cluster is running.	no	proxyList
Proxy URL	URL prefix to send with commands to mod_cluster. Default is no prefix.	no	proxyURL
Socket Timeout	Connection timeout for communication with the proxy.	no	socketTimeout
Excluded Contexts	Comma delimited list of contexts that should not be auto-registered with httpd. Contexts may be qualified by host using a colon, e.g. host1:context1. If no host is defined, localhost is assumed.	no	excludedContexts
Auto Enable Contexts	Toggle for context auto-enable during mod_cluster startup.	no	autoEnableContexts
Load Balancing Group	Load balancing group.	no	loadBalancingGroup
Flush Packets	Allows controlling flusing of packets.	no	flushPackets
Flush Wait	Time in ms to wait before flushing packets.	no	flushWait
Ping	Time in s to wait for a pong answer to a ping.	no	ping
Smax	Maximum time on seconds for idle connections above smax.	no	smax
Ttl	TTL	no	ttl
Node Timeout	Node timeout	no	nodeTimeout
Balancer	Name of the balancer	no	balancer
Sticky Session	Enables sticky session for the node.	yes	stickySession
Sticky Session Remove	Remove session when the request cannot be routed to the right node for this cluster.	yes	stickySessionRemove
Sticky Session Force	Return an error when the request cannot be routed to the right node.	yes	stickySessionForce
Worker Timeout	Timeout to wait for an available worker (default is no wait).	yes	workerTimeout
Max Attempts	Maximum number of attempts to send the request to the backend server.	yes	maxAttempts
Ssl	Whether to use SSL to communicate with mod_cluster. Note this has nothing to do with handling of https requests by JBoss Web	yes	ssl
Ssl Ciphers	SSL ciphers.	no	sslCiphers
Ssl Protocol	SSL protocol.	no	sslProtocol
Ssl Certificate Encoding Algorithm	Certificate encoding algorithm.	no	sslCertificateEncodingAlgorithm
Ssl Key Store	SSL keystore.	no	sslKeyStore
Ssl Key Store Password	SSL keystore password.	no	sslKeyStorePassword
Ssl Key Store Type	SSL keystore type.	no	sslKeyStoreType
Ssl Key Store Provider	SSL keystore provider.	no	sslKeyStoreProvider
Ssl Trust Algorithm	Truststore algorithm.	no	sslTrustAlgorithm
Ssl Key Alias	Key alias.	no	sslKeyAlias
Ssl Crl File	Certificate revocation list.	no	sslCrlFile
Ssl Trust Max Cert Length	Trust max certificate length.	no	sslTrustMaxCertLength
Ssl Trust Store	Trust store file.	no	sslTrustStore
Ssl Trust Store Password	Trust store password.	no	sslTrustStorePassword
Ssl Trust Store Type	Trust store type.	no	sslTrustStoreType
Ssl Trust Store Provider	Trust store provider.	no	sslTrustStoreProvider

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.6.5. Load Metric Service
复制链接

Overview

Expand

Table 2.295. Overview
Description:	Load Metric
Singleton:	no
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.296.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Expand

Table 2.297. Metrics
Name	Type	Description	Internal Name
Load	measurement	The current load of this metric as a percent of the metric's capacity.	Load

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Expand

Table 2.298.
Name	Description	Required	Internal Name
Weight	The significance of this load metric compared to the other metrics.	yes	weight
Capacity	Used to normalize the value returned by load expressed as a percentage of the capacity, such that: 0 < (load/capacity) < 1	yes	capacity

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.6.6. Service
复制链接

Overview

Expand

Table 2.299. Overview
Description:	Service
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.300.
Name	Required	Internal Name
Object Name	yes	objectName
Name Template	yes	nameTemplate
Class Name	yes	className
Proxy Info Property	yes	proxyInfoProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Expand

Table 2.301. Metrics
Name	Type	Description	Internal Name
Proxy Configuration	trait	Proxy Configuration	ProxyConfiguration
Proxy Info	trait	Proxy Info	ProxyInfo

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Expand

Table 2.302. Metrics
Name	Description
Ping httpd	Ping httpd and determine whether each proxy is accessible and healthy. Returns the PING_RSP grouped by proxy address.
Ping node by JVM Route	Ping a node from httpd and returns the PING_RSP grouped by proxy address. Dtermines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address.
Ping node by address	Ping a node from httpd and returns the PING_RSP grouped by proxy address. Determines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address.
Add a proxy	Add a proxy.
Remove a proxy	Remove a proxy.
Disable all webpapps	Disable all webapps for all virtual hosts of this application server.
Enable all webapps	Enable all webapps for all virtual hosts of this application server.
Stop all webapps	Gracefully stops all webapps for all virtual hosts of this application server.

Package Types

none

2.6.7. Service Configuration Service
复制链接

Overview

Expand

Table 2.303. Overview
Description:	Service Configuration
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.304.
Name	Required	Internal Name
Object Name	yes	objectName
Name Template	yes	nameTemplate
Class Name	yes	className
Dependency Class Name	yes	dependencyClassName
Proxy Info Property	yes	proxyInfoProperty

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

Expand

Table 2.305.
Name	Description	Required	Internal Name
Advertise	Enable autodiscovery of httpd servers.	no	advertise
Advertise Group Address	Multicast address on which to listen for advertisements.	yes	advertiseGroupAddress
Advertise Port	Multicast port for discovery	no	advertisePort
Advertise Interface	Multicast interface for discovery	no	advertiseInterface
Advertise Security Key	Security key for discovery.	no	advertiseSecurityKey
Proxy List	Comma separated list of address:port listing the httpd servers where mod_cluster is running.	no	proxyList
Proxy URL	URL prefix to send with commands to mod_cluster. Default is no prefix.	no	proxyURL
Socket Timeout	Connection timeout for communication with the proxy.	no	socketTimeout
Excluded Contexts	Comma delimited list of contexts that should not be auto-registered with httpd. Contexts may be qualified by host using a colon, e.g. host1:context1. If no host is defined, localhost is assumed.	no	excludedContexts
Auto Enable Contexts	Toggle for context auto-enable during mod_cluster startup.	no	autoEnableContexts
Load Balancing Group	Load balancing group.	no	loadBalancingGroup
Flush Packets	Allows controlling flusing of packets.	no	flushPackets
Flush Wait	Time in ms to wait before flushing packets.	no	flushWait
Ping	Time in s to wait for a pong answer to a ping.	no	ping
Smax	Maximum time on seconds for idle connections above smax.	no	smax
Ttl	TTL	no	ttl
Node Timeout	Node timeout	no	nodeTimeout
Balancer	Name of the balancer	no	balancer
Sticky Session	Enables sticky session for the node.	yes	stickySession
Sticky Session Remove	Remove session when the request cannot be routed to the right node for this cluster.	yes	stickySessionRemove
Sticky Session Force	Return an error when the request cannot be routed to the right node.	yes	stickySessionForce
Worker Timeout	Timeout to wait for an available worker (default is no wait).	yes	workerTimeout
Max Attempts	Maximum number of attempts to send the request to the backend server.	yes	maxAttempts
Ssl	Whether to use SSL to communicate with mod_cluster. Note this has nothing to do with handling of https requests by JBoss Web	yes	ssl
Ssl Ciphers	SSL ciphers.	no	sslCiphers
Ssl Protocol	SSL protocol.	no	sslProtocol
Ssl Certificate Encoding Algorithm	Certificate encoding algorithm.	no	sslCertificateEncodingAlgorithm
Ssl Key Store	SSL keystore.	no	sslKeyStore
Ssl Key Store Password	SSL keystore password.	no	sslKeyStorePassword
Ssl Key Store Type	SSL keystore type.	no	sslKeyStoreType
Ssl Key Store Provider	SSL keystore provider.	no	sslKeyStoreProvider
Ssl Trust Algorithm	Truststore algorithm.	no	sslTrustAlgorithm
Ssl Key Alias	Key alias.	no	sslKeyAlias
Ssl Crl File	Certificate revocation list.	no	sslCrlFile
Ssl Trust Max Cert Length	Trust max certificate length.	no	sslTrustMaxCertLength
Ssl Trust Store	Trust store file.	no	sslTrustStore
Ssl Trust Store Password	Trust store password.	no	sslTrustStorePassword
Ssl Trust Store Type	Trust store type.	no	sslTrustStoreType
Ssl Trust Store Provider	Trust store provider.	no	sslTrustStoreProvider

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.6.8. Simple Load Balancer Factor Service
复制链接

Overview

Expand

Table 2.306. Overview
Description:	Simple load balancer factor for mod_cluster
Singleton:	yes
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

Expand

Table 2.307.
Name	Required	Internal Name
Object Name	yes	objectName
Class Name	yes	className
Name Template	yes	nameTemplate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

Expand

Table 2.308.
Name	Description	Required	Internal Name
Load Balance Factor	The load balance factor.	yes	loadBalanceFactor

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

none

Package Types

none

2.6.9. Webapp Context Service
复制链接

Overview

Expand

Table 2.309. Overview
Description:	Webapp Context
Singleton:	no
Plugin:	mod_cluster

Parent Resource Types

Section 2.6, “mod_cluster Service”

Child Resource Types

none

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

Expand

Table 2.310. Metrics
Name	Description
Disable webapp	Disable this webapp.
Stop webapp	Gracefully stops this webapp.
Enable webapp	Enable this webapp.

Package Types

none

Name	Required	Internal Name
Object Name	yes	objectName
Engine Object Name	yes	engineObjectName
Name Template	yes	nameTemplate
Modcluster Config File	yes	modclusterConfigFile

此内容没有您所选择的语言版本。

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.1. Catalina Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.2. Dynamic Load Balancer Factor Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.3. HA Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.4. HA Service Configuration Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.5. Load Metric Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.6. Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.7. Service Configuration Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

Operations

Package Types

2.6.8. Simple Load Balancer Factor Service复制链接链接已复制到粘贴板!

Overview

Parent Resource Types

Child Resource Types

Connection Properties

Metrics

Configuration Properties

2.6.1. Catalina Service
复制链接

2.6.2. Dynamic Load Balancer Factor Service
复制链接

2.6.3. HA Service
复制链接

2.6.4. HA Service Configuration Service
复制链接

2.6.5. Load Metric Service
复制链接

2.6.6. Service
复制链接

2.6.7. Service Configuration Service
复制链接

2.6.8. Simple Load Balancer Factor Service
复制链接

2.6.9. Webapp Context Service
复制链接