Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

3.4. Enterprise Application Server 7 Plugin

Table 3.2078. Basic Details

Internal Name:EAP7
Description:Provides monitoring and management of Wildfly 10 and JBoss EAP7
Version:4.4.0

Top-Level Resource Types

3.4.1. EAP7 - Standalone Server

Overview

Table 3.2079. Overview

Description:Standalone AS7 server
Singleton: no
Plugin:EAP7

Note

The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically standalone.sh on UNIX or standalone.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-as-7.1.1.Final/bin/standalone.sh") * Start Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") * Start Script Arguments - arguments to be passed to the start script (e.g. "--server-config=standalone-full-ha.xml") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the EAP7 plugin discovery code to match the currently running server process' command line and environment. The settings are not used by the Stop operation, since it stops the server via the management interface, not via a script. For more detailed descriptions of the settings, see the Connection Settings section below.

Child Resource Types

Autodiscovery Process Scans

Table 3.2080. Metrics

NameQuery
StandaloneASprocess|basename|match=^java.*,arg|org.jboss.as.standalone|match=.*

Connection Properties

Table 3.2081. 

NameDescriptionRequiredInternal Name
Start Script PathThe path to the script that the Start and Restart operations should use to start the server. If the path is not absolute, it is resolved relative to the server home directory (e.g. "bin/standalone.sh", "bin/domain.sh"). no startScript
Start Script PrefixA prefix command line that should be prepended to the start script command line by the Start and Restart operations; the prefix command must be an absolute path (e.g. "/usr/bin/sudo"). This property is most commonly used to run the AS7 process as a different user than the RHQ Agent (e.g. "sudo -u jboss -g jboss" could be used to run AS7 as user "jboss" and group "jboss". It is also possible to chain prefix commands (e.g. "nohup sudo -u jboss" could be used to make AS7 ignore HUP signals and to run as user "jboss"). no startScriptPrefix
Start Script Environment VariablesThe variables that the Start and Restart operations will add to the environment of the server start script. Each name=value pair should be on a new line. Variable values should *not* be enclosed in quotes (e.g. PATH=/usr/bin:/bin). On UNIX systems, the typical minimum set of environment variables is: PATH=/usr/bin:/bin . And on Windows the typical minimum set is: PATH=C:\Windows\System32;C:\Windows , OS=Windows_NT , SYSTEMROOT=C:\Windows . In addition, it is good practice to set JAVA_HOME to the absolute path of the install directory of the JRE or JDK you wish to use to run the AS7 instance. However, if JAVA_HOME is not specified, the start script will attempt to find java in the PATH. There is currently a 2000 character limit for this value. no startScriptEnv
Start Script ArgumentsThe arguments that the Start and Restart operations will pass to the server start script. Each argument should be on a new line - for example: --server-config=standalone-ha-full.xml. As an exception, the value of a space-delimited option can optionally be on the same line as the option - for example: -c standalone-ha-full.xml. There is currently a 2000 character limit for this value. no startScriptArgs
Additional JAVA_OPTSProperty used to make persistent changes to JAVA_OPTS. !!!WARNING!!! Feature available only if standard configuration file is used (standalone.conf or standalone.conf.bat). Please do not update the configuration file manually after setting this property. If value not set then configuration specific values are used. Value not set does not imply that configuration file does not set JAVA_OPTS, it simply means that the value was not set via RHQ. !!!WARNING!!! Value will be persisted to standalone.conf or standalone.conf.bat config file (OS dependent). Use this option to make the JAVA_OPTS configuration available for restarts outside of RHQ. The value (e.g.: -Xms512M -Xmx1024M) will be persisted in the configuration file. To remove any modifications done to the config file unset this property. The server requires restart for these changes to take effect. no javaOptsAdditional
CLI Local AuthenticationSpecifies if the local authentication should be used to interact with the EAP CLI (this includes bundle:handover feature, EAP patching and CLI operations). If this is set to "Yes", User and Password supplied above are NOT going to be passed to jboss-cli binary and plugin relies on local authentication. no nativeLocalAuth
Log Event Sources  yes logEventSources
Trust StrategyDefines the trust strategy to use when reading the server certificate:
  • Standard: standard verification using a truststore
  • Trust Self-signed: trust self-signed certificates (certification chain size equals to 1)
  • Trust Any: trust any server certificate
yes trustStrategy
Hostname VerificationDefines the hostname verification logic:
  • Strict: The hostname must match either the first CN, or any of the Subject Alternatives. A wildcard can occur in the CN, and in any of the Subject Alternatives.
  • Browser-compatible: same as Strict, except that it allows nested subdomains validation with wildcards.
  • Skip: no hostname verification
yes hostnameVerification
TruststorePath to a truststore file. If undefined, the JVM default truststore is used. no truststore
Truststore TypeTruststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. no truststoreType
Truststore PasswordPassword protecting the truststore file. no truststorePassword
Client Certificate Authentication  yes clientcertAuthentication
KeystorePath to a keystore file. Required when Client Certificate Authentication is on. no keystore
Keystore TypeKeystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. no keystoreType
Keystore PasswordPassword protecting the keystore file. no keystorePassword
Key PasswordPassword protecting the secret key in the keystore file. no keyPassword
Hostname  yes hostname
Port  yes port
SecureEncrypted transport indicator yes secure
UserManagement user for a secured AS no user
PasswordPassword for the management user no password
Management Connection TimeoutMaximum time in milliseconds to keep alive an idle management connection. Zero and negative values will disable connection persistence. Defaults to 5000 ms. no managementConnectionTimeout
Home DirectoryRoot directory of the server installation no homeDir
Base DirectoryBase directory for server content no baseDir
Configuration DirectoryBase configuration directory no configDir
Log Directorythe directory where log files will be written for this server no logDir
Product TypeServer product type (e.g. AS or EAP) no productType

Note

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

Metrics

Table 3.2082. Metrics

NameTypeDescriptionInternal Name
Number of management requestsmeasurementNumber of requests sent to the controller_internal:mgmtRequests
Number of management requests per MinutemeasurementNumber of requests sent to the controller_internal:mgmtRequests
Time used for management requestsmeasurementTotal time for requests_internal:requestTime
Time used for management requests per MinutemeasurementTotal time for requests_internal:requestTime
Maximum request timemeasurementMax time for a request since last metric get_internal:maxTime
Server StatetraitDetailed server stateserver-state
Server Code NametraitServer Code Name_skm:release-codename
Server VersiontraitServer Version_skm:release-version
Product NametraitProduct Name_skm:product-name
Product VersiontraitProduct Version_skm:product-version
Server Start TimetraitServer Start TimestartTime
JGroups Multicast Addresstraitthe host and port used by JGroups for multicastmulticastAddress
Server Config FiletraitThe name of the server configuration file this server is usingconfig-file
Deploy DirectorytraitThe deployment directory for file based bundles (usually 'standalone/deployments')deployDir
Temporary DirectorytraitThe temporary directory (usually 'standalone/tmp'). May serve as deployment directory for handover only bundles'temp-dir
Active PatchestraitThe comma-separated list of patches that are currently applied to the server. The first entry is always the cumulative patch, followed by 0 or more one-off patches.active-patches

Note

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

Configuration Properties

Table 3.2083. 

NameDescriptionRequiredInternal Name
Properties  no *2
PathThe standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances no *3
Installed extensions  no *1
Base DirThe base directory for JBoss Application Server. yes base-dir
Config DirThe directory where the configurations are stored. yes config-dir
Config FileThe configuration file used to launch JBoss Application Server. yes config-file
Content DirThe directory where user content (e.g. deployments) that is managed by the server is stored. yes content-dir
Data DirThe data directory. yes data-dir
Deploy DirDeprecated variant of 'content-dir'. yes deploy-dir
Ext DirsA list of ext directories. yes ext-dirs
Home DirThe home directory for JBoss Application Server. yes home-dir
Host NameThe host name. yes host-name
Initial Running ModeThe current running mode of the server. Either LIVE (normal operations) or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests. yes initial-running-mode
Launch TypeThe type of the running server. yes launch-type
Log DirThe directory where log files are sent. yes log-dir
Modules DirThe directory where modules are found. yes modules-dir
Node NameThe name of the server node. yes node-name
Qualified Host NameThe qualified host name. yes qualified-host-name
Server NameThe name of the server. yes server-name
Temp DirThe temporary directory. yes temp-dir

Note

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

Operations

Table 3.2084. Metrics

NameDescription
ReloadMake the server re-load the (changed) configuration. To load a different startup config use 'restart'
StartStart the server by invoking its start script
RestartRestart the server by shutting it down and invoking its start script
ShutdownShut down the server.
Install RHQ userInstalls a user in the server for management
Execute CLI commandsExecutes command via jboss-cli
Execute CLI scriptExecutes script via jboss-cli
Setup CLISetup jboss-cli.xml configuration file based on pluginConfiguration properties. Note that jboss-cli.xml was introduced in EAP 6.2 and this operation will fail for previous versions.

Package Types

none

3.4.1.1. EAP7 - ModCluster Standalone Service

Overview

Table 3.2085. Overview

Description:Mod_cluster support
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2086. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2087. Metrics

NameDescription
Add ProxyAdd the proxy to the list of httpd connected to the node.
List ProxiesRead the list of httpd connected to the node.
Read Proxies ConfigurationSend a DUMP to httpd and display the result.
Read Proxies InfoSend a INFO to httpd and display the result.
RefreshRefresh the node sending a new CONFIG message to Apache httpd.
Remove ProxyRemove the proxy to the list of httpd connected to the node.
ResetReset the node connection to Apache httpd.
Package Types
none
3.4.1.1.1. EAP7 - Service Configuration Service
Overview

Table 3.2088. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2089. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2090. 

NameDescriptionRequiredInternal Name
Proxy ListList of proxies, Format (hostname:port) separated with commas. no proxy-list
Proxy UrlBase URL for MCMP requests. no proxy-url
Advertise SocketName of Socket binding to use for the Advertise socket. no advertise-socket
AdvertiseUse Advertise logic or not. no advertise
Advertise Security KeyString containing the security key for the Advertise logic. no advertise-security-key
BalancerThe balancer name. no balancer
ConnectorName of the web connector used to communicate with the load balancer. yes connector
Load Balancing GrouploadBalancingGroup name. no load-balancing-group
Excluded ContextsList of contexts mod_cluster should ignore, Format String separated with commas. no excluded-contexts
Auto Enable ContextsEnable contexts even if disabled in mod_cluster_manger (httpd). no auto-enable-contexts
Sticky SessionUse sticky sessions for requests. no sticky-session
Sticky Session RemoveRemove session information on failover. no sticky-session-remove
Sticky Session ForceDon't failover a request with session information. no sticky-session-force
Worker TimeoutTimeout to wait in httpd for an available worker to process the requests. no worker-timeout
Max AttemptsMax attempts to process an idempotent request. no max-attempts
Flush PacketsEnables/disables packet flushing in httpd. no flush-packets
Flush WaitTime to wait before flushing packets in httpd. no flush-wait
PingTime (in seconds) in which to wait for a pong answer to a ping. no ping
SmaxSoft maximum idle connection count in httpd no smax
TtlTime to live (in seconds) for idle connections above smax no ttl
Node TimeoutTimeout (in seconds) for proxy connections to a node. no node-timeout
Stop Context TimeoutMax time to wait for context to process pending requests. no stop-context-timeout
Socket TimeoutTimeout to wait for httpd to answer a MCMP message. no socket-timeout

Note

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

Table 3.2091. Metrics

NameDescription
Add Custom MetricAdd new custom metric to the load balancer provider.
Add MetricAdd new metric to the load balancer provider.
Remove Custom MetricRemove a custom metric from the load balancer provider.
Remove MetricAdd new metric to the load balancer provider.
Package Types
none
3.4.1.1.1.1. EAP7 - Dynamic Load Provider Service
Overview

Table 3.2092. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties

Table 3.2093. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2094. 

NameDescriptionRequiredInternal Name
DecayDecay. The default value is 2. no decay
HistoryHistory. The default value is 9. no history

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.1.1.1.1. EAP7 - Custom Load Metric Service
Overview

Table 3.2095. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2096. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2097. 

NameDescriptionRequiredInternal Name
CapacityCapacity of the metric. The default value is 1 no capacity
ClassClass name of the custom metric. yes class
WeightWeight of the metric. The default value is 1. no weight

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.1.1.1.2. EAP7 - Load Metric Service
Overview

Table 3.2098. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2099. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2100. 

NameDescriptionRequiredInternal Name
CapacityCapacity of the metric. The default value is 1. no capacity
TypeType of the metric yes type
WeightWeight of the metric. The default value is 1. no weight

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.1.1.2. EAP7 - Ssl Service
Overview

Table 3.2101. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2102. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2103. 

NameDescriptionRequiredInternal Name
Ca Certificate FileCertificate authority. no ca-certificate-file
Ca Revocation UrCertificate authority revocation list. no ca-revocation-ur
Certificate Key FileKey file for the certificate. no certificate-key-file
Cipher SuiteThe allowed cipher suite. no cipher-suite
Key AliasThe key alias. no key-alias
PasswordPassword. no password
ProtocolThe SSL protocols that are enabled. no protocol

Note

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

3.4.1.2. EAP7 - IIOP-OpenJDK Service

Overview

Table 3.2104. Overview

Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2105. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2106. 

NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is true. no add-component-via-interceptor
Auth MethodThe authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. no auth-method
Caller PropagationIndicates whether the caller identity should be propagated in the SAS context or not. Valid values are 'none' and 'supported'. The default value is none. no caller-propagation
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
ConfidentialityIndicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no confidentiality
Detect MisorderingIndicates whether the transport must require misordering detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-misordering
Detect ReplayIndicates whether the transport must require replay detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-replay
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is true. no export-corbaloc
Giop VersionThe GIOP version to be used. The default value is 1.2. no giop-version
High Water Mark:exprTCP connection cache parameter. Each time the number of connections exceeds this value ORB tries to reclaim connections. Number of reclaimed connections is specified by tcp-number-to-reclaim property. If this property is not set then it is configured as OpenJDK ORB default. no high-water-mark:expr
IntegrityIndicates whether the transport must require integrity protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no integrity
Number To Reclaim:exprTCP connection cache parameter. Each time number of connections exceeds tcp-high-water-mark property then ORB tries to reclaim connections. Number of reclaimed connections is specified by this property. If it is not set then it is configured as OpenJDK ORB default. no number-to-reclaim:expr
Persistent Server IdPersistent id of the server. Persistent object references are valid across many activactions of the server and they identify it using this property. As a result of that: many activations of the same server should have this property set to the same value, different server instances running on the same host should have different server ids. The default value is 1. no persistent-server-id
PropertiesA list of generic key/value properties. no properties
RealmThe authentication service (AS) realm name. no realm
RequiredIndicates if authentication is required (true) or not (false). The default value is false. no required
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is none. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Socket BindingThe name of the socket binding configuration that specifies the ORB port. The default value is iiop. no socket-binding
Ssl Socket BindingThe name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. no ssl-socket-binding
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is false. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is none. no transactions
Trust In ClientIndicates if the transport must require trust in client to be established. Valid values are 'none', 'supported' and 'required'. The default value is none. no trust-in-client
Trust In TargetIndicates if the transport must require trust in target to be established. Valid values are 'none' and 'supported'. The default value is none. no trust-in-target

Note

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

3.4.1.3. EAP7 - JVM Service

Overview

Table 3.2107. Overview

Description:Information about the underlying JVM
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2108. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.1. EAP7 - Operating System Service
Overview

Table 3.2109. Overview

Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2110. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2111. Metrics

NameTypeDescriptionInternal Name
Available ProcessorsmeasurementThe number of processors available to the Java virtual machine.available-processors
System Load AveragemeasurementThe system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.system-load-average

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.2. EAP7 - Memory Service
Overview

Table 3.2112. Overview

Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2113. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2114. Metrics

NameTypeDescriptionInternal Name
Object Pending Finalization CountmeasurementThe approximate number of objects for which finalization is pending.object-pending-finalization-count
Initial heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.heap-memory-usage:init
Used heapmeasurementThe amount of used memory in bytes.heap-memory-usage:used
Committed heapmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.heap-memory-usage:committed
Maximum heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.heap-memory-usage:max
Initial non-heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.non-heap-memory-usage:init
Used non-heap memorymeasurementThe amount of used memory in bytes.non-heap-memory-usage:used
Committed non-heap memorymeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.non-heap-memory-usage:committed
Maximum non-heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.non-heap-memory-usage:max

Note

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

Table 3.2115. Metrics

NameDescription
Trigger GCRuns the garbage collector.
Package Types
none
3.4.1.3.3. EAP7 - Runtime Service
Overview

Table 3.2116. Overview

Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2117. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2118. Metrics

NameTypeDescriptionInternal Name
UptimemeasurementThe uptime of the Java virtual machine in milliseconds.uptime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.4. EAP7 - Threading Service
Overview

Table 3.2119. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2120. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2121. Metrics

NameTypeDescriptionInternal Name
Thread CountmeasurementThe current number of live threads including both daemon and non-daemon threads.thread-count
Peak Thread CountmeasurementThe peak live thread count since the Java virtual machine started or peak was reset.peak-thread-count
Total Started Thread CountmeasurementThe total number of threads created and also started since the Java virtual machine started.total-started-thread-count
Daemon Thread CountmeasurementThe current number of live daemon threads.daemon-thread-count
Current Thread Cpu TimemeasurementThe total CPU time for the current thread in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' undefined.current-thread-cpu-time
Current Thread User TimemeasurementThe CPU time that the current thread has executed in user mode in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' the result will be undefined current-thread-user-time

Note

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

Table 3.2122. 

NameDescriptionRequiredInternal Name
Thread Contention Monitoring EnabledWhether thread contention monitoring is enabled. no thread-contention-monitoring-enabled
Thread Cpu Time EnabledWhether thread CPU time measurement is enabled. no thread-cpu-time-enabled
Thread Contention Monitoring SupportedWhether the Java virtual machine supports thread contention monitoring. no thread-contention-monitoring-supported
Thread Cpu Time SupportedWhether the Java virtual machine implementation supports CPU time measurement for any thread. no thread-cpu-time-supported
Current Thread Cpu Time SupportedWhether the Java virtual machine supports CPU time measurement for the current thread. no current-thread-cpu-time-supported
Object Monitor Usage SupportedWhether the Java virtual machine supports monitoring of object monitor usage. no object-monitor-usage-supported
Synchronizer Usage SupportedWhether the Java virtual machine supports monitoring of ownable synchronizer usage. no synchronizer-usage-supported

Note

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

Table 3.2123. Metrics

NameDescription
Dump All ThreadsReturns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu TimeReturns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread InfoReturns the thread info for a thread of the specified id. The stack trace, locked monitors, and locked synchronizers in the returned reply object will be empty.
Get Thread InfosReturns the thread info for each thread whose ID is in the input list.
Get Thread User TimeReturns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread CountResets the peak thread count to the current number of live threads.
Get All thread idsGet all live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined.
Package Types
none
3.4.1.3.5. EAP7 - Garbage Collector Service
Overview

Table 3.2124. Overview

Description:Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2125. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.5.1. EAP7 - Garbage Collector Resource Service
Overview

Table 3.2126. Overview

Description:The management interface for one of the garbage collectors in the Java virtual machine.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2127. 

NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

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

Table 3.2128. Metrics

NameTypeDescriptionInternal Name
Collection CountmeasurementThe total number of collections that have occurred.collection-count
Collection Count per MinutemeasurementThe total number of collections that have occurred.collection-count
Collection TimemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
Collection Time per MinutemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
NametraitThe name representing this garbage collectorname
ValidtraitWhether this this memory manager is valid in the Java virtual machine.valid

Note

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

Table 3.2129. 

NameDescriptionRequiredInternal Name
Memory Pool NamesThe name of memory pools that this garbage collector manages. yes memory-pool-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.3.6. EAP7 - Memory Pool Service
Overview

Table 3.2130. Overview

Description:Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2131. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.6.1. EAP7 - Memory Pool Resource Service
Overview

Table 3.2132. Overview

Description:The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2133. 

NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

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

Table 3.2134. Metrics

NameTypeDescriptionInternal Name
Collection Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.collection-usage:init
Collection Usage - UsedmeasurementThe amount of used memory in bytes.collection-usage:used
Collection Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.collection-usage:committed
Collection Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.collection-usage:max
Collection Usage Threshold CountmeasurementThe number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-count
Collection Usage Threshold ExceededtraitWhether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-exceeded
Collection Usage Threshold SupportedtraitWhether this memory pool supports a collection usage threshold.collection-usage-threshold-supported
NametraitThe name representing this memory pool.name
Peak Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.peak-usage:init
Peak Usage - UsedmeasurementThe amount of used memory in bytes.peak-usage:used
Peak Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.peak-usage:committed
Peak Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.peak-usage:max
TypetraitThe type of this memory pool.type
Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.usage:init
Usage - UsedmeasurementThe amount of used memory in bytes.usage:used
Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.usage:committed
Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.usage:max
Usage Threshold CountmeasurementThe number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-count
Usage Threshold ExceededtraitWhether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-exceeded
Usage Threshold SupportedtraitWhether this memory pool supports usage threshold.usage-threshold-supported
ValidtraitWhether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.valid

Note

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

Table 3.2135. 

NameDescriptionRequiredInternal Name
Collection Usage ThresholdThe collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no collection-usage-threshold
Memory Manager NamesThe names of the memory managers that manage this memory pool. yes memory-manager-names
Usage ThresholdThe usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no usage-threshold

Note

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

Table 3.2136. Metrics

NameDescription
Reset Peak UsageResets the peak memory usage statistic of this memory pool to the current memory usage.
Package Types
none

3.4.1.4. EAP7 - Undertow Service

Overview

Table 3.2137. Overview

Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2138. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2139. 

NameDescriptionRequiredInternal Name
Default Security DomainThe default security domain used by web deployments. The default value is other. no default-security-domain
Default ServerThe default server to use for deployments. The default value is default-server. no default-server
Default Servlet ContainerThe default servlet container to use for deployments. The default value is default. no default-servlet-container
Default Virtual HostThe default virtual host to use for deployments. The default value is default-host. no default-virtual-host
Instance IdThe cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. no instance-id
Statistics EnabledConfigures if are statistics enabled. The default value is false. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1. EAP7 - Filter configurations Service
Overview

Table 3.2140. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties

Table 3.2141. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.4.1.1. EAP7 - Error page Service
Overview

Table 3.2142. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2143. 

NameDescriptionRequiredInternal Name
Path  yes path

Note

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

Table 3.2144. 

NameDescriptionRequiredInternal Name
Code:exprError page code yes code:expr
PathError page path no path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.2. EAP7 - Expression filter Service
Overview

Table 3.2145. Overview

Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties

Table 3.2146. 

NameDescriptionRequiredInternal Name
Pa