Complete Resource Reference for Metrics, Operations, and Configuration Properties

Red Hat JBoss Operations Network 3.3

A complete reference for monitoring metrics, operations, and configuration options

Edition 3.3

Tyler Kelly

tkelly@redhat.com

Jared Morgan

jmorgan@redhat.com

Zach Rhoads

zach@redhat.com

Ella Deon Ballard

dlackey@redhat.com

Legal Notice

Abstract

This is a reference for all monitoring checks available for the default resources handled in Red Hat JBoss Operations Network, as well as available resource operations, configuration properties, and plug-in properties.

Preface

1. Document History

Revision History

Revision 3.3.2-5

June 30, 2015

Jared Morgan

Prepared for JBoss ON 3.3.2 Release, and fixed issues with sort order.

Revision 3.3-10

November 17, 2014

Jared Morgan

Updated for JBoss ON 3.3 GA

Chapter 1. Managed Platforms

JBoss Operations Network 3.3 supports several major types of platforms and operating systems, including Java, Linux, Unix distributions, and Windows. Platform support is implemented through a single agent resource plug-in that defines the individual configuration, metrics, and operations for all supported platform types.

1.1. Platforms - AIX Platform

Overview

Table 1.1. Overview
Description:	IBM AIX Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.1.1, “Platforms - Process Service”
Section 1.1.2, “Platforms - File System Service”
Section 1.1.3, “Platforms - Directory Service”
Section 1.1.4, “Platforms - Network Adapter Service”
Section 1.1.5, “Platforms - CPU Service”

Connection Properties

none

Metrics

Table 1.2. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.3. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

none

1.1.1. Platforms - Process Service

Overview

Table 1.4. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.5.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.6. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.1.2. Platforms - File System Service

Overview

Table 1.7. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.8. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.1.3. Platforms - Directory Service

Overview

Table 1.9. Overview
Description:	Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.10.
Name	Description	Required	Internal Name
Path	Directory to monitor. / is not allowed.	yes	path

Note

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

Metrics

Table 1.11. Metrics
Name	Type	Description	Internal Name
Directory usage	measurement	Disk usage of this directory	usage
Number of files	measurement	Number of files in the directory	files
Number of items	measurement	Number of items in the directory (files, subdirs, symlinks)	total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.1.4. Platforms - Network Adapter Service

Overview

Table 1.12. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.13. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.1.5. Platforms - CPU Service

Overview

Table 1.14. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.15. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2. Platforms - FreeBSD Platform

Overview

Table 1.16. Overview
Description:	FreeBSD Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.2.1, “Platforms - Process Service”
Section 1.2.2, “Platforms - File System Service”
Section 1.2.3, “Platforms - Directory Service”
Section 1.2.4, “Platforms - Network Adapter Service”
Section 1.2.5, “Platforms - CPU Service”

Connection Properties

none

Metrics

Table 1.17. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.18. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

none

1.2.1. Platforms - Process Service

Overview

Table 1.19. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.20.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.21. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2.2. Platforms - File System Service

Overview

Table 1.22. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.23. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2.3. Platforms - Directory Service

Overview

Table 1.24. Overview
Description:	Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.25.
Name	Description	Required	Internal Name
Path	Directory to monitor. / is not allowed.	yes	path

Note

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

Metrics

Table 1.26. Metrics
Name	Type	Description	Internal Name
Directory usage	measurement	Disk usage of this directory	usage
Number of files	measurement	Number of files in the directory	files
Number of items	measurement	Number of items in the directory (files, subdirs, symlinks)	total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2.4. Platforms - Network Adapter Service

Overview

Table 1.27. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.28. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.2.5. Platforms - CPU Service

Overview

Table 1.29. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.30. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3. Platforms - HP-UX Platform

Overview

Table 1.31. Overview
Description:	Hewlett-Packard HP-UX Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.3.1, “Platforms - Process Service”
Section 1.3.2, “Platforms - File System Service”
Section 1.3.3, “Platforms - Directory Service”
Section 1.3.4, “Platforms - Network Adapter Service”
Section 1.3.5, “Platforms - CPU Service”

Connection Properties

none

Metrics

Table 1.32. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.33. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

none

1.3.1. Platforms - Process Service

Overview

Table 1.34. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.35.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.36. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3.2. Platforms - File System Service

Overview

Table 1.37. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.38. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3.3. Platforms - Directory Service

Overview

Table 1.39. Overview
Description:	Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.40.
Name	Description	Required	Internal Name
Path	Directory to monitor. / is not allowed.	yes	path

Note

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

Metrics

Table 1.41. Metrics
Name	Type	Description	Internal Name
Directory usage	measurement	Disk usage of this directory	usage
Number of files	measurement	Number of files in the directory	files
Number of items	measurement	Number of items in the directory (files, subdirs, symlinks)	total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3.4. Platforms - Network Adapter Service

Overview

Table 1.42. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.43. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.3.5. Platforms - CPU Service

Overview

Table 1.44. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.45. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.4. Platforms - Java Platform

Overview

Table 1.46. Overview
Description:	Platform with 100% Java capability but not natively supported
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.47. Metrics
Name	Type	Description	Internal Name
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.48. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

none

1.5. Platforms - Linux Platform

Overview

Table 1.49. Overview
Description:	Linux Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.5.1, “Platforms - Process Service”
Section 1.5.2, “Platforms - File System Service”
Section 1.5.3, “Platforms - Directory Service”
Section 1.5.4, “Platforms - Network Adapter Service”
Section 1.5.5, “Platforms - CPU Service”

Connection Properties

Table 1.50.
Name	Description	Required	Internal Name
Enable Content Discovery	If true, attempts will be made to discover installed packages on this platform	yes	enableContentDiscovery
Enable Internal Yum Server	If true, an internal yum server will be started in order to process yum content requests made on the local machine.	yes	enableInternalYumServer
Yum server port	The port the plugin will listen on in order to process yum requests. This is ignored if the internal yum server is not enabled.	yes	yumPort
Metadata Cache Timeout	The time, in seconds, that the package metadata will always be considered valid. After the cache has lived this long or longer, the cache will be checked to see if it is stale, and if so, will be refreshed.	no	metadataCacheTimeout
Logs		yes	logs

Note

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

Metrics

Table 1.51. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch
Distribution Name	trait	name of the Linux distribution	distro.name
Distribution Version	trait	version of the Linux distribution	distro.version

Note

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

Configuration Properties

none

Operations

Table 1.52. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system
Clean Yum Metadata Cache	Deletes all cached package metadata

Package Types

Table 1.53. Package Types
Name	Category	Description
RPM File	Deployable	Red Hat installable package

1.5.1. Platforms - Process Service

Overview

Table 1.54. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.55.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.56. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.5.2. Platforms - File System Service

Overview

Table 1.57. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.58. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.5.3. Platforms - Directory Service

Overview

Table 1.59. Overview
Description:	Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.60.
Name	Description	Required	Internal Name
Path	Directory to monitor. / is not allowed.	yes	path

Note

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

Metrics

Table 1.61. Metrics
Name	Type	Description	Internal Name
Directory usage	measurement	Disk usage of this directory	usage
Number of files	measurement	Number of files in the directory	files
Number of items	measurement	Number of items in the directory (files, subdirs, symlinks)	total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.5.4. Platforms - Network Adapter Service

Overview

Table 1.62. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.63. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.5.5. Platforms - CPU Service

Overview

Table 1.64. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.65. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6. Platforms - Mac OS X Platform

Overview

Table 1.66. Overview
Description:	Mac OS X Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.6.1, “Platforms - Process Service”
Section 1.6.2, “Platforms - File System Service”
Section 1.6.3, “Platforms - Directory Service”
Section 1.6.4, “Platforms - Network Adapter Service”
Section 1.6.5, “Platforms - CPU Service”

Connection Properties

Table 1.67.
Name	Description	Required	Internal Name
Logs		yes	logs

Note

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

Metrics

Table 1.68. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.69. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

none

1.6.1. Platforms - Process Service

Overview

Table 1.70. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.71.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.72. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6.2. Platforms - File System Service

Overview

Table 1.73. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.74. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6.3. Platforms - Directory Service

Overview

Table 1.75. Overview
Description:	Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.76.
Name	Description	Required	Internal Name
Path	Directory to monitor. / is not allowed.	yes	path

Note

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

Metrics

Table 1.77. Metrics
Name	Type	Description	Internal Name
Directory usage	measurement	Disk usage of this directory	usage
Number of files	measurement	Number of files in the directory	files
Number of items	measurement	Number of items in the directory (files, subdirs, symlinks)	total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6.4. Platforms - Network Adapter Service

Overview

Table 1.78. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.79. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.6.5. Platforms - CPU Service

Overview

Table 1.80. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.81. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7. Platforms - Solaris Platform

Overview

Table 1.82. Overview
Description:	SUN Solaris Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.7.1, “Platforms - Process Service”
Section 1.7.2, “Platforms - File System Service”
Section 1.7.3, “Platforms - Directory Service”
Section 1.7.4, “Platforms - Network Adapter Service”
Section 1.7.5, “Platforms - CPU Service”

Connection Properties

Table 1.83.
Name	Description	Required	Internal Name
Logs		yes	logs

Note

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

Metrics

Table 1.84. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.85. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

none

1.7.1. Platforms - Process Service

Overview

Table 1.86. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.87.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.88. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7.2. Platforms - File System Service

Overview

Table 1.89. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.90. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7.3. Platforms - Directory Service

Overview

Table 1.91. Overview
Description:	Monitor a generic directory. This can be heavy for a directory with many sub-directories, so monitoring / is not allowed.
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.92.
Name	Description	Required	Internal Name
Path	Directory to monitor. / is not allowed.	yes	path

Note

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

Metrics

Table 1.93. Metrics
Name	Type	Description	Internal Name
Directory usage	measurement	Disk usage of this directory	usage
Number of files	measurement	Number of files in the directory	files
Number of items	measurement	Number of items in the directory (files, subdirs, symlinks)	total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7.4. Platforms - Network Adapter Service

Overview

Table 1.94. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.95. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.7.5. Platforms - CPU Service

Overview

Table 1.96. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.97. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.8. Platforms - Windows Platform

Overview

Table 1.98. Overview
Description:	Microsoft Windows Operating System
Singleton:	no
Plugin:	Platforms

Child Resource Types

Section 1.8.1, “Platforms - Process Service”
Section 1.8.2, “Platforms - File System Service”
Section 1.8.3, “Platforms - Network Adapter Service”
Section 1.8.4, “Platforms - CPU Service”

Connection Properties

Table 1.99.
Name	Description	Required	Internal Name
Enable Content Discovery	If true, attempts will be made to discover installed packages on this platform	yes	enableContentDiscovery
Event Tracking Enabled	Enables the collection of Windows events into the event subsystem	yes	eventTrackingEnabled
Regular Expression	A regular expression that if not-null must be matched by the event detail for the message to be accepted	no	regularExpression
Minimum Severity	The minimum severity event that will be collected	yes	minimumSeverity

Note

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

Metrics

Table 1.100. Metrics
Name	Type	Description	Internal Name
Free Memory	measurement	The total free system memory (does not include buffer or cache memory)	Native.MemoryInfo.free
Actual Free Memory	measurement	The actual total free system memory (includes unallocated memory as well as available buffer and cache memory)	Native.MemoryInfo.actualFree
Used Memory	measurement	The total used system memory (does not include buffer or cache memory)	Native.MemoryInfo.used
Actual Used Memory	measurement	The actual total used system memory (includes buffer and cache memory)	Native.MemoryInfo.actualUsed
Total Memory	measurement	The total system memory	Native.MemoryInfo.total
Free Swap Space	measurement	The total free system swap	Native.SwapInfo.free
Used Swap Space	measurement	The total used system swap	Native.SwapInfo.used
Total Swap Space	measurement	The total system swap	Native.SwapInfo.total
Idle	measurement	Idle percentage of all CPUs	CpuPerc.idle
System Load	measurement	Percentage of all CPUs running in system mode	CpuPerc.sys
User Load	measurement	Percentage of all CPUs running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of all CPUs waiting on I/O	CpuPerc.wait
Hostname	trait	Name that this platform is known as	Trait.hostname
OS Name	trait	Name that the operating system is known as	Trait.osname
OS Version	trait	Version of the operating system	Trait.osversion
Architecture	trait	Hardware architecture of the platform	Trait.sysarch

Note

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

Configuration Properties

none

Operations

Table 1.101. Metrics
Name	Description
Run Autodiscovery	Run an immediate discovery to search for new resources
View Process List	View running processes on this system

Package Types

Table 1.102. Package Types
Name	Category	Description
Installed Software	Deployable	Installed Windows Software

1.8.1. Platforms - Process Service

Overview

Table 1.103. Overview
Description:	A generic process monitoring service to track native process information based on a pid file or process query
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

Table 1.104.
Name	Description	Required	Internal Name
Type	Choice of using a pid file or a PIQL query to find the process to monitor	yes	type
Pid File	Fully qualified path to the pid file for the process to monitor	no	pidFile
Piql	Process Information Query Language for process to monitor	no	piql
Full Process Tree	If true, the entire process tree will be monitored	yes	fullProcessTree

Note

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

Metrics

Table 1.105. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all processes	Process.cpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all processes	Process.cpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all processes	Process.cpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all processes	Process.memory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all processes	Process.memory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all processes	Process.fileDescriptor.total

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.8.2. Platforms - File System Service

Overview

Table 1.106. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.107. Metrics
Name	Type	Description	Internal Name
Free Space	measurement	The total free bytes on filesystem	fileSystemUsage.free
Used Percentage	measurement	The percentage of disk used	fileSystemUsage.usePercent
Capacity	trait	The total size of the filesystem	fileSystemUsage.total
Volume Type	trait	The filesystem's generic type name	fileSystem.typeName
Drive Type	trait	The filesystem's operating system-specific type name	fileSystem.sysTypeName
name	trait	The name of this device	fileSystem.devName
Free Files	measurement	The number of free file nodes on the filesystem	fileSystemUsage.freeFiles
Flags	trait	The filesystem's flags	fileSystem.flags
Used	measurement	The total bytes used on the filesystem	fileSystemUsage.used
Disk Reads	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Reads per Minute	measurement	The number of physical disk reads	fileSystemUsage.diskReads
Disk Writes	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Writes per Minute	measurement	The number of physical disk writes	fileSystemUsage.diskWrites
Disk Read Bytes	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Read Bytes per Minute	measurement	The number of physical disk bytes read	fileSystemUsage.diskReadBytes
Disk Write Bytes	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Write Bytes per Minute	measurement	The number of physical disk bytes written	fileSystemUsage.diskWriteBytes
Disk Queue	measurement	The number of I/Os currently in progress	fileSystemUsage.diskQueue

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.8.3. Platforms - Network Adapter Service

Overview

Table 1.108. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.109. Metrics
Name	Type	Description	Internal Name
Inet4Address	trait	IP address of the network adapter	Trait.net4.address
Interface Flags	trait	Flag constants for network related operations	Trait.interfaceFlags
Bytes Received	measurement	The total number of bytes received across this network interface since it started	rxBytes
Bytes Received per Minute	measurement	The total number of bytes received across this network interface since it started	rxBytes
Packets Received	measurement	The total number of packets received across this network interface since it started	rxPackets
Packets Received per Minute	measurement	The total number of packets received across this network interface since it started	rxPackets
Bytes Transmitted	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Bytes Transmitted per Minute	measurement	The total number of bytes transmitted across this network interface since it started	txBytes
Packets Transmitted	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Packets Transmitted per Minute	measurement	The total number of packets transmitted across this network interface since it started	txPackets
Receive Errors	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Errors per Minute	measurement	'errors' statistic for received packets across this network interface since it started	rxErrors
Receive Packets Dropped	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Packets Dropped per Minute	measurement	'dropped' statistic for received packets across this network interface since it started	rxDropped
Receive Overrurns	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Overrurns per Minute	measurement	'overruns' statistic for received packets across this network interface since it started	rxOverruns
Receive Frame	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Receive Frame per Minute	measurement	'frame' statistic for received packets across this network interface since it started	rxFrame
Transmit Errors	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Errors per Minute	measurement	'errors' statistic for transmitted packets across this network interface since it started	txErrors
Transmit Packets Dropped	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Packets Dropped per Minute	measurement	'dropped' statistic for transmitted packets across this network interface since it started	txDropped
Transmit Overruns	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Overruns per Minute	measurement	'overruns' statistic for transmitted packets across this network interface since it started	txOverruns
Transmit Collisions	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Collisions per Minute	measurement	'collisions' statistic for transmitted packets across this network interface since it started	txCollisions
Transmit Carrier	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier
Transmit Carrier per Minute	measurement	'carrier' statistic for transmitted packets across this network interface since it started	txCarrier

Note

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

Configuration Properties

none

Operations

none

Package Types

none

1.8.4. Platforms - CPU Service

Overview

Table 1.110. Overview
Description:
Singleton:	no
Plugin:	Platforms

Child Resource Types

none

Connection Properties

none

Metrics

Table 1.111. Metrics
Name	Type	Description	Internal Name
Idle	measurement	Idle percentage of this CPU	CpuPerc.idle
System Load	measurement	Percentage of this CPU running in system mode	CpuPerc.sys
User Load	measurement	Percentage of this CPU running in user mode	CpuPerc.user
Wait Load	measurement	Percentage of this CPU waiting on I/O	CpuPerc.wait
User Time	measurement	The total system CPU user time	Cpu.user
User Time per Minute	measurement	The total system CPU user time	Cpu.user
Nice Time	measurement	The total system CPU nice time	Cpu.nice
Nice Time per Minute	measurement	The total system CPU nice time	Cpu.nice
System Time	measurement	The total system CPU kernel time	Cpu.sys
System Time per Minute	measurement	The total system CPU kernel time	Cpu.sys
Idle Time	measurement	The total system CPU idle time	Cpu.idle
Idle Time per Minute	measurement	The total system CPU idle time	Cpu.idle
Wait Time	measurement	The total system CPU I/O wait time	Cpu.wait
Wait Time per Minute	measurement	The total system CPU I/O wait time	Cpu.wait
Vendor	trait	Vendor of this CPU	CpuTrait.vendor
CPU Model	trait	Model of this CPU	CpuTrait.model
CPU Speed	trait	Speed of this CPU in Mhz	CpuTrait.mhz
Cache size	trait	Cache Size of this CPU	CpuTrait.cacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

Chapter 2. Core Managed Resources

There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.

2.1. Apache - HTTP Server

Overview

Table 2.1. Overview
Description:	an Apache HTTP Server instance
Singleton:	no
Plugin:	Apache

Child Resource Types

Section 2.1.1, “Apache - Virtual Host Service”
Section 2.1.2, “Apache - Mod JK Service”

Autodiscovery Process Scans

Table 2.2. Metrics
Name	Query
HttpdOnWindows	process\|basename\|match=(?i)httpd.exe,process\|basename\|match\|parent=(?i)httpd.exe
ApacheOnWindows	process\|basename\|match=(?i)Apache.exe,process\|basename\|match\|parent=(?i)Apache.exe
HttpdOnUnix	process\|basename\|match=httpd.,process\|basename\|nomatch\|parent=httpd.
Apache2OnUnix	process\|basename\|match=apache2,process\|basename\|nomatch\|parent=apache2

Connection Properties

Table 2.3.
Name	Description	Required	Internal Name
Enable augeas support	Enable augeas support	yes	augeasEnabled
Augeas Module Name	the name of the Augeas module/lens to use for loading and updating this resource's configuration	yes	augeasModuleName
Httpd config file	Location of the Apache main configuration file.	yes	configurationFilesInclusionPatterns
Virtual Hosts Configuration Placement	How should the new virtual host definitions be put in the configuration	yes	vhostCreationPolicy
Path To Contain Virtual Hosts Files	If the new virtual hosts should be created in standalone files, this mask determines where to create those files. The '*' in the path is replaced by the name of the virtual host. If the path is relative, it is considered relative to server root.	yes	vhostFilesMask
Error Log File Path	The absolute path to the error log file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'logs/error_log' on UNIX or 'logs\error.log' on Windows.	no	errorLogFilePath
Error Log Events Enabled	A flag indicating whether or not generation of Events for new error log entries is enabled.	yes	errorLogEventsEnabled
Error Log Minimum Severity	The minimum severity of error log entry Events that should be collected. If not specified, there is no minimum severity (i.e. all events will be collected).	no	errorLogMinimumSeverity
Error Log Includes Pattern	A regular expression against which an error log entry's detail is matched to determine if an Event should be fired for that entry. If not specified, no filtering of log entries will be done based on their detail.	no	errorLogIncludesPattern
Custom Module Names	Apache can use 2 values to identify a module. Either its module name that is used in the LoadModule directive or its source file that can be used in the IfModule directive (as of Apache 2.1 the IfModule directive can but doesn't have to use the module name, too). The plugin contains the mappings of the module names to module files for all the standard apache modules mentioned on the http://httpd.apache.org/docs/current/mod/ plus the SNMP module and mod_jk. If you use any non-standard modules and use their source file in the IfModule directives, you have to add the module-name-to-module-file mapping to this list so that the plugin can determine the correct runtime configuration of the apache instance.	yes	customModuleNames
Server Root	the absolute path of the Apache server root directory	yes	serverRoot
Executable Path	the path to the Apache executable - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default value is 'bin/httpd' on UNIX or 'bin\Apache.exe' on Windows	no	executablePath
Control Script Path	the path to the Apache control script - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'bin/apachectl' on UNIX or the Apache executable on Windows	no	controlScriptPath
Config File	the path to the httpd.conf file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'conf/httpd.conf' on UNIX	yes	configFile
URL	The http or https URL that will be used to check availability for this Apache server; if not set, availability will be determined based on whether plugin can connect to the Apache server's SNMP agent. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL.	no	url
SNMP Agent Host	the host name or IP address of the Apache SNMP agent (typically '127.0.0.1')	no	snmpAgentHost
SNMP Agent Port	the UDP port of the Apache SNMP agent (typically '1610')	no	snmpAgentPort
SNMP Agent Community	the SNMP community of the Apache SNMP agent (typically 'public')	no	snmpAgentCommunity
SNMP Request Timeout	the timeout, in milliseconds, for requests to the Apache SNMP agent; defaults to 2000	no	snmpRequestTimeout
SNMP Request Retries	the number of times a request that has timed out should be retried; defaults to 1	no	snmpRequestRetries
Restart After Configuration Update	If set to true, each configuration update of the server or any underlying virtual host or directory is followed by the restart of the Apache instance so that the configuration changes are applied immediately. If set to false, you have to manually restart the server (for example using the restart operation in the operations tab) once all the configuration updates are finished.	yes	restartAfterConfigurationUpdate
BMX Handler	If set to a valid URL to mod_bmx handler allow to use mod_bmx instead of mod_snmp.	no	bmxUrl

Note

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

Metrics

Table 2.4. Metrics
Name	Type	Description	Internal Name
Number of Concurrent Connections	measurement	Number of Concurrent Connections	applInboundAssociations
Server Built	trait	the date and time this Apache server's binary was compiled	serverBuilt
Start Time	trait	the date and time this Apache server was last started	wwwServiceStartTime
Time to ping the server for availability	measurement	Time it took to ping the server for availability over http; this includes DNS lookup time.	rhq_avail_ping_time

Note

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

Configuration Properties

Table 2.5.
Name	Description	Required	Internal Name
Listen		yes	Listen
Name Virtual Host	A required directive if you want to configure name-based virtual hosts. Although the value can be hostname it is recommended that you always use an IP address. IPv6 addresses must be enclosed in square brackets. To receive requests on all interfaces, you can set the value to *. Note that the IP address of a name-based virtual host must exactly match the value of this property. The address may be optionally followed by the port specification to further limit the directive effect.	no	NameVirtualHost

Note

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

Operations

Table 2.6. Metrics
Name	Description
Start	Starts this Apache server, or returns an error if it is already running. The control script used is specified in the Connection Properties.
Stop	Stops this Apache server, or returns an error if it is not running. The control script used is specified in the Connection Properties.
Restart	Restarts the Apache server by sending its process a SIGHUP. If the server is not running, it is started. This command automatically checks the server's configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. Only supported on UNIX platforms.
Start with SSL Support	Starts this Apache server with support for SSL. The control script used is specified in the Connection Properties. Only supported on Apache 1.3.
Restart Gracefully	Gracefully restarts the Apache server by sending it a SIGUSR1. If the daemon is not running, it is started. This differs from a normal restart in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them. This command automatically checks the configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties.
Check Configuration File Syntax	Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. The control script used is specified in the Connection Properties. Only supported on UNIX platforms.
Install mod_jk configuration	Tries to install a mod_jk configuration in httpd.conf if none is detected. This includes a workers.properties file and urimap file

Package Types

none

2.1.1. Apache - Virtual Host Service

Overview

Table 2.7. Overview
Description:
Singleton:	no
Plugin:	Apache

Child Resource Types

Section 2.1.1.1, “Apache - Directory Service”
Section 2.1.1.2, “Apache - IfModule Service”

Connection Properties

Table 2.8.
Name	Description	Required	Internal Name
Response Time Log File	the full path to the log file containing response-time stats for this virtual host	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
URL	The http or https URL that will be used to check availability for this virtual host. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. If the URL is not set, the availability is determined by pinging the configured SNMP location.	no	url

Note

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

Metrics

Table 2.9. Metrics
Name	Type	Description	Internal Name
Host	trait	the host name or IP address of this virtual host	wwwServiceName
Port	trait	the TCP port of this virtual host	wwwServiceProtocol
Administrator	trait	the administrator of this virtual host	wwwServiceContact
Total Number of Requests	measurement	The number of inbound requests on the service	wwwSummaryInRequests
Total Number of Requests per Minute	measurement	The number of inbound requests on the service	wwwSummaryInRequests
Total Number of Bytes Received	measurement	The number of bytes received by the service	wwwSummaryInLowBytes
Total Number of Bytes Received per Minute	measurement	The number of bytes received by the service	wwwSummaryInLowBytes
Total Number of Responses	measurement	The number of outbound requests on the service	wwwSummaryOutResponses
Total Number of Responses per Minute	measurement	The number of outbound requests on the service	wwwSummaryOutResponses
Total Number of Bytes Sent	measurement	The number of bytes sent by the service	wwwSummaryOutLowBytes
Total Number of Bytes Sent per Minute	measurement	The number of bytes sent by the service	wwwSummaryOutLowBytes
Number of GET Requests	measurement	The number of inbound GET requests on the service	wwwRequestInRequests.GET
Number of GET Requests per Minute	measurement	The number of inbound GET requests on the service	wwwRequestInRequests.GET
Number of HEAD Requests	measurement	The number of inbound HEAD requests on the service	wwwRequestInRequests.HEAD
Number of HEAD Requests per Minute	measurement	The number of inbound HEAD requests on the service	wwwRequestInRequests.HEAD
Number of POST Requests	measurement	The number of inbound POST requests on the service	wwwRequestInRequests.POST
Number of POST Requests per Minute	measurement	The number of inbound POST requests on the service	wwwRequestInRequests.POST
Number of PUT Requests	measurement	The number of inbound PUT requests on the service	wwwRequestInRequests.PUT
Number of PUT Requests per Minute	measurement	The number of inbound PUT requests on the service	wwwRequestInRequests.PUT
Bytes Received for GET Requests	measurement	The number of bytes received by GET requests on the service	wwwRequestInBytes.GET
Bytes Received for GET Requests per Minute	measurement	The number of bytes received by GET requests on the service	wwwRequestInBytes.GET
Bytes Received for HEAD Requests	measurement	The number of bytes received by HEAD requests on the service	wwwRequestInBytes.HEAD
Bytes Received for HEAD Requests per Minute	measurement	The number of bytes received by HEAD requests on the service	wwwRequestInBytes.HEAD
Bytes Received for POST Requests	measurement	The number of bytes received by POST requests on the service	wwwRequestInBytes.POST
Bytes Received for POST Requests per Minute	measurement	The number of bytes received by POST requests on the service	wwwRequestInBytes.POST
Bytes Received for PUT Requests	measurement	The number of bytes received by PUT requests on the service	wwwRequestInBytes.PUT
Bytes Received for PUT Requests per Minute	measurement	The number of bytes received by PUT requests on the service	wwwRequestInBytes.PUT
Number of 200 Responses	measurement	The number of 200 responses generated by this service	wwwResponseOutResponses.200
Number of 200 Responses per Minute	measurement	The number of 200 responses generated by this service	wwwResponseOutResponses.200
Number of 301 Responses	measurement	The number of 301 responses generated by this service	wwwResponseOutResponses.301
Number of 301 Responses per Minute	measurement	The number of 301 responses generated by this service	wwwResponseOutResponses.301
Number of 302 Responses	measurement	The number of 302 responses generated by this service	wwwResponseOutResponses.302
Number of 302 Responses per Minute	measurement	The number of 302 responses generated by this service	wwwResponseOutResponses.302
Number of 401 Responses	measurement	The number of 401 responses generated by this service	wwwResponseOutResponses.401
Number of 401 Responses per Minute	measurement	The number of 401 responses generated by this service	wwwResponseOutResponses.401
Number of 403 Responses	measurement	The number of 403 responses generated by this service	wwwResponseOutResponses.403
Number of 403 Responses per Minute	measurement	The number of 403 responses generated by this service	wwwResponseOutResponses.403
Number of 404 Responses	measurement	The number of 404 responses generated by this service	wwwResponseOutResponses.404
Number of 404 Responses per Minute	measurement	The number of 404 responses generated by this service	wwwResponseOutResponses.404
Number of 500 Responses	measurement	The number of 500 responses generated by this service	wwwResponseOutResponses.500
Number of 500 Responses per Minute	measurement	The number of 500 responses generated by this service	wwwResponseOutResponses.500
Bytes Sent for 200 Responses	measurement	The number of bytes sent for 200 responses generated by this service	wwwResponseOutBytes.200
Bytes Sent for 200 Responses per Minute	measurement	The number of bytes sent for 200 responses generated by this service	wwwResponseOutBytes.200
Bytes Sent for 301 Responses	measurement	The number of bytes sent for 301 responses generated by this service	wwwResponseOutBytes.301
Bytes Sent for 301 Responses per Minute	measurement	The number of bytes sent for 301 responses generated by this service	wwwResponseOutBytes.301
Bytes Sent for 302 Responses	measurement	The number of bytes sent for 302 responses generated by this service	wwwResponseOutBytes.302
Bytes Sent for 302 Responses per Minute	measurement	The number of bytes sent for 302 responses generated by this service	wwwResponseOutBytes.302
Bytes Sent for 401 Responses	measurement	The number of bytes sent for 401 responses generated by this service	wwwResponseOutBytes.401
Bytes Sent for 401 Responses per Minute	measurement	The number of bytes sent for 401 responses generated by this service	wwwResponseOutBytes.401
Bytes Sent for 403 Responses	measurement	The number of bytes sent for 403 responses generated by this service	wwwResponseOutBytes.403
Bytes Sent for 403 Responses per Minute	measurement	The number of bytes sent for 403 responses generated by this service	wwwResponseOutBytes.403
Bytes Sent for 404 Responses	measurement	The number of bytes sent for 404 responses generated by this service	wwwResponseOutBytes.404
Bytes Sent for 404 Responses per Minute	measurement	The number of bytes sent for 404 responses generated by this service	wwwResponseOutBytes.404
Bytes Sent for 500 Responses	measurement	The number of bytes sent for 500 responses generated by this service	wwwResponseOutBytes.500
Bytes Sent for 500 Responses per Minute	measurement	The number of bytes sent for 500 responses generated by this service	wwwResponseOutBytes.500
HTTP Response Time	calltime	The minimum, maximum, and average response times for HTTP requests serviced by this virtual host	ResponseTime

Note

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

Configuration Properties

Table 2.10.
Name	Description	Required	Internal Name
Error Log	Sets the name of the file to which the server will log any errors it encounters. If the file-path is not absolute then it is assumed to be relative to the ServerRoot. If the file-path begins with a pipe (\|) then it is assumed to be a command to spawn to handle the error log. Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1).	no	ErrorLog
Request logs	Configure the logging of requests to the server.	yes	CustomLog
Server Name	Sets the request scheme, hostname and port that the server uses to identify itself. This is used when creating redirection URLs. If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse lookup on the IP address. If no port is specified in the ServerName, then the server will use the port from the incoming request. For optimal reliability and predictability, you should specify an explicit hostname and port using the ServerName directive. If you are using name-based virtual hosts, the ServerName inside a <VirtualHost> section specifies what hostname must appear in the request's Host: header to match this virtual host.	no	ServerName
Server Alias		yes	ServerAlias
Server Admin	The email address or URL to contact the server administrator in case of errors. This address is used in various Apache generated error messages.	no	ServerAdmin
Document Root	This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. If the directory-path is not absolute then it is assumed to be relative to the ServerRoot. The DocumentRoot should be specified without a trailing slash.	yes	DocumentRoot
Add Default Charset	This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types.	no	AddDefaultCharset
Alias	The Alias directive allows documents to be stored in the local filesystem other than under the DocumentRoot. With " Alias /image /ftp/pub/image", a request for http://myserver/image/foo.gif would cause the server to return the file /ftp/pub/image/foo.gif. Only complete path segments are matched, so the above alias would not match a request for http://myserver/imagefoo.gif. Note that you may need to specify additional <Directory> sections which cover the destination of aliases. In particular, if you are creating an Alias to a directory outside of your DocumentRoot, you may need to explicitly permit access to the target directory.	yes	Alias
Default Type	There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType.	no	DefaultType
Directory Index	Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory.	no	DirectoryIndex
Error Document	In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error.	yes	ErrorDocument
Timeout	The TimeOut directive defines the length of time Apache will wait for I/O in various circumstances.	no	Timeout
Options	The Options directive controls which server features are available in a particular directory.	no	Options
Use Canonical Name	With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.	no	UseCanonicalName
Use Canonical Physical Port	In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number.	no	UseCanonicalPhysicalPort

Note

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

Operations

none

Package Types

none

2.1.1.1. Apache - Directory Service

Overview

Table 2.11. Overview
Description:
Singleton:	no
Plugin:	Apache

Child Resource Types

Section 2.1.1.1.1, “Apache - IfModule Parameters Service”

Connection Properties

Table 2.12.
Name	Description	Required	Internal Name
Regular Expression	Does the name of this directory denote a regular expression?	yes	regexp

Note

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

Metrics

none

Configuration Properties

Table 2.13.
Name	Description	Required	Internal Name
IfModule Conditions	List of modules which must be loaded to use directive configuration.	yes	IfModules
Order	The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two.	no	Order
Allow	The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface.	no	Allow
Deny	The arguments for the Deny directive are identical to the arguments for the Allow directive.	no	Deny
Allow Override		no	AllowOverride
Add Default Charset	This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types.	no	AddDefaultCharset
Default Type	There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType.	no	DefaultType
Directory Index	Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory.	no	DirectoryIndex
Error Document	In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error.	yes	ErrorDocument
Options	The Options directive controls which server features are available in a particular directory.	no	Options
Use Canonical Name	With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.	no	UseCanonicalName
Use Canonical Physical Port	In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number.	no	UseCanonicalPhysicalPort

Note

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

Operations

none

Package Types

none

2.1.1.1.1. Apache - IfModule Parameters Service

Overview

Table 2.14. Overview
Description:
Singleton:	no
Plugin:	Apache

Child Resource Types

none

Connection Properties

none

Metrics

none

Configuration Properties

Table 2.15.
Name	Description	Required	Internal Name
IfModule Conditions	List of modules which must be loaded to use directive configuration.	yes	IfModules
Order	The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two.	no	Order
Allow	The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface.	no	Allow
Deny	The arguments for the Deny directive are identical to the arguments for the Allow directive.	no	Deny
Allow Override		no	AllowOverride
Add Default Charset	This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types.	no	AddDefaultCharset
Default Type	There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType.	no	DefaultType
Directory Index	Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory.	no	DirectoryIndex
Error Document	In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error.	yes	ErrorDocument
Options	The Options directive controls which server features are available in a particular directory.	no	Options
Use Canonical Name	With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.	no	UseCanonicalName
Use Canonical Physical Port	In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number.	no	UseCanonicalPhysicalPort

Note

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

Operations

none

Package Types

none

2.1.1.2. Apache - IfModule Service

Overview

Table 2.16. Overview
Description:
Singleton:	no
Plugin:	Apache

Child Resource Types

none

Connection Properties

none

Metrics

none

Configuration Properties

Table 2.17.
Name	Description	Required	Internal Name
IfModule Conditions	List of modules which must be loaded to use directive configuration.	yes	IfModules
Order	The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two.	no	Order
Allow	The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface.	no	Allow
Deny	The arguments for the Deny directive are identical to the arguments for the Allow directive.	no	Deny
Allow Override		no	AllowOverride
Add Default Charset	This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types.	no	AddDefaultCharset
Default Type	There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType.	no	DefaultType
Directory Index	Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory.	no	DirectoryIndex
Error Document	In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error.	yes	ErrorDocument
Options	The Options directive controls which server features are available in a particular directory.	no	Options
Use Canonical Name	With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.	no	UseCanonicalName
Use Canonical Physical Port	In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number.	no	UseCanonicalPhysicalPort

Note

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

Operations

none

Package Types

none

2.1.2. Apache - Mod JK Service

Overview

Table 2.18. Overview
Description:	Management of mod_jk
Singleton:	yes
Plugin:	Apache

Child Resource Types

none

Connection Properties

Table 2.19.
Name	Description	Required	Internal Name
Path to workers.properties	The path to the file containing worker properties. If this is a relative path, it will be looked up in the server root of the parent Apache server	no	workerFile
Path to the uriworkers file	The path to the file containing uri to worker mappings. If this is a relative path, it will be looked up in the server root of the parent Apache server	no	uriWorkerFile

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

2.2. IIS - Server

Important

This plug-in is deprecated in JBoss ON 3.3 and will be removed in a future release.

Overview

Table 2.20. Overview
Description:	IIS Web Server
Singleton:	no
Plugin:	IIS

Child Resource Types

Section 2.2.1, “IIS - VHost Service”

Autodiscovery Process Scans

none

Connection Properties

none

Metrics

Table 2.21. Metrics
Name	Type	Description	Internal Name
Bytes Sent	measurement	Shows the rate that data bytes are sent by the Web service.	Bytes Sent/sec
Bytes Sent per Minute	measurement	Shows the rate that data bytes are sent by the Web service.	Bytes Sent/sec
Bytes Received	measurement	Shows the rate that data bytes are received by the Web service.	Bytes Received/sec
Bytes Received per Minute	measurement	Shows the rate that data bytes are received by the Web service.	Bytes Received/sec
Total Files Sent	measurement	Shows the total number of files sent by the Web service (counted since service startup).	Total Files Sent
Total Files Sent per Minute	measurement	Shows the total number of files sent by the Web service (counted since service startup).	Total Files Sent
Total Files Received	measurement	Shows the total number of files received by the Web service (counted since service startup).	Total Files Received
Total Files Received per Minute	measurement	Shows the total number of files received by the Web service (counted since service startup).	Total Files Received
Total Files Transferred	measurement	Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup).	Total Files Transferred
Total Files Transferred per Minute	measurement	Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup).	Total Files Transferred
Current Anonymous Users	measurement	Shows the number of users who currently have an anonymous connection using the Web service.	Current Anonymous Users
Current NonAnonymous Users	measurement	Shows the number of users who currently have a non-anonymous connection using the Web service.	Current NonAnonymous Users
Total Anonymous Users	measurement	Shows the total number of users who established an anonymous connection with the Web service (counted since service startup).	Total Anonymous Users
Total Anonymous Users per Minute	measurement	Shows the total number of users who established an anonymous connection with the Web service (counted since service startup).	Total Anonymous Users
Total Non Anonymous Users	measurement	Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup).	Total NonAnonymous Users
Total Non Anonymous Users per Minute	measurement	Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup).	Total NonAnonymous Users
Maximum Anonymous Users	measurement	Shows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup).	Maximum Anonymous Users
Maximum Non Anonymous Users	measurement	Shows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup).	Maximum NonAnonymous Users
Current Connections	measurement	Shows the current number of connections established with the Web service.	Current Connections
Maximum Connections	measurement	Shows the maximum number of simultaneous connections established with the Web service.	Maximum Connections
Total Logon Attempts	measurement	Shows the number of logons that have been attempted using the Web service (counted since service startup).	Total Logon Attempts
Total Logon Attempts per Minute	measurement	Shows the number of logons that have been attempted using the Web service (counted since service startup).	Total Logon Attempts
Total GET Requests	measurement	Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms.	Total Get Requests
Total GET Requests per Minute	measurement	Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms.	Total Get Requests
Total POST Requests	measurement	Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests.	Total Post Requests
Total POST Requests per Minute	measurement	Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests.	Total Post Requests
Total HEAD Requests	measurement	Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed.	Total Head Requests
Total HEAD Requests per Minute	measurement	Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed.	Total Head Requests
Total PUT Requests	measurement	Shows the number of HTTP requests using the PUT method (counted since service startup).	Total Put Requests
Total PUT Requests per Minute	measurement	Shows the number of HTTP requests using the PUT method (counted since service startup).	Total Put Requests
Total DELETE Requests	measurement	Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals.	Total Delete Requests
Total DELETE Requests per Minute	measurement	Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals.	Total Delete Requests
Total TRACE Requests	measurement	Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes.	Total Trace Requests
Total TRACE Requests per Minute	measurement	Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes.	Total Trace Requests
Total Other Request Methods	measurement	Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications.	Total Other Request Methods
Total Other Request Methods per Minute	measurement	Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications.	Total Other Request Methods
Total Method Requests	measurement	Shows the number of all HTTP requests (counted since service startup).	Total Method Requests
Total Method Requests per Minute	measurement	Shows the number of all HTTP requests (counted since service startup).	Total Method Requests
Total CGI Requests	measurement	Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup.	Total CGI Requests
Total CGI Requests per Minute	measurement	Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup.	Total CGI Requests
Total ISAPI Extension Requests	measurement	Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup.	Total ISAPI Extension Requests
Total ISAPI Extension Requests per Minute	measurement	Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup.	Total ISAPI Extension Requests
Total Not Found Errors	measurement	Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup.	Total Not Found Errors
Total Not Found Errors per Minute	measurement	Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup.	Total Not Found Errors
Total Locked Errors	measurement	Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup.	Total Locked Errors
Total Locked Errors per Minute	measurement	Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup.	Total Locked Errors
Current CGI Requests	measurement	Shows the current number of CGI requests that are simultaneously being processed by the Web service.	Current CGI Requests
Current CGI Requests per Minute	measurement	Shows the current number of CGI requests that are simultaneously being processed by the Web service.	Current CGI Requests
Current ISAPI Extension Requests	measurement	Shows the current number of Extension requests that are simultaneously being processed by the Web service.	Current ISAPI Extension Requests
Maximum CGI Requests	measurement	Shows the maximum number of CGI requests simultaneously processed by the Web service.	Maximum CGI Requests
Maximum ISAPI Extension Requests	measurement	Shows the maximum number of Extension requests simultaneously processed by the Web service.	Maximum ISAPI Extension Requests
Total Blocked Async I/O Requests	measurement	Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup).	Total Blocked Async I/O Requests
Total Blocked Async I/O Requests per Minute	measurement	Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup).	Total Blocked Async I/O Requests
Total Allowed Async I/O Requests	measurement	Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted.	Total Allowed Async I/O Requests
Total Allowed Async I/O Requests per Minute	measurement	Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted.	Total Allowed Async I/O Requests
Total Rejected Async I/O Requests	measurement	Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup).	Total Rejected Async I/O Requests
Total Rejected Async I/O Requests per Minute	measurement	Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup).	Total Rejected Async I/O Requests
Current Blocked Async I/O Requests	measurement	Shows current requests that are temporarily blocked due to bandwidth throttling settings.	Current Blocked Async I/O Requests
Measured Async I/O Bandwidth Usage	measurement	Shows the measured bandwidth of asynchronous I/O averaged over a minute.	Measured Async I/O Bandwidth Usage
Total Connection Attempts (all Instances)	measurement	Shows the number of connections that have been attempted using the Web service (counted since service startup). This counter is for all instances listed.	Total Connection Attempts (all instances)
Total Connection Attempts (all Instances) per Minute	measurement	Shows the number of connections that have been attempted using the Web service (counted since service startup). This counter is for all instances listed.	Total Connection Attempts (all instances)
Service Uptime	measurement	The amount of time this service has been up for	Service Uptime

Note

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

Configuration Properties

none

Operations

Table 2.22. Metrics
Name	Description
Start	Starts IIS and, if necessary, dependent services
Stop	Shuts down IIS

Package Types

none

2.2.1. IIS - VHost Service

Overview

Table 2.23. Overview
Description:	IIS VHost
Singleton:	no
Plugin:	IIS

Child Resource Types

none

Connection Properties

Table 2.24.
Name	Description	Required	Internal Name
Site Name		yes	siteName
Hostname		yes	hostname
Port		yes	port
Ip Address		yes	ipAddress
Doc Root		yes	docRoot
Ssl		yes	ssl
Log Directory		yes	logDirectory
Log Format	The format log entries are written in. This is a per-site, general option of the W3C Extended Log File Format. Format must contain the following tokens - 'date' ,'time' , 'c-ip', 'cs-uri-stem', 'sc-status', and 'time-taken' - but can include others. Tokens must not have quotes around them, and should be space-delimited.	yes	responseTimeLogFormat
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms

Note

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

Metrics

Table 2.25. Metrics
Name	Type	Description	Internal Name
Bytes Sent	measurement	Shows the rate that data bytes are sent by the Web service.	Bytes Sent/sec
Bytes Sent per Minute	measurement	Shows the rate that data bytes are sent by the Web service.	Bytes Sent/sec
Bytes Received	measurement	Shows the rate that data bytes are received by the Web service.	Bytes Received/sec
Bytes Received per Minute	measurement	Shows the rate that data bytes are received by the Web service.	Bytes Received/sec
Total Files Sent	measurement	Shows the total number of files sent by the Web service (counted since service startup).	Total Files Sent
Total Files Sent per Minute	measurement	Shows the total number of files sent by the Web service (counted since service startup).	Total Files Sent
Total Files Received	measurement	Shows the total number of files received by the Web service (counted since service startup).	Total Files Received
Total Files Received per Minute	measurement	Shows the total number of files received by the Web service (counted since service startup).	Total Files Received
Total Files Transferred	measurement	Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup).	Total Files Transferred
Total Files Transferred per Minute	measurement	Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup).	Total Files Transferred
Current Anonymous Users	measurement	Shows the number of users who currently have an anonymous connection using the Web service.	Current Anonymous Users
Current NonAnonymous Users	measurement	Shows the number of users who currently have a non-anonymous connection using the Web service.	Current NonAnonymous Users
Total Anonymous Users	measurement	Shows the total number of users who established an anonymous connection with the Web service (counted since service startup).	Total Anonymous Users
Total Anonymous Users per Minute	measurement	Shows the total number of users who established an anonymous connection with the Web service (counted since service startup).	Total Anonymous Users
Total Non Anonymous Users	measurement	Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup).	Total NonAnonymous Users
Total Non Anonymous Users per Minute	measurement	Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup).	Total NonAnonymous Users
Maximum Anonymous Users	measurement	Shows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup).	Maximum Anonymous Users
Maximum Non Anonymous Users	measurement	Shows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup).	Maximum NonAnonymous Users
Current Connections	measurement	Shows the current number of connections established with the Web service.	Current Connections
Maximum Connections	measurement	Shows the maximum number of simultaneous connections established with the Web service.	Maximum Connections
Total Logon Attempts	measurement	Shows the number of logons that have been attempted using the Web service (counted since service startup).	Total Logon Attempts
Total Logon Attempts per Minute	measurement	Shows the number of logons that have been attempted using the Web service (counted since service startup).	Total Logon Attempts
Total GET Requests	measurement	Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms.	Total Get Requests
Total GET Requests per Minute	measurement	Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms.	Total Get Requests
Total POST Requests	measurement	Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests.	Total Post Requests
Total POST Requests per Minute	measurement	Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests.	Total Post Requests
Total HEAD Requests	measurement	Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed.	Total Head Requests
Total HEAD Requests per Minute	measurement	Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed.	Total Head Requests
Total PUT Requests	measurement	Shows the number of HTTP requests using the PUT method (counted since service startup).	Total Put Requests
Total PUT Requests per Minute	measurement	Shows the number of HTTP requests using the PUT method (counted since service startup).	Total Put Requests
Total DELETE Requests	measurement	Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals.	Total Delete Requests
Total DELETE Requests per Minute	measurement	Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals.	Total Delete Requests
Total TRACE Requests	measurement	Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes.	Total Trace Requests
Total TRACE Requests per Minute	measurement	Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes.	Total Trace Requests
Total Other Request Methods	measurement	Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications.	Total Other Request Methods
Total Other Request Methods per Minute	measurement	Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications.	Total Other Request Methods
Total Method Requests	measurement	Shows the number of all HTTP requests (counted since service startup).	Total Method Requests
Total Method Requests per Minute	measurement	Shows the number of all HTTP requests (counted since service startup).	Total Method Requests
Total CGI Requests	measurement	Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup.	Total CGI Requests
Total CGI Requests per Minute	measurement	Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup.	Total CGI Requests
Total ISAPI Extension Requests	measurement	Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup.	Total ISAPI Extension Requests
Total ISAPI Extension Requests per Minute	measurement	Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup.	Total ISAPI Extension Requests
Total Not Found Errors	measurement	Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup.	Total Not Found Errors
Total Not Found Errors per Minute	measurement	Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup.	Total Not Found Errors
Total Locked Errors	measurement	Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup.	Total Locked Errors
Total Locked Errors per Minute	measurement	Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup.	Total Locked Errors
Current CGI Requests	measurement	Shows the current number of CGI requests that are simultaneously being processed by the Web service.	Current CGI Requests
Current CGI Requests per Minute	measurement	Shows the current number of CGI requests that are simultaneously being processed by the Web service.	Current CGI Requests
Current ISAPI Extension Requests	measurement	Shows the current number of Extension requests that are simultaneously being processed by the Web service.	Current ISAPI Extension Requests
Maximum CGI Requests	measurement	Shows the maximum number of CGI requests simultaneously processed by the Web service.	Maximum CGI Requests
Maximum ISAPI Extension Requests	measurement	Shows the maximum number of Extension requests simultaneously processed by the Web service.	Maximum ISAPI Extension Requests
Total Blocked Async I/O Requests	measurement	Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup).	Total Blocked Async I/O Requests
Total Blocked Async I/O Requests per Minute	measurement	Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup).	Total Blocked Async I/O Requests
Total Allowed Async I/O Requests	measurement	Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted.	Total Allowed Async I/O Requests
Total Allowed Async I/O Requests per Minute	measurement	Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted.	Total Allowed Async I/O Requests
Total Rejected Async I/O Requests	measurement	Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup).	Total Rejected Async I/O Requests
Total Rejected Async I/O Requests per Minute	measurement	Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup).	Total Rejected Async I/O Requests
Current Blocked Async I/O Requests	measurement	Shows current requests that are temporarily blocked due to bandwidth throttling settings.	Current Blocked Async I/O Requests
Measured Async I/O Bandwidth Usage	measurement	Shows the measured bandwidth of asynchronous I/O averaged over a minute.	Measured Async I/O Bandwidth Usage
HTTP Response Time	calltime	the minimum, maximum, and average response times for HTTP requests serviced by this virtual host	ResponseTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.3. Postgres - Server

Overview

Table 2.26. Overview
Description:	PostgreSQL Server
Singleton:	no
Plugin:	Postgres

Child Resource Types

Section 2.3.1, “Postgres - Database Service”
Section 2.3.2, “Postgres - User Service”

Autodiscovery Process Scans

Table 2.27. Metrics
Name	Query
unix	process\|basename\|match=^(postgres\|postmaster)$,process\|basename\|nomatch\|parent=^(postgres\|postmaster)$
windows	process\|basename\|match=^(?i)(postgres\|postmaster)\.exe$,process\|basename\|nomatch\|parent=^(?i)(postgres\|postmaster)\.exe$

Connection Properties

Table 2.28.
Name	Description	Required	Internal Name
listen host	the hostname or IP address that the database is listening on	yes	host
listen port	the TCP port that the database is listening on	yes	port
database name	the name of the database to connect to	yes	db
JDBC driver class	the fully-qualified classname of the JDBC driver class	no	driverClass
role name	the database role to connect as	yes	principal
role password	the password for the database role being used to connect	yes	credentials
PGDATA directory	the absolute path to the directory containing the cluster configuration files postgresql.conf, pg_hba.conf, and pg_ident.conf	yes	pgdataDir
configuration file	the absolute path to the main cluster configuration file; default value is '{pgDataDir}/postgresql.conf', where [pgDataDir] is the value of the pgDataDir connection property	no	configFile

Note

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

Metrics

Table 2.29. Metrics
Name	Type	Description	Internal Name
User Time	measurement	The aggregate amount of CPU user time spent by all postgres processes	Process.aggregateCpu.user
User Time per Minute	measurement	The aggregate amount of CPU user time spent by all postgres processes	Process.aggregateCpu.user
Kernel Time	measurement	The aggregate amount of CPU kernel time spent by all postgres processes	Process.aggregateCpu.sys
Kernel Time per Minute	measurement	The aggregate amount of CPU kernel time spent by all postgres processes	Process.aggregateCpu.sys
CPU Percentage	measurement	The percentage of CPU currently being used by all postgres processes	Process.aggregateCpu.percent
Physical Memory	measurement	The aggregate amount of resident memory used by all postgres processes	Process.aggregateMemory.resident
Virtual Memory	measurement	The aggregate amount of virtual memory used by all postgres processes	Process.aggregateMemory.size
Open File Descriptors	measurement	The aggregate number of file descriptors open by all postgres processes	Process.aggregateFileDescriptor.total
Active Backends	measurement	Number of currently active backends (user connections)	Database.backends
Start time	trait	Start time of the PostgreSQL database server	Database.startTime
Add Missing From	trait	Automatically adds missing table references to FROM clauses	Runtime.add_missing_from
Allow System Table Mods	trait	Allows modifications of the structure of system tables	Runtime.allow_system_table_mods
Archive Command	trait	WAL archiving command	Runtime.archive_command
Archive Timeout	trait	Forces a switch to the next xlog file if a new file has not been started within the specified amount of time	Runtime.archive_timeout
Array Nulls	trait	Enable input of NULL elements in arrays.	Runtime.array_nulls
Authentication Timeout	trait	The maximum allowed time to complete client authentication	Runtime.authentication_timeout
Autovacuum	trait	Starts the autovacuum subprocess.	Runtime.autovacuum
Autovacuum Analyze Scale Factor	trait	Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples.	Runtime.autovacuum_analyze_scale_factor
Autovacuum Analyze Threshold	trait	Minimum number of tuple inserts, updates or deletes prior to analyze.	Runtime.autovacuum_analyze_threshold
Autovacuum Freeze Max Age	trait	Age (in transactions) at which to autovacuum a table to prevent transaction ID wraparound.	Runtime.autovacuum_freeze_max_age
Autovacuum Naptime	trait	Amount of time to sleep between autovacuum runs	Runtime.autovacuum_naptime
Autovacuum Vacuum Cost Delay	trait	Vacuum cost delay for autovacuum	Runtime.autovacuum_vacuum_cost_delay
Autovacuum Vacuum Cost Limit	trait	Vacuum cost amount available before napping, for autovacuum.	Runtime.autovacuum_vacuum_cost_limit
Autovacuum Vacuum Scale Factor	trait	Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.	Runtime.autovacuum_vacuum_scale_factor
Autovacuum Vacuum Threshold	trait	Minimum number of tuple updates or deletes prior to vacuum.	Runtime.autovacuum_vacuum_threshold
Backslash Quote	trait	Whether quotes are allowed in string literals	Runtime.backslash_quote
Bgwriter All Maxpages	trait	Background writer maximum number of all pages to flush per round	Runtime.bgwriter_all_maxpages
Bgwriter All Percent	trait	Background writer percentage of all buffers to flush per round	Runtime.bgwriter_all_percent
Bgwriter Delay	trait	Background writer sleep time between rounds; default unit is milliseconds	Runtime.bgwriter_delay
Bgwriter Lru Maxpages	trait	Background writer maximum number of LRU pages to flush per round	Runtime.bgwriter_lru_maxpages
Bgwriter Lru Percent	trait	Background writer percentage of LRU buffers to flush per round	Runtime.bgwriter_lru_percent
Block Size	trait	Shows size of a disk block; determined by the value of BLCKSZ when building the server; default unit is bytes	Runtime.block_size
Bonjour Name	trait	The Bonjour broadcast service name	Runtime.bonjour_name
Check Function Bodies	trait	Check function bodies during CREATE FUNCTION.	Runtime.check_function_bodies
Checkpoint Segments	trait	The maximum distance (in log segments) between automatic WAL checkpoints.	Runtime.checkpoint_segments
Checkpoint Timeout	trait	The maximum amount of time between automatic WAL checkpoints; default unit is seconds	Runtime.checkpoint_timeout
Checkpoint Warning	trait	Logs if filling of checkpoint segments happens more frequently than this amount of time; default unit is seconds	Runtime.checkpoint_warning
Client Encoding	trait	The client's character set encoding.	Runtime.client_encoding
Client Min Messages	trait	The message levels that are sent to the client.	Runtime.client_min_messages
Commit Delay	trait	The delay in between transaction commit and flushing WAL to disk; default unit is microseconds	Runtime.commit_delay
Commit Siblings	trait	The minimum concurrent open transactions before performing commit_delay.	Runtime.commit_siblings
Config File	trait	The server's main configuration file.	Runtime.config_file
Constraint Exclusion	trait	Enables the planner to use constraints to optimize queries.	Runtime.constraint_exclusion
Cpu Index Tuple Cost	trait	The planner's estimate of the cost of processing each index entry during an index scan; measured on the same scale as the seq_page_cost configuration parameter	Runtime.cpu_index_tuple_cost
Cpu Operator Cost	trait	The planner's estimate of the cost of processing each operator or function call; measured on the same scale as the seq_page_cost configuration parameter	Runtime.cpu_operator_cost
Cpu Tuple Cost	trait	The planner's estimate of the cost of processing each tuple (row); measured on the same scale as the seq_page_cost configuration parameter	Runtime.cpu_tuple_cost
Custom Variable Classes	trait	The list of known custom variable classes	Runtime.custom_variable_classes
Data Directory	trait	The server's data directory.	Runtime.data_directory
DateStyle	trait	The display format for date and time values.	Runtime.DateStyle
Db User Namespace	trait	Enables per-database user names.	Runtime.db_user_namespace
Deadlock Timeout	trait	The amount of time to wait on lock before checking for a deadlock; default unit is milliseconds	Runtime.deadlock_timeout
Debug Assertions	trait	Turns on various assertion checks.	Runtime.debug_assertions
Debug Pretty Print	trait	Indents parse and plan tree displays.	Runtime.debug_pretty_print
Debug Print Parse	trait	Prints the parse tree to the server log.	Runtime.debug_print_parse
Debug Print Plan	trait	Prints the execution plan to server log.	Runtime.debug_print_plan
Debug Print Rewritten	trait	Prints the parse tree after rewriting to server log.	Runtime.debug_print_rewritten
Default Statistics Target	trait	The default statistics target; range 1-1000.	Runtime.default_statistics_target
Default Tablespace	trait	The default tablespace to create tables and indexes in.	Runtime.default_tablespace
Default Transaction Isolation	trait	The transaction isolation level of each new transaction.	Runtime.default_transaction_isolation
Default Transaction Read Only	trait	The default read-only status of new transactions.	Runtime.default_transaction_read_only
Default With Oids	trait	Create new tables with OIDs by default.	Runtime.default_with_oids
Dynamic Library Path	trait	The path for dynamically loadable modules.	Runtime.dynamic_library_path
Effective Cache Size	trait	The planner's assumption about size of the disk cache; the unit is disk pages, which are normally 8KB each	Runtime.effective_cache_size
Enable Bitmapscan	trait	Enables the planner's use of bitmap-scan plans.	Runtime.enable_bitmapscan
Enable Hashagg	trait	Enables the planner's use of hashed aggregation plans.	Runtime.enable_hashagg
Enable Hashjoin	trait	Enables the planner's use of hash join plans.	Runtime.enable_hashjoin
Enable Indexscan	trait	Enables the planner's use of index-scan plans.	Runtime.enable_indexscan
Enable Mergejoin	trait	Enables the planner's use of merge join plans.	Runtime.enable_mergejoin
Enable Nestloop	trait	Enables the planner's use of nested-loop join plans.	Runtime.enable_nestloop
Enable Seqscan	trait	Enables the planner's use of sequential-scan plans.	Runtime.enable_seqscan
Enable Sort	trait	Enables the planner's use of explicit sort steps.	Runtime.enable_sort
Enable Tidscan	trait	Enables the planner's use of TID scan plans.	Runtime.enable_tidscan
Escape String Warning	trait	Warn about backslash escapes in ordinary string literals.	Runtime.escape_string_warning
Explain Pretty Print	trait	Uses the indented output format for EXPLAIN VERBOSE.	Runtime.explain_pretty_print
External Pid File	trait	Writes the postmaster PID to the specified file.	Runtime.external_pid_file
Extra Float Digits	trait	The number of extra digits displayed for floating-point values.	Runtime.extra_float_digits
From Collapse Limit	trait	The FROM-list size beyond which subqueries are not collapsed	Runtime.from_collapse_limit
Fsync	trait	Forces synchronization of updates to disk.	Runtime.fsync
Full Page Writes	trait	Writes full pages to WAL when first modified after a checkpoint.	Runtime.full_page_writes
Geqo	trait	Enables genetic query optimization	Runtime.geqo
Geqo Effort	trait	GEQO: effort is used to set the default for other GEQO parameters; range 1-10	Runtime.geqo_effort
Geqo Generations	trait	GEQO: number of iterations of the algorithm; default selected based on effort.	Runtime.geqo_generations
Geqo Pool Size	trait	GEQO: number of individuals in the population; default selected based on effort.	Runtime.geqo_pool_size
Geqo Selection Bias	trait	GEQO: selective pressure within the population.	Runtime.geqo_selection_bias
Geqo Threshold	trait	The threshold of FROM items beyond which GEQO is used.	Runtime.geqo_threshold
Gin Fuzzy Search Limit	trait	The maximum allowed result for exact search by GIN.	Runtime.gin_fuzzy_search_limit
Hba File	trait	The server's hba [configuration file]	Runtime.hba_file
Ident File	trait	The server's ident [configuration file]	Runtime.ident_file
Ignore System Indexes	trait	Disables reading from system indexes.	Runtime.ignore_system_indexes
Integer Datetimes	trait	Datetimes are integer based.	Runtime.integer_datetimes
Join Collapse Limit	trait	The FROM-list size beyond which JOIN constructs are not flattened	Runtime.join_collapse_limit
Krb Caseins Users	trait	Whether Kerberos user names should be treated as case-insensitive.	Runtime.krb_caseins_users
Krb Server Hostname	trait	The hostname of the Kerberos server.	Runtime.krb_server_hostname
Krb Server Keyfile	trait	The location of the Kerberos server key file.	Runtime.krb_server_keyfile
Krb Srvname	trait	The name of the Kerberos service.	Runtime.krb_srvname
Lc Collate	trait	Shows the collation order locale.	Runtime.lc_collate
Lc Ctype	trait	Shows the character classification and case conversion locale.	Runtime.lc_ctype
Lc Messages	trait	The language in which messages are displayed.	Runtime.lc_messages
Lc Monetary	trait	The locale for formatting monetary amounts.	Runtime.lc_monetary
Lc Numeric	trait	The locale for formatting numbers.	Runtime.lc_numeric
Lc Time	trait	The locale for formatting date and time values.	Runtime.lc_time
Listen Addresses	trait	The host name or IP address(es) to listen to.	Runtime.listen_addresses
Local Preload Libraries	trait	Lists shared libraries to preload into each backend.	Runtime.local_preload_libraries
Log Connections	trait	Logs each successful connection.	Runtime.log_connections
Log Destination	trait	The destination for server log output.	Runtime.log_destination
Log Directory	trait	The destination directory for log files.	Runtime.log_directory
Log Disconnections	trait	Logs end of a session, including duration.	Runtime.log_disconnections
Log Duration	trait	Logs the duration of each completed SQL statement.	Runtime.log_duration
Log Error Verbosity	trait	The verbosity of logged messages.	Runtime.log_error_verbosity
Log Executor Stats	trait	Writes executor performance statistics to the server log.	Runtime.log_executor_stats
Log Filename	trait	The file name pattern for log files.	Runtime.log_filename
Log Hostname	trait	Logs the host name in the connection logs.	Runtime.log_hostname
Log Line Prefix	trait	Controls information prefixed to each log line	Runtime.log_line_prefix
Log Min Duration Statement	trait	The minimum execution time (in milliseconds) above which statements will be logged.	Runtime.log_min_duration_statement
Log Min Error Statement	trait	Causes all statements generating error at or above this level to be logged.	Runtime.log_min_error_statement
Log Min Messages	trait	The message levels that are logged.	Runtime.log_min_messages
Log Parser Stats	trait	Writes parser performance statistics to the server log.	Runtime.log_parser_stats
Log Planner Stats	trait	Writes planner performance statistics to the server log.	Runtime.log_planner_stats
Log Rotation Age	trait	Automatic log file rotation will occur after this amount of time; default unit is minutes	Runtime.log_rotation_age
Log Rotation Size	trait	Automatic log file rotation will occur when the file reaches this size; default unit is kilobytes	Runtime.log_rotation_size
Log Statement	trait	The type of statements logged.	Runtime.log_statement
Log Statement Stats	trait	Writes cumulative performance statistics to the server log.	Runtime.log_statement_stats
Log Truncate On Rotation	trait	Truncate existing log files of same name during log rotation.	Runtime.log_truncate_on_rotation
Maintenance Work Mem	trait	The maximum memory to be used for maintenance operations.	Runtime.maintenance_work_mem
Max Connections	trait	The maximum number of concurrent connections.	Runtime.max_connections
Max Files Per Process	trait	The maximum number of simultaneously open files for each server process.	Runtime.max_files_per_process
Max Fsm Pages	trait	The maximum number of disk pages for which free space is tracked.	Runtime.max_fsm_pages
Max Fsm Relations	trait	The maximum number of tables and indexes for which free space is tracked.	Runtime.max_fsm_relations
Max Function Args	trait	Shows the maximum number of function arguments.	Runtime.max_function_args
Max Identifier Length	trait	Shows the maximum identifier length	Runtime.max_identifier_length
Max Index Keys	trait	Shows the maximum number of index keys.	Runtime.max_index_keys
Max Locks Per Transaction	trait	The maximum number of locks per transaction.	Runtime.max_locks_per_transaction
Max Prepared Transactions	trait	The maximum number of simultaneously prepared transactions.	Runtime.max_prepared_transactions
Max Stack Depth	trait	The maximum size of the server's execution stack; default unit is kilobytes	Runtime.max_stack_depth
Password Encryption	trait	Encrypt passwords.	Runtime.password_encryption
Port	trait	The TCP port the server listens on	Runtime.port
Post Auth Delay	trait	Waits the specified amount of time on connection startup after authentication; default unit is seconds	Runtime.post_auth_delay
Pre Auth Delay	trait	Waits the specified amount of time on connection startup before authentication; default unit is seconds	Runtime.pre_auth_delay
Random Page Cost	trait	The planner's estimate of the cost of a nonsequentially fetched disk page; measured on the same scale as the seq_page_cost configuration parameter	Runtime.random_page_cost
Redirect Stderr	trait	Start a subprocess to capture stderr output into log files	Runtime.redirect_stderr
Regex Flavor	trait	The regular expression flavor.	Runtime.regex_flavor
Search Path	trait	The schema search order for names that are not schema-qualified.	Runtime.search_path
Seq Page Cost	trait	The planner's estimate of the cost of a sequentially fetched disk page; measured on an arbitrary scale.	Runtime.seq_page_cost
Server Encoding	trait	The server (database) character set encoding.	Runtime.server_encoding
Server Version	trait	Shows the PostgreSQL version.	Runtime.server_version
Server Version Num	trait	Shows the PostgreSQL version as an integer (e.g. 80204 translates to 8.2.4).	Runtime.server_version_num
Shared Buffers	trait	The amount of memory for the shared memory buffers used by the server	Runtime.shared_buffers
Shared Preload Libraries	trait	Lists shared libraries to preload into server.	Runtime.shared_preload_libraries
Silent Mode	trait	Runs the server silently.	Runtime.silent_mode
Sql Inheritance	trait	Causes subtables to be included by default in various commands.	Runtime.sql_inheritance
Ssl	trait	Enables SSL connections.	Runtime.ssl
Standard Conforming Strings	trait	'...' strings treat backslashes literally.	Runtime.standard_conforming_strings
Statement Timeout	trait	The maximum allowed duration of any statement; default unit is milliseconds	Runtime.statement_timeout
Stats Block Level	trait	Collects block-level statistics on database activity.	Runtime.stats_block_level
Stats Command String	trait	Collects information about executing commands.	Runtime.stats_command_string
Stats Reset On Server Start	trait	Zeroes collected statistics on server restart.	Runtime.stats_reset_on_server_start
Stats Row Level	trait	Collects row-level statistics on database activity.	Runtime.stats_row_level
Stats Start Collector	trait	Starts the server statistics-collection subprocess.	Runtime.stats_start_collector
Superuser Reserved Connections	trait	The number of connection slots reserved for superusers	Runtime.superuser_reserved_connections
Tcp Keepalives Count	trait	Maximum number of TCP keepalive retransmits; '0' selects the system default	Runtime.tcp_keepalives_count
Tcp Keepalives Idle	trait	Amount of time between issuing TCP keepalives; '0' selects the system default; default unit is seconds	Runtime.tcp_keepalives_idle
Tcp Keepalives Interval	trait	Amount of time between TCP keepalive retransmits; '0' selects the system default; default unit is seconds	Runtime.tcp_keepalives_interval
Temp Buffers	trait	The maximum number of temporary buffers used by each session.	Runtime.temp_buffers
TimeZone	trait	The time zone for displaying and interpreting time stamps.	Runtime.TimeZone
Timezone Abbreviations	trait	Selects a file of time zone abbreviations	Runtime.timezone_abbreviations
Trace Notify	trait	Generates debugging output for LISTEN and NOTIFY.	Runtime.trace_notify
Trace Sort	trait	Emit information about resource usage in sorting.	Runtime.trace_sort
Transaction Isolation	trait	The current transaction's isolation level.	Runtime.transaction_isolation
Transaction Read Only	trait	The current transaction's read-only status.	Runtime.transaction_read_only
Transform Null Equals	trait	Treats expr=NULL as expr IS NULL	Runtime.transform_null_equals
Unix Socket Directory	trait	The directory where the Unix-domain socket will be created	Runtime.unix_socket_directory
Unix Socket Group	trait	The owning group of the Unix-domain socket	Runtime.unix_socket_group
Unix Socket Permissions	trait	The access permissions of the Unix-domain socket	Runtime.unix_socket_permissions
Update Process Title	trait	Updates the process title to show the active SQL command.	Runtime.update_process_title
Vacuum Cost Delay	trait	Vacuum cost delay; default unit is milliseconds; range 0-1000	Runtime.vacuum_cost_delay
Vacuum Cost Limit	trait	Vacuum cost (in credits) amount available before napping.	Runtime.vacuum_cost_limit
Vacuum Cost Page Dirty	trait	Vacuum cost (in credits) for a page dirtied by vacuum; range 0-10000	Runtime.vacuum_cost_page_dirty
Vacuum Cost Page Hit	trait	Vacuum cost (in credits) for a page found in the buffer cache; range 0-10000	Runtime.vacuum_cost_page_hit
Vacuum Cost Page Miss	trait	Vacuum cost (in credits) for a page not found in the buffer cache; range 0-10000	Runtime.vacuum_cost_page_miss
Vacuum Freeze Min Age	trait	Minimum age (in transactions) at which VACUUM should freeze a table row.	Runtime.vacuum_freeze_min_age
Wal Buffers	trait	The number of disk-page buffers in shared memory for WAL	Runtime.wal_buffers
Wal Sync Method	trait	Selects the method used for forcing WAL updates out to disk.	Runtime.wal_sync_method
Work Mem	trait	The maximum memory to be used for query workspaces; default unit is kilobytes	Runtime.work_mem
Zero Damaged Pages	trait	Continues processing past damaged page headers.	Runtime.zero_damaged_pages

Note

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

Configuration Properties

Table 2.30.
Name	Description	Required	Internal Name
Port	Sets the TCP port the server listens on; default value is '5432'.	no	port
Max_connections	Sets the maximum number of concurrent connections; default value is '100'.	no	max_connections
Shared_buffers	Sets the number of the shared memory buffers used by the server; default value is typically '1000'.	no	shared_buffers
Max_fsm_pages	Maximum FSM Pages, must be a minimum of max_fsm_relations*16, 6 bytes each)	no	max_fsm_pages
Log_destination	Available options depend on operating system; default value is 'stderr'	no	log_destination
Redirect_stderr	Enable capturing of stderr into log files; enabled by default	no	redirect_stderr
Stats_start_collector	needed for block or row stats; enabled by default	no	stats_start_collector
Stats_block_level	Enables the collection of block-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default	no	stats_block_level
Stats_row_level	Enables the collection of row-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default	no	stats_row_level
Autovacuum	Enable autovacuum subprocess? (requires stats_start_collector and stats_row_level to also be on); enabled by default	no	autovacuum

Note

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

Operations

Table 2.31. Metrics
Name	Description
List Process Statistics	List statistics about the currently executing postgres backends. state column result is only available with Postgres 9.2+

Package Types

none

2.3.1. Postgres - Database Service

Overview

Table 2.32. Overview
Description:
Singleton:	no
Plugin:	Postgres

Child Resource Types

Section 2.3.1.1, “Postgres - Table Service”
Section 2.3.1.2, “Postgres - Query Service”

Connection Properties

Table 2.33.
Name	Description	Required	Internal Name
Database Name		yes	databaseName

Note

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

Metrics

Table 2.34. Metrics
Name	Type	Description	Internal Name
Backends	measurement	Number of active server processes for database	numbackends
Transactions Committed	measurement	Transactions committed in database	xact_commit
Transactions Committed per Minute	measurement	Transactions committed in database	xact_commit
Transactions Rolled Back	measurement	Transactions rolled back in database	xact_rollback
Transactions Rolled Back per Minute	measurement	Transactions rolled back in database	xact_rollback
Blocks Read	measurement	Number of disk block fetch requests for database	blks_read
Blocks Read per Minute	measurement	Number of disk block fetch requests for database	blks_read
Blocks Hit	measurement	Number of disk block fetch requests found in cache for database	blks_hit
Blocks Hit per Minute	measurement	Number of disk block fetch requests found in cache for database	blks_hit
Size	measurement	Disk space used by the database	size

Note

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

Configuration Properties

none

Operations

Table 2.35. Metrics
Name	Description
Reset Statistics	Resets the statistics in this database
Invoke Sql	Execute arbitrary SQL
Remove orphan large objects	Removes orphaned large objects from pg_largeobject

Package Types

none

2.3.1.1. Postgres - Table Service

Overview

Table 2.36. Overview
Description:	Database table
Singleton:	no
Plugin:	Postgres

Child Resource Types

none

Connection Properties

Table 2.37.
Name	Description	Required	Internal Name
Schema Name		yes	schemaName
Table Name		yes	tableName

Note

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

Metrics

Table 2.38. Metrics
Name	Type	Description	Internal Name
Sequential Scans	measurement	Number of sequential scans done against this table (when an index scan was not possible)	seq_scan
Sequential Scans per Minute	measurement	Number of sequential scans done against this table (when an index scan was not possible)	seq_scan
Sequential Rows Read	measurement	Number of rows read by sequential scans	seq_tup_read
Sequential Rows Read per Minute	measurement	Number of rows read by sequential scans	seq_tup_read
Index Scans	measurement	Number of index scans done against this table	idx_scan
Index Scans per Minute	measurement	Number of index scans done against this table	idx_scan
Index Scan Rows Read	measurement	Number of index entries returned by index scans	idx_tup_fetch
Index Scan Rows Read per Minute	measurement	Number of index entries returned by index scans	idx_tup_fetch
Heap Blocks Read	measurement	The number of heap blocks read that were not a buffer cache hit	heap_blks_read
Heap Blocks Read per Minute	measurement	The number of heap blocks read that were not a buffer cache hit	heap_blks_read
Heap Blocks Hit	measurement	The number of heap block requests that were found in the buffer cache	heap_blks_hit
Heap Blocks Hit per Minute	measurement	The number of heap block requests that were found in the buffer cache	heap_blks_hit
Index Blocks Read	measurement	The number of index blocks fetched that were not a buffer cache hit	idx_blks_read
Index Blocks Read per Minute	measurement	The number of index blocks fetched that were not a buffer cache hit	idx_blks_read
Index Blocks Hit	measurement	The number of index block requests that were found in the buffer cache	idx_blks_hit
Index Blocks Hit per Minute	measurement	The number of index block requests that were found in the buffer cache	idx_blks_hit
Toast Blocks Reads	measurement	The number of toast blocks fetched that were not a buffer cache hit	toast_blks_read
Toast Blocks Reads per Minute	measurement	The number of toast blocks fetched that were not a buffer cache hit	toast_blks_read
Toast Blocks Hit	measurement	The number of toast block requests that were found in the buffer cache	toast_blks_hit
Toast Blocks Hit per Minute	measurement	The number of toast block requests that were found in the buffer cache	toast_blks_hit
Toast Index Blocks Read	measurement	The number of toast index blocks fetched that were not a buffer cache hit	tidx_blks_read
Toast Index Blocks Read per Minute	measurement	The number of toast index blocks fetched that were not a buffer cache hit	tidx_blks_read
Toast Index Blocks Hit	measurement	The number of toast index block requests that were found in the buffer cache	tidx_blks_hit
Toast Index Blocks Hit per Minute	measurement	The number of toast index block requests that were found in the buffer cache	tidx_blks_hit
Row Inserts	measurement	The number of rows ever inserted into this table	n_tup_ins
Row Inserts per Minute	measurement	The number of rows ever inserted into this table	n_tup_ins
Row Updates	measurement	The number of rows ever updated on this table	n_tup_upd
Row Updates per Minute	measurement	The number of rows ever updated on this table	n_tup_upd
Row Deletes	measurement	The number of rows ever deleted from this table	n_tup_del
Row Deletes per Minute	measurement	The number of rows ever deleted from this table	n_tup_del
Table Size	measurement	The size in bytes of the data in the table	table_size
Total Size	measurement	The size in bytes of the data and all associated indexes and toast tables	total_size
Rows	measurement	The count of rows in the table. Warning: This may be an expensive operation	rows
Approximate rows	measurement	The approximate count of rows in the table. This is basically the number of rows of the last ANALYZE of the table. This metric is not expensive.	rows_approx

Note

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

Configuration Properties

Table 2.39.
Name	Required	Internal Name
Schema Name	yes	schemaName
Table Name	yes	tableName
Columns	yes	columns

Note

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

Operations

Table 2.40. Metrics
Name	Description
Vacuum	Vacuum the table

Package Types

none

2.3.1.2. Postgres - Query Service

Overview

Table 2.41. Overview
Description:
Singleton:	no
Plugin:	Postgres

Child Resource Types

none

Connection Properties

Table 2.42.
Name	Description	Required	Internal Name
Table	The table to discover and to be queried on for metric data	yes	table
Name	Initial name of the resource when manually added. This is also part of the resource key - make this unique if you want two Query resources based on the same table.	no	name
Description	Initial description of resource when manually added	no	description
Metric Query	The query that will gather metric data. This must return two columns, a string column whose value is 'metricColumn' and then a numeric column whose value is the metric to be collected.	no	metricQuery

Note

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

Metrics

Table 2.43. Metrics
Name	Type	Description	Internal Name
Metric Value	measurement	The metric value for this Query. If Metric Query is not specified, this is not collected.	metricColumn

Note

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

Configuration Properties

none

Operations

none

Package Types

none

2.3.2. Postgres - User Service

Overview

Table 2.44. Overview
Description:	A User in the Postgres System
Singleton:	no
Plugin:	Postgres

Child Resource Types

none

Connection Properties

none

Metrics

Table 2.45. Metrics
Name	Type	Description	Internal Name
Total User Connections	measurement	The total number of user connections in the system, whether actively querying or idle	total
Active User Connections	measurement	The number of user connections in the system actively querying	active

Note

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

Configuration Properties

Table 2.46.
Name	Description	Required	Internal Name
Inherit Rights	Inherit rights from parent roles.	yes	inheritRights
Super User	Is a super user.	yes	superuser
Can Create Database Types	Implied for a super user.	yes	canCreateDatabaseObjects
Can Create Roles	Implied for a super user.	yes	canCreateRoles
Can Update System Catalogs Directly	Even a superuser cannot update system catalogs unless this property is true. False is implied for a non super user.	yes	canModifyCatalogDirectly
User connection limit		yes	connectionLimit
User		yes	user
Can Login		yes	canLogin
Password		yes	password

Note

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

Operations

none

Package Types

none

2.4. Abstract Database Plugin

Table 2.47. Basic Details
Internal Name:	Database
Description:	Abstract plugin supporting concrete database plugins
Version:	4.4.0

Top-Level Resource Types

This plugin does not define any Resource types. It it probably an "abstract plugin", that is, one that provides Resource components and/or discovery components that can be used by other plugins.

2.5. Script - Server

Overview

Table 2.48. Overview
Description:	A resource with a command line executable or script as its management interface
Singleton:	no
Plugin:	Script

Child Resource Types

none

Autodiscovery Process Scans

none

Connection Properties

Table 2.49.
Name	Description	Required	Internal Name
Executable	The full path to the command line executable or script	yes	executable
Working Directory	When the executable is invoked, this will be its working directory.	no	workingDirectory
Environment Variables	Environment variables that are set when executing the executable	no	environmentVariables
Availability Execute Check	If specified and true, the ability to successfully execute the executable can determine whether or not the managed resource is considered up and available. If you set this to true, you normally do not set the availability regex settings in order to allow availability to be determined based solely on the successful execution, regardless of the exit code or output. If this is false, setting one of the avail regex settings will override it as if it were true.	no	availabilityExecuteCheck
Availability Exit Code Regex	If specified, the executable must return an exit code that matches this regular expression if the managed resource is to be considered up and available	no	availabilityExitCodeRegex
Availability Output Regex	If specified, the executable must output text that matches this regular expression if the managed resource is to be considered up and available. Expression is evaluated by Pattern.find() so match actually means first match found in text. Pattern `OK` matches multiline text `Service status\n is OK`. By default ^$ represent start/end of output text. To match start/end of line add (?m). eg. `(?m)^ is OK$`. To match whole multi-line output use (?s), eg. `(?s)Service.*OK`.	no	availabilityOutputRegex
Availability Arguments	If the executable needs to be executed in order to determine availability, these are the arguments that will be passed to the executable. If you do not specify the regex settings and you set the execute check setting to false, the executable will not be executed and these arguments will not be used - in this case, availability will be determined by the mere existence of the executable file.	no	availabilityArguments
Version Arguments	The arguments to pass to the executable that will help determine the version of the managed resource	no	versionArguments
Version Regex	The regex that can pick out the version from the executable output. If the regex has a captured group, its matched content will be used as the version. If there is no captured group, the entire output will be used as the version.	no	versionRegex
Fixed Version	If specified, this will be the version of the managed resource - the executable will not be invoked to determine it.	no	fixedVersion
Description Arguments	The arguments to pass to the executable that will help determine the managed resource description. This can be arguments to enable verbose version output.	no	descriptionArguments
Description Regex	The regex that can pick out the description from the executable output. If the regex has a captured group, its matched content will be used as the description. If there is no captured group, the entire output will be used as the description.	no	descriptionRegex
Fixed Description	If specified, this will be the description of the managed resource - the executable will not be invoked to determine it.	no	fixedDescription
Enable Quoting of Arguments	In unquoted text: the escape character preserves the value of any following character In double-quoted text: the escape character escapes " and itself otherwise is both the escape character and the following character are left intact In single-quoted text: no escaping can occur	yes	quotingEnabled
Escape Character	The escape character to be used when parsing arguments. By default the escape character is backslash.	yes	escapeCharacter

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 2.50. Metrics
Name	Description
Execute	Executes the executable with a set of arguments and returns the output and exit code.

Package Types

none

Chapter 3. Enterprise Application Platform Resources

There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.

The JBoss resources here are included with JBoss ON by default through the EAP plug-in pack. Additional JBoss resources can be managed by JBoss ON by installing additional plug-in packs.

3.1. Red Hat JBoss Enterprise Application Platform 4.x (EAP 4) and JBoss Application Server 3.x/4.x Plugin

Table 3.1. Basic Details
Internal Name:	JBossAS
Description:	Supports management and monitoring of JBoss AS 3.x (3.2.3 and later) and 4.x, and of EAP/SOA-P 4.x
Version:	4.4.0

Top-Level Resource Types

Section 3.1.1, “JBossAS - Server”

3.1.1. JBossAS - Server

Overview

Table 3.2. Overview
Description:	JBoss Application Server
Singleton:	no
Plugin:	JBossAS

Note

h3. Binding to IP addresses When starting JBossAS instances that need to be monitored using remote JMX (i.e. JNP), it is necessary for the {{java.rmi.server.hostname}} System property to be set to the same value as the server's JNP address (which is set to the {{jboss.bind.address}} System property by default). Due to bugs in JBossAS (for more information please see [JBAS-4736|http://jira.jboss.com/jira/browse/JBAS-4736] and [JBAS-4955|http://jira.jboss.com/jira/browse/JBAS-4955]), {{java.rmi.server.hostname}} will default to {{127.0.0.1}}, unless JBossAS is started using {{-b}}, in which case {{java.rmi.server.hostname}} will default to the bind address specified as the argument to {{-b}}. Therefore, you must start your JBossAS instances by using either {{-b}}: {code} run -b 12.34.56.78 ... {code} or by explicitly specifying a value for {{java.rmi.server.hostname}} via {{-D}} or {{-P}}, e.g.: {code} run -Djboss.bind.address=12.34.56.78 -Djava.rmi.server.hostname=12.34.56.78 ... {code} Otherwise, you will not be able to manage the instance via JON. {note} Using {{-b}} is the recommended way to specify the bind address, since, in addition to setting {{jboss.bind.address}} and {{java.rmi.server.hostname}}, it will also set other JGroups-related System properties to the specified address. {note} h3. Monitoring of EJB 2.x EJBs The issue here is that JBossAS changed the way it creates the MBean names of the deployed EJBs from the JNDI names / EJB names (this happened around version 4.0.3.sp1). Basically the <jndi-name>, or <local-jndi-name> if <jndi-name> is not present, from jboss.xml is used. So the workaround is to set the <jndi-name> to the ejb-name in your application. As this probably breaks client code, you will want to setup a naming reference that restores the original hierarchy. For example, if you have in jboss.xml: {code} <session> <ejb-name>Ability</ejb-name> <local-jndi-name>flower.AbilityLocal</local-jndi-name> {code} You might change this to: {code} <session> <ejb-name>Ability</ejb-name> <local-jndi-name>Ability</local-jndi-name> {code} And then add an MBean flowsys-naming-alias-service.xml: {code} <mbean code="org.jboss.naming.NamingAlias" name=":service=naming-alias"> <attribute name="ToName">flower.AbilityLocal</attribute> <attribute name="FromName">Ability</attribute> </mbean> {code} After you have done this, go into the inventory of the respective beans, edit the configuration and then click OK. The naming alias ensures that clients of the Ability EJB can still find the bean in JNDI at the original location. Naming aliases appear in JNDIView (within JMX-Console) as LinkRef.

Child Resource Types

Section 3.1.1.1, “JBossAS - Embedded Tomcat Server”
Section 3.1.1.2, “JBossAS - Datasource Service”
Section 3.1.1.3, “JBossAS - ConnectionFactory Service”
Section 3.1.1.4, “JBossAS - JBossMQ Service”
Section 3.1.1.5, “JBossAS - JBossMessaging Service”
Section 3.1.1.6, “JBossAS - EJB3 Session Bean Service”
Section 3.1.1.7, “JBossAS - Stateless Session EJB Service”
Section 3.1.1.8, “JBossAS - Stateful Session EJB Service”
Section 3.1.1.9, “JBossAS - Entity EJB Service”
Section 3.1.1.10, “JBossAS - Message Driven EJB Service”
Section 3.1.1.11, “JBossAS - Enterprise Application (EAR) Service”
Section 3.1.1.12, “JBossAS - Web Application (WAR) Service”
Section 3.1.1.13, “JBossAS - EJB3 Entity Tree Cache Service”
Section 3.1.1.14, “JBossAS - Script Service”

Autodiscovery Process Scans

Table 3.3. Metrics
Name	Query
JBoss4	process\|basename\|match=^java.,arg\|org.jboss.Main\|match=.

Connection Properties

Table 3.4.
Name	Description	Required	Internal Name
Naming Provider URL	The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099).	yes	namingURL
Principal	The name of the principal (i.e. user) to authenticate.	no	principal
Credentials	The credentials (i.e. password) that should be used to authenticate the principal.	no	credentials
JBoss Home Directory	The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA).	yes	jbossHomeDir
Configuration Path	The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}.	yes	configurationPath
Configuration Set	The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}.	no	configurationSet
Script Prefix	A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set.	no	scriptPrefix
Start Script	The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows.	no	startScript
Shutdown Script	The path to the script used by the 'Shutdown' operation to shutdown this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows.	no	shutdownScript
Shutdown Method	The method used to execute the Shutdown operation; defaults to 'JMX MBean'.	no	shutdownMethod
Binding Address	The host or IP address used by all JBoss services as the binding address (e.g. 10.11.14.233); specify 0.0.0.0 to tell JBossAS to bind to all available network interfaces; defaults to '127.0.0.1'.	no	bindingAddress
JAVA_HOME Path	The absolute path to a JRE or JDK installation directory containing the JVM that should be used to start and shutdown the JBossAS instance; defaults to the home directory of the RHQ agent JRE.	no	javaHomePath
Start Wait Max	The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes.	no	startWaitMax
Stop Wait Max	The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes.	no	stopWaitMax
Log Event Sources		yes	logEventSources
Snapshot Config Enabled	If true, take a snapshot of the configuration	yes	snapshotConfigEnabled
Snapshot Config Directory	The directory containing the configuration files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path.	yes	snapshotConfigDirectory
Snapshot Config Regex	If defined, this regular expression must match a configuration file name if that file is to be captured in the snapshot. If not defined, all configuration files will be captured.	no	snapshotConfigRegex
Snapshot Config Recursive	If true, the snapshot will include files located in subdirectories under the config directory.	yes	snapshotConfigRecursive
Snapshot Log Enabled	If true, take a snapshot of the log files	yes	snapshotLogEnabled
Snapshot Log Directory	The directory containing the log files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path.	yes	snapshotLogDirectory
Snapshot Log Regex	If defined, this regular expression must match a log file name if that file is to be captured in the snapshot. If not defined, all log files will be captured.	no	snapshotLogRegex
Snapshot Log Recursive	If true, the snapshot will include files located in subdirectories under the log directory.	yes	snapshotLogRecursive
Snapshot Data Enabled	If true, take a snapshot of the data files	yes	snapshotDataEnabled
Snapshot Data Directory	The directory containing the data files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path.	yes	snapshotDataDirectory
Snapshot Data Regex	If defined, this regular expression must match a data file name if that file is to be captured in the snapshot. If not defined, all data files will be captured.	no	snapshotDataRegex
Snapshot Data Recursive	If true, the snapshot will include files located in subdirectories under the data directory.	yes	snapshotDataRecursive
Snapshot Additional Files List	Additional files to be included in the snapshot report	yes	snapshotAdditionalFilesList
Type	The type of the connection.	yes	type
Shutdown MBean Name	Name of the MBean to use when shutting down this server through JMX.	yes	shutdownMbeanName
Shutdown MBean Operation	Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied.	yes	shutdownMbeanOperation
JBoss AS JVM Name	The name of the JBoss AS JVM resource.	no	childJmxServerName

Note

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

Metrics

Table 3.5. Metrics
Name	Type	Description	Internal Name
Partition Name	trait	the name of the cluster partition this app server instance belongs to	partitionName
Version Name	trait	the code name for the this app server instance's major version (AS 3.2 = WonderLand, AS 4.0 = Zion, AS 4.2 = Trinity, EAP 4.x = EAP, SOA 4.x = SOA)	jboss.system:type=Server:VersionName
Build Date	trait	the date this app server was built	jboss.system:type=Server:BuildDate
Start Date	trait	the date and time this app server instance was started	jboss.system:type=Server:StartDate
Active Thread Count	measurement	The current number of active threads for this app server instance	jboss.system:type=ServerInfo:ActiveThreadCount
Active Thread Group Count	measurement	The current number of active thread groups for this app server instance	jboss.system:type=ServerInfo:ActiveThreadGroupCount
JVM Free Memory	measurement	An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes	jboss.system:type=ServerInfo:FreeMemory
JVM Max Memory	measurement	The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned	jboss.system:type=ServerInfo:MaxMemory
JVM Total Memory	measurement	The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes	jboss.system:type=ServerInfo:TotalMemory
Total Transactions	measurement	Total number of transactions since last restart	jboss:service=TransactionManager:TransactionCount
Total Transactions per Minute	measurement	Total number of transactions since last restart	jboss:service=TransactionManager:TransactionCount
Transactions Committed	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:CommitCount
Transactions Committed per Minute	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:CommitCount
Transactions Rolledback	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:RollbackCount
Transactions Rolledback per Minute	measurement	Number of transactions commited since last restart	jboss:service=TransactionManager:RollbackCount

Note

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

Configuration Properties

none

Operations

Table 3.6. Metrics
Name	Description
Start	Start this application server. The script used is specified in the Operations group of connection properties.
Shutdown	Shutdown this application server via script or JMX depending on the settings in the Operations and Advanced groups of connection properties.
Restart	Shutdown and then start this application server.

Package Types

Table 3.7. Package Types
Name	Category	Description
Cumulative Patch	Deployable	Automatically installable application server patches
Jar Library	Deployable	Library Jar files deployed in JBoss AS

3.1.1.1. JBossAS - Embedded Tomcat Server

Overview

Table 3.8. Overview
Description:	Tomcat Web Application Container embedded in a JBossAS Server
Singleton:	yes
Plugin:	JBossAS

Child Resource Types

Section 3.1.1.1.1, “JBossAS - Connector Service”
Section 3.1.1.1.2, “JBossAS - VHost Service”

Autodiscovery Process Scans

none

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.1.1. JBossAS - Connector Service

Overview

Table 3.9. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.10.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Port	Port this connector listens on.	yes	port
Address	Address this connector listens on.	yes	address
Scheme	The scheme of the protocol used by this connector (e.g. jk, ajp, http, https).	yes	schema
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate

Note

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

Metrics

Table 3.11. Metrics
Name	Type	Description	Internal Name
Maximum Request Time	measurement	Maximum time it took to process a request	jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:maxTime
Request count	measurement	Total number of requests processed since last restart.	jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount
Request count per Minute	measurement	Total number of requests processed since last restart.	jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount
Error count	measurement	Number of errors while processing since last restart.	jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount
Error count per Minute	measurement	Number of errors while processing since last restart.	jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount
Threads Active	measurement	Threads Active	jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadsBusy
Threads Allocated	measurement	Threads Allocated	jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadCount
Maximum Threads	trait	Maximum number of threads that can be allocated for the thread pool of this connector	jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:maxThreads

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.1.2. JBossAS - VHost Service

Overview

Table 3.12. Overview
Description:	A virtual host in the web container
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.13.
Name	Description	Required	Internal Name
Object Name		yes	objectName

Note

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

Metrics

Table 3.14. Metrics
Name	Type	Description	Internal Name
Aliases	trait	The aliases for this virtual host	jboss.web:type=Host,host=%name%:aliases

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.2. JBossAS - Datasource Service

Overview

Table 3.15. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.16.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this datasource	yes	name

Note

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

Metrics

Table 3.17. Metrics
Name	Type	Description	Internal Name
Total Connections	measurement	Total Number of Connections for the Connection Pool, both active and in-active.	ConnectionCount
Available Connections	measurement	Number of available connections in the connection pool in-active and waiting.	AvailableConnectionCount
Active Connections	measurement	Number of Connections currently supporting clients.	InUseConnectionCount
Connections Created	measurement	Number of Connections created since the Connection Pool was created.	ConnectionCreatedCount
Connections Created per Minute	measurement	Number of Connections created since the Connection Pool was created.	ConnectionCreatedCount
Connections Destroyed	measurement	Number of Connections destroyed since the Connection Pool was created.	ConnectionDestroyedCount
Connections Destroyed per Minute	measurement	Number of Connections destroyed since the Connection Pool was created.	ConnectionDestroyedCount

Note

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

Configuration Properties

Table 3.18.
Name	Description	Required	Internal Name
Type		yes	type
JNDI Name	The JNDI name under which the DataSource wrapper will be bound.	yes	jndi-name
Driver Class	The fully qualified name of the JDBC driver or datasource class. Not used for XA-Datasources	no	driver-class
Connection Url	The JDBC driver connection URL string. Needed for Tx and Non-Tx datasources	no	connection-url
User Name		no	user-name
Password		no	password
Min Pool Size		no	min-pool-size
Max Pool Size		no	max-pool-size
Transaction Isolation	The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database.	no	transaction-isolation
Blocking Timeout Millis	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. If nothing is specified the default of 30000 milliseconds is used.	no	blocking-timeout-millis
Idle Timeout Minutes	Indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool. If nothing is specified the default of 15 minutes is used.	no	idle-timeout-minutes
Prepared Statement Cache Size	The number of prepared statements per connection in an LRU cache.	no	prepared-statement-cache-size
Valid Connection Checker Class Name	An org.jboss.resource.adapter.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present.	no	valid-connection-checker-class-name
Use Java Context	Indicates if the JNDI name should be prefixed with java: which causes the DataSource to only be accessible from within the JBoss server vm. The default is Yes.	no	use-java-context
Security Domain	Indicates Subjects (from security domain) are used to distinguish connections in the pool. The content of the security domain is the name of the JAAS security manager that will handle authentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. Must be specified if either Container Based or Container and Application Based authentication types are specified.	no	security-domain
New Connection Sql	Specify an SQL statement to execute whenever a connection is added to the connection pool.	no	new-connection-sql
Exception Sorter Class Name	An org.jboss.resource.adapter.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred message.	no	exception-sorter-class-name
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.	no	check-valid-connection-sql
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/returned to the prepared statement cache. The default is Yes, but no warnings.	no	track-statements
Xa Datasource Class	The datasource class for XA connections.	no	xa-datasource-class
Connection Property		no	connection-property
No Tx Separate Pools	Whether to use separate pools for connections retrieved in a transaction and those retrieved outside a transaction. The default is Yes.	no	no-tx-separate-pools
Application Managed Security		no	application-managed-security
Security Domain and Application		no	security-domain-and-application
Track Connection By Tx	Whether the connection should be "locked" to the transaction, returning it to the pool at the end of the transaction. The default is No.	no	track-connection-by-tx
Is Same RM Override Value	Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false. The default is not to override the return value.	no	isSameRM-override-value

Note

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

Operations

Table 3.19. Metrics
Name	Description
Flush	Resets the connection pool for this datasource. Performs the following steps: 1) all idle connections are immediately closed, 2) any in use connections are closed when the application finishes with them, and 3) new connections are created.

Package Types

none

3.1.1.3. JBossAS - ConnectionFactory Service

Overview

Table 3.20. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.21.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this Connection Factory	yes	name

Note

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

Metrics

Table 3.22. Metrics
Name	Type	Description	Internal Name
Available Connection Count	measurement	Number of available connections.	AvailableConnectionCount
Connection Count	measurement	Connection Count	ConnectionCount
Connection Created Count	measurement	Connection Created Count	ConnectionCreatedCount
Connection Destroyed Count	measurement	Connection Destroyed Count	ConnectionDestroyedCount
In Use Connection Count	measurement	Mumber of connections currently in use.	InUseConnectionCount
Max Connections In Use Count	measurement	Maximum number of maximum connections that have been in use.	MaxConnectionsInUseCount
Max Size	measurement	Max Size	MaxSize
Min Size	measurement	Min Size	MinSize

Note

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

Configuration Properties

Table 3.23.
Name	Description	Required	Internal Name
Connection Factory Type	Connection Factory Type (Tx or no Tx)	yes	type
JNDI Name	The JNDI Name under which the DataSource wrapper will be bound.	yes	jndi-name
User Name	This element specifies the default username used when creating a new connection. The actual username may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject.	no	user-name
Password	This element specifies the default password used when creating a new connection. The actual password may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject.	no	password
Minimum Pool Size	Indicates the minimum number of connections the pool should hold.	no	min-pool-size
Maximum Pool Size	Indicates the maximum number of connections the pool should hold.	no	max-pool-size
Application Managed Security	Specifying this element indicates that connections in the pool should be distinguished by application code supplied parameters, such as from getConnection(user, pw). This requires that you set a security domain which will populate a security-domain-and-application tag. If it is missing this resource will not be created or saved.	no	application-managed-security
Security Domain/Security Domain and Application	Indicates Subjects from security domain are used to distinguish connections in this pool. If Application Managed Security is set to true, then this will create a security-domain tag. If it is set to false or unset, then this property will populate a security-domain-and-application tag.	no	security-domain
Adapter Display Name	used to identify the RAR deployment matching the display-name in the ra.xml	no	adapter-display-name
Depends	The depends element specifies the JMX ObjectName string of a service that the connection manager services depend on. The connection manager service will not be started until the dependent services have been started.	no	depends
Rar Name	This is the name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar.	yes	rar-name
Connection Definition	This is the connection factory interface class. It should match the connectionfactory-interface in the ra.xml file.	yes	connection-definition
Type Mappings	This element declares a default type mapping for this datasource. The type mapping should match a type-mapping/name element from standardjbosscmp-jdbc.xml.	no	type-mapping
Use Java Context	Indicates if the JNDI name should be prefixed with java:.	no	use-java-context
Transaction Type	Whether to use local or xa transactions. If nothing is specified, the default of local will be used.	no	transaction-type
No Tx Separate Pools	The presence of this element indicates that two connection pools are required to isolate connections used with JTA transaction from those used without a JTA transaction. The pools are lazily constructed on first use. Its use case is for Oracle (and possibly other vendors) XA implementations that don't like using an XA connection with and without a JTA transaction.	no	no-tx-separate-pools
Track Connection By Transaction	Whether the connection should be locked into the transaction.	no	track-connection-by-tx
isSameRM Override Value	Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRMXAResource returns true or false. The default is not to override the return value.	no	isSameRM-override-value
Use Strict Minimum	Whether on not to use strict minumum.	no	use-strict-min
Prefill	Prefill the Pool with Connection objects, or lazy load objects in the pool	no	prefill
Blocking Timeout in Milliseconds	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. If nothing is specified the default of 30000 milliseconds is used.	no	blocking-timeout-millis
Idle Timeout	Maximum time in minutes a connection can be idle before it is closed.	no	idle-timeout-minutes
XA Resource Timeout	Maximum time in minutes an XA Resource can be idle before it is removed.	no	xa-resource-timeout
New Connection SQL	Specify an SQL statement to execute whenever a connection is added to the connection pool.	no	new-connection-sql
Check Valid Connection SQL	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.	no	check-valid-connection-sql
Config Property	Configuration Properties	no	config-property

Note

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

Operations

none

Package Types

none

3.1.1.4. JBossAS - JBossMQ Service

Overview

Table 3.24. Overview
Description:	The JBossMQ subsystem
Singleton:	yes
Plugin:	JBossAS

Child Resource Types

Section 3.1.1.4.1, “JBossAS - JMQ JMS Queue Service”
Section 3.1.1.4.2, “JBossAS - JMQ JMS Topic Service”

Connection Properties

Table 3.25.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name		yes	name

Note

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

Metrics

Table 3.26. Metrics
Name	Type	Description	Internal Name
JMS Message Cache Hits	measurement	The number of cache hits to the JMS Message Cache	jboss.mq:service=MessageCache:CacheHits
JMS Message Cache Hits per Minute	measurement	The number of cache hits to the JMS Message Cache	jboss.mq:service=MessageCache:CacheHits
JMS Message Cache Misses	measurement	The number of cache misses to the JMS Message Cache	jboss.mq:service=MessageCache:CacheMisses
JMS Message Cache Misses per Minute	measurement	The number of cache misses to the JMS Message Cache	jboss.mq:service=MessageCache:CacheMisses
JMS Message Cache Current Memory Usage	measurement	The total memory currently in use by the JMS Message Cache	jboss.mq:service=MessageCache:CurrentMemoryUsage
JMS Message Cache High Memory Mark	measurement	The peak amount of memory the JMS Message Cache has actively used since server start	jboss.mq:service=MessageCache:HighMemoryMark
JMS Message Cache Max Memory Mark	measurement	The maximum amount of memory the JMS Message Cache is allowed to use	jboss.mq:service=MessageCache:MaxMemoryMark
JMS Message Cache Size	measurement	The number of messages currently in the JMS Message Cache	jboss.mq:service=MessageCache:TotalCacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.4.1. JBossAS - JMQ JMS Queue Service

Overview

Table 3.27. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.28.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this queue	yes	name

Note

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

Metrics

Table 3.29. Metrics
Name	Type	Description	Internal Name
Messages in Queue	measurement	The number of undelivered messages in the queue.	QueueDepth
Receivers Count	measurement	The number of ClientConsumers waiting for a message.	ReceiversCount
Scheduled Message Count	measurement	The number of messages waiting to be scheduled	ScheduledMessageCount
In Process Message Count	measurement	The number of messages received by clients but not acknowledged (from AS 4.0.5)	InProcessMessageCount

Note

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

Configuration Properties

Table 3.30.
Name	Description	Required	Internal Name
Destination Manager	The JMX object name of the destination manager configured for the server.	yes	DestinationManager
Security Manager	The JMX object name of the security manager that is being used to validate client requests.	no	SecurityManager
Expiry Destination	By default, JBossMQ silently removes expired JMS message from its destination. As of JBoss 4.0.4, expired messages can now be moved into a separate destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMQ destination.	no	ExpiryDestination
JNDI Name	The location in JNDI to which the queue object will be bound. If this is not set it will be bound under the queue context using the name of the queue. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples.	no	JNDIName
In Memory	Don't persist messages and avoid message softening when using the NullPersistenceManager	no	InMemory
Redelivery Limit	The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely)	no	RedeliveryLimit
Redelivery Delay	The length of time in milliseconds to wait before a message is redelivered after a nack	no	RedeliveryDelay
Message Counter History Day Limit	Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count.	no	MessageCounterHistoryDayLimit
Maximum Depth	The MaxDepth is an upper limit to the backlog of messages that can exist for a destination. If exceeded, attempts to add new messages will result in a org.jboss.mq.DestinationFullException. The MaxDepth can still be exceeded in a number of situations, e.g. when a message is placed back into the queue. Also transactions performing read committed processing, look at the current size of queue, ignoring any messages that may be added as a result of the current transaction or other transactions. This is because we don't want the transaction to fail during the commit phase when the message is physically added to the queue.	no	MaxDepth
Recovery Retries	Specifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3).	no	RecoveryRetries
Security Configurations	This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute.	yes	SecurityConf
Queue Name	Name of the queue to be used in the JMX object name.	yes	MBeanName
JNDI Binding	Binding path of this Queue in JNDI.	yes	JNDIBinding

Note

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

Operations

Table 3.31. Metrics
Name	Description
Remove All Messages	Clears all Messages in the Queue
Reset Message Counter	Clears the MessageCounter data for this Queue
Reset Message Counter History	Clears the MessageCounter history data for this Queue
List Messages by Selector	Lists the Messages in the Queue by Selector (if provided). Selector is not required.
List Scheduled Messages	Lists the Scheduled Messages by Selector (if provided). Selector is not required.
List In Process Messages	Lists the Messages in process by Selector (if provided). Selector is not required.

Package Types

none

3.1.1.4.2. JBossAS - JMQ JMS Topic Service

Overview

Table 3.32. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.33.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this topic	yes	name

Note

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

Metrics

Table 3.34. Metrics
Name	Type	Description	Internal Name
All Message Counter	measurement	Returns the total message count for all subscriptions.	AllMessageCount
Durable Message Count	measurement	Total number of messages for all durable subscriptions.	DurableMessageCount
Non-durable Message Count	measurement	Total number of messages for all non-durable subscriptions.	NonDurableMessageCount
All Subscription Count	measurement	Number of subscriptions waiting for a message.	AllSubscriptionsCount
Durable Subscription Count	measurement	Number of durable subscriptions waiting for a message.	DurableSubscriptionsCount
Non-durable Subscription Count	measurement	Number of non-durable subscriptions waiting for a message.	NonDurableSubscriptionsCount

Note

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

Configuration Properties

Table 3.35.
Name	Description	Required	Internal Name
Destination Manager	The JMX object name of the destination manager configured for the server.	yes	DestinationManager
Security Manager	The JMX object name of the security manager that is being used to validate client requests.	no	SecurityManager
Expiry Destination	By default, JBossMQ silently removes expired JMS message from its destination. As of JBoss 4.0.4, expired messages can now be moved into a separate destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMQ destination.	no	ExpiryDestination
JNDI Name	The location in JNDI to which the topic will be bound. If this is not set it will be bound under the topic context using the mbean name of the topic. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples.	no	JNDIName
In Memory	Don't persist messages and avoid message softening when using the NullPersistenceManager.	no	InMemory
Redelivery Limit	The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely).	no	RedeliveryLimit
Redelivery Delay	The length of time in milliseconds to wait before a message is redelivered after a nack.	no	RedeliveryDelay
Message Counter History Day Limit	Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count.	no	MessageCounterHistoryDayLimit
Maximum Depth	The MaxDepth is an upper limit to the backlog of messages that can exist for a destination. If exceeded, attempts to add new messages will result in a org.jboss.mq.DestinationFullException. The MaxDepth can still be exceeded in a number of situations, e.g. when a message is placed back into the queue. Also transactions performing read committed processing, look at the current size of queue, ignoring any messages that may be added as a result of the current transaction or other transactions. This is because we don't want the transaction to fail during the commit phase when the message is physically added to the queue.	no	MaxDepth
Recovery Retries	Specifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3).	no	RecoveryRetries
Security Configurations	This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute.	yes	SecurityConf
Topic Name	Name of the queue to be used as the JMX object name.	yes	MBeanName
JNDI Binding	Binding path of this Topic in JNDI.	yes	JNDIBinding

Note

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

Operations

Table 3.36. Metrics
Name	Description
Remove All Messages	Clears all Subscriptions
List All Subscriptions	Lists all the Subscriptions.
List Durable Subscriptions	Lists all the durable subscriptions.
List Non-durable Subscriptions	Lists all the non-durable subscriptions.
Reset Message Counter	Clears the message counter data for all topic subscriptions.
Reset Message Counter History	Clears the message counter history data for this topic.
List Messages by ID and Selector	List the messages for a subscription by ID and with an optional selector.
Get Non-durable Message Count	Gets the message count for non-durable messages by client ID and subscription ID.
List Non-durable Messages	Lists the non-durable messages by client ID, subscription ID, and an optional selector.
Get Durable Message Count	Gets the message count for durable messages by client ID and subscription ID.
List Durable Messages	Lists the durable messages by client ID, subscription ID, and an optional selector.
Get Non-durable Scheduled Message Count	Gets the message count for non-durable scheduled messages by client ID and subscription ID.
List Non-durable Scheduled Messages	Lists the non-durable scheduled messages by client ID, subscription ID, and an optional selector.
Get Durable Scheduled Message Count	Gets the message count for durable scheduled messages by client ID and subscription ID.
List Durable Scheduled Messages	Lists the durable scheduled messages by client ID, subscription ID, and an optional selector.
Get Non-durable In-process Message Count	Gets the message count for non-durable in-process messages by client Id and subscription Id
List Non-durable In-process Messages	Lists the non-durable in-process messages by client ID, subscription ID, and an optional selector.
Get Durable In-process Message Count	Gets the message count for durable in-process messages by client ID and subscription Id
List Durable In-process Messages	Lists the durable in-process messages by client ID, subscription ID, and an optional selector.

Package Types

none

3.1.1.5. JBossAS - JBossMessaging Service

Overview

Table 3.37. Overview
Description:	The JBoss Messaging subsystem
Singleton:	yes
Plugin:	JBossAS

Child Resource Types

Section 3.1.1.5.1, “JBossAS - JBM JMS Queue Service”
Section 3.1.1.5.2, “JBossAS - JBM JMS Topic Service”

Connection Properties

Table 3.38.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name		yes	name

Note

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

Metrics

Table 3.39. Metrics
Name	Type	Description	Internal Name
Version of the Provider	trait	The version of JBoss Messaging in use	jboss.messaging:service=ServerPeer:ProviderVersion

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.5.1. JBossAS - JBM JMS Queue Service

Overview

Table 3.40. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.41.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this queue	yes	name

Note

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

Metrics

Table 3.42. Metrics
Name	Type	Description	Internal Name
Messages in Queue	measurement	The number of messages in the queue.	MessageCount
Consumer Count	measurement	The number of ClientConsumers waiting for a message.	ConsumerCount
Scheduled Message Count	measurement	The number of scheduled messages in the Queue	ScheduledMessageCount
Created programmatically	trait	Was this Queue created dynamically	CreatedProgrammatically
Delivering Count	measurement	The number of messages currently being delivered	DeliveringCount

Note

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

Configuration Properties

Table 3.43.
Name	Description	Required	Internal Name
Server Peer	The ObjectName of the server peer this destination was deployed on.	yes	ServerPeer
Dead Letter Queue	The DLQ for this queue, overrides the default DLQ on the server peer.	no	DLQ
Expiry Queue	By default, JBoss Messaging silently removes expired JMS message from its destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMessaging destination.	no	ExpiryQueue
JNDI Name	The location in JNDI to which the queue object will be bound. If this is not set it will be bound under the queue context using the name of the queue. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples.	no	JNDIName
Clustered	Is this a clustered destination?	no	Clustered
Max Delivery Attempts	The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely)	no	MaxDeliveryAttempts
Redelivery Delay	The length of time in milliseconds to wait before a message is redelivered after a nack	no	RedeliveryDelay
Message Counter History Day Limit	Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count.	no	MessageCounterHistoryDayLimit
Maximum Queue Size	The maximum number of messages this queue can hold before they are dropped (-1 = infinite)	no	MaxSize
Full Size	The in-memory message limit, can only be set when queue is stopped	no	FullSize
Page Size	The paging size, can only be set when queue is stopped	no	PageSize
Down Cache Size	The write-cache size, can only be set when queue is stopped	no	DownCacheSize
Security Configurations	This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute.	yes	SecurityConfig
Queue Name	Name of the queue to be used in the JMX object name.	yes	MBeanName
JNDI Binding	Binding path of this Queue in JNDI.	yes	JNDIBinding

Note

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

Operations

Table 3.44. Metrics
Name	Description
Remove All Messages	Clears all Messages in the Queue
Reset Message Counter	Clears the MessageCounter data for this Queue
Reset Message Counter History	Clears the MessageCounter history data for this Queue
List Messages by Selector	Lists the Messages in the Queue by Selector (if provided). Selector is not required.
List All Messages	Lists All Messages by Selector (if provided). Selector is not required.
List Durable Messages	Lists Durable Messages by Selector (if provided). Selector is not required.
List Non-Durable Messages	Lists Non-Durable Messages by Selector (if provided). Selector is not required.

Package Types

none

3.1.1.5.2. JBossAS - JBM JMS Topic Service

Overview

Table 3.45. Overview
Description:
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.46.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this topic	yes	name

Note

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

Metrics

Table 3.47. Metrics
Name	Type	Description	Internal Name
All Message Counter	measurement	Returns the total message count for all subscriptions.	AllMessageCount
Durable Message Count	measurement	Total number of messages for all durable subscriptions.	DurableMessageCount
Non-durable Message Count	measurement	Total number of messages for all non-durable subscriptions.	NonDurableMessageCount
All Subscription Count	measurement	Number of subscriptions waiting for a message.	AllSubscriptionsCount
Durable Subscription Count	measurement	Number of durable subscriptions waiting for a message.	DurableSubscriptionsCount
Non-durable Subscription Count	measurement	Number of non-durable subscriptions waiting for a message.	NonDurableSubscriptionsCount
Created programmatically	trait	Was this Topic created dynamically	CreatedProgrammatically

Note

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

Configuration Properties

Table 3.48.
Name	Description	Required	Internal Name
Server Peer	The ObjectName of the server peer this destination was deployed on.	yes	ServerPeer
Dead Letter Queue	The DLQ for this queue, overrides the default DLQ on the server peer.	no	DLQ
Expiry Queue	By default, JBoss Messaging silently removes expired JMS message from its destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMessaging destination.	no	ExpiryQueue
JNDI Name	The location in JNDI to which the topic will be bound. If this is not set it will be bound under the topic context using the mbean name of the topic. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples.	no	JNDIName
Clustered	Is this a clustered destination?	no	Clustered
Max Delivery Attempts	The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely)	no	MaxDeliveryAttempts
Redelivery Delay	The length of time in milliseconds to wait before a message is redelivered after a NACK	no	RedeliveryDelay
Message Counter History Day Limit	Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count.	no	MessageCounterHistoryDayLimit
Maximum Queue Size	The maximum number of messages this queue can hold before they are dropped (-1 = infinite)	no	MaxSize
Full Size	The in-memory message limit, can only be set when queue is stopped	no	FullSize
Page Size	The paging size, can only be set when queue is stopped	no	PageSize
Down Cache Size	The write-cache size, can only be set when queue is stopped	no	DownCacheSize
Security Configurations	This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute.	yes	SecurityConfig
Topic Name	Name of the queue to be used in the JMX object name.	yes	MBeanName
JNDI Binding	Binding path of this Topic in JNDI.	yes	JNDIBinding

Note

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

Operations

Table 3.49. Metrics
Name	Description
Remove All Messages	Clears all Subscriptions
List All Subscriptions	Lists all the Subscriptions.
List Durable Subscriptions	Lists all the durable subscriptions.
List Non-durable Subscriptions	Lists all the non-durable subscriptions.
List Messages by ID and Selector	List the messages for a subscription by ID and with an optional selector.
List Non-durable Messages	Lists the non-durable messages by subscription ID and an optional selector.
List Durable Messages	Lists the durable messages by subscription ID and an optional selector.

Package Types

none

3.1.1.6. JBossAS - EJB3 Session Bean Service

Overview

Table 3.50. Overview
Description:	An EJB3 Stateless or Stateful Session Bean
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.51.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this bean	yes	name
Ear		yes	ear
Jar		yes	jar

Note

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

Metrics

Table 3.52. Metrics
Name	Type	Description	Internal Name
Current Count	measurement	The total number of currently pooled instances of this EJB3 Session Bean	CurrentSize
Create Count	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	CreateCount
Remove Count	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	RemoveCount
Available Count	measurement	The number of pooled instances of this EJB3 Session Bean in the method-ready state	AvailableCount
Max Size	measurement	The maximum number of instances that are allowed to be pooled	MaxSize
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB; NOTE: this metric is only available if JBoss EJB3 RC9 Patch 1 or later is being used (a capable version of EJB3 is included with JBossAS 4.2.0.GA or later)	MethodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 3.53. Metrics
Name	Description
View Method Stats	View method execution statistics for the EJB; NOTE: this operation is only available if JBoss EJB3 RC9 Patch 1 or later is being used (a capable version of EJB3 is included with JBossAS 4.2.0.GA or later)

Package Types

none

3.1.1.7. JBossAS - Stateless Session EJB Service

Overview

Table 3.54. Overview
Description:	An EJB 1.x or 2.x Stateless Session Bean
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.55.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this ejb	yes	name
J 2ee Application		yes	j2eeApplication
Ejb Jar		yes	ejbJar

Note

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

Metrics

Table 3.56. Metrics
Name	Type	Description	Internal Name
Create Calls	measurement	The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been created since server start	{stats.createCount.count}
Create Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been created since server start	{stats.createCount.count}
Remove Calls	measurement	The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been removed since server start	{stats.removeCount.count}
Remove Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been removed since server start	{stats.removeCount.count}
Method-Ready Beans	measurement	The number of pooled instances of this EJB 1.x or 2.x Stateless Session Bean in the method-ready state	{stats.methodReadyCount.current}
Pool Size	measurement	The total number of currently pooled instances of this EJB 1.x or 2.x Stateless Session Bean	{{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}CurrentSize}
Max Pool Size	measurement	The maximum number of instances that are allowed to be pooled	{{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxSize}
Method Invocation Time	calltime	the minimum, maximum, and average invocation times for each of the methods exposed by this EJB	MethodInvocationTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.8. JBossAS - Stateful Session EJB Service

Overview

Table 3.57. Overview
Description:	An EJB 1.x or 2.x Stateful Session Bean
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.58.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this EJB	yes	name
J 2ee Application		yes	j2eeApplication
Ejb Jar		yes	ejbJar

Note

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

Metrics

Table 3.59. Metrics
Name	Type	Description	Internal Name
Create Calls	measurement	The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been created since server start	{stats.createCount.count}
Create Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been created since server start	{stats.createCount.count}
Remove Calls	measurement	The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been removed since server start	{stats.removeCount.count}
Remove Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been removed since server start	{stats.removeCount.count}
Method-Ready Beans	measurement	The number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the method-ready state	{stats.methodReadyCount.current}
Passive Beans	measurement	The number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the passivated state	{stats.passiveCount.current}
Method Invocation Time	calltime	the minimum, maximum, and average invocation times for each of the methods exposed by this EJB	MethodInvocationTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.9. JBossAS - Entity EJB Service

Overview

Table 3.60. Overview
Description:	An EJB 1.x or 2.x Entity Bean
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.61.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this ejb	yes	name
J 2ee Application		yes	j2eeApplication
Ejb Jar		yes	ejbJar

Note

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

Metrics

Table 3.62. Metrics
Name	Type	Description	Internal Name
Create Calls	measurement	The number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start	{stats.createCount.count}
Create Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start	{stats.createCount.count}
Remove Calls	measurement	The number of instances of this EJB 1.x or 2.x Entity Bean that have been removed since server start	{stats.removeCount.count}
Remove Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Entity Bean that have been removed since server start	{stats.removeCount.count}
Method-Ready Beans	measurement	The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the method-ready state	{stats.methodReadyCount.current}
Pooled Beans	measurement	The total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean	{stats.pooledCount.current}
Cache Size	measurement	The total number of currently cached instances of this EJB 1.x or 2.x Entity Bean	{{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}CacheSize}
Passivated Count	measurement	The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the passivated state	{{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}PassivatedCount}
Passivated Count per Minute	measurement	The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the passivated state	{{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}PassivatedCount}
Current Size	measurement	The total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean	{{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}PoolSize}
Max Size	measurement	The maximum number of instances that are allowed to be pooled	{{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxPoolSize}

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.10. JBossAS - Message Driven EJB Service

Overview

Table 3.63. Overview
Description:	An EJB 1.x or 2.x Message Driven Bean
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.64.
Name	Description	Required	Internal Name
Object Name		yes	objectName
Name Template		yes	nameTemplate
Description Template		yes	descriptionTemplate
Name	The name of this ejb	yes	name
J 2ee Application		yes	j2eeApplication
Ejb Jar		yes	ejbJar

Note

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

Metrics

Table 3.65. Metrics
Name	Type	Description	Internal Name
Create Calls	measurement	The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been created since server start	{stats.createCount.count}
Create Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been created since server start	{stats.createCount.count}
Remove Calls	measurement	The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been removed since server start	{stats.removeCount.count}
Remove Calls per Minute	measurement	The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been removed since server start	{stats.removeCount.count}
Method-Ready Beans	measurement	The number of pooled instances of this EJB 1.x or 2.x Message Driven Bean in the method-ready state	{stats.messageCount.count}
Method-Ready Beans per Minute	measurement	The number of pooled instances of this EJB 1.x or 2.x Message Driven Bean in the method-ready state	{stats.messageCount.count}

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.11. JBossAS - Enterprise Application (EAR) Service

Overview

Table 3.66. Overview
Description:	Enterprise Application
Singleton:	no
Plugin:	JBossAS

Child Resource Types

Section 3.1.1.11.1, “JBossAS - Embedded Web Application (WAR) Service”

Connection Properties

Table 3.67.
Name	Description	Required	Internal Name
Name	The name of this EAR	yes	name
Filename		yes	filename
Object Name		yes	objectName
Name Template		yes	nameTemplate
Extension		yes	extension
Description Template		yes	descriptionTemplate

Note

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

Metrics

Table 3.68. Metrics
Name	Type	Description	Internal Name
Path	trait	The absolute path of this EAR file or directory	Application.path
Exploded?	trait	Whether this EAR is deployed exploded (i.e. as a directory)	Application.exploded

Note

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

Configuration Properties

none

Operations

Table 3.69. Metrics
Name	Description
Revert	Tries to revert this enterprise application from a saved backup in the same directory and with a name ending in .bak

Package Types

Table 3.70. Package Types
Name	Category	Description
EAR File	Deployable

3.1.1.11.1. JBossAS - Embedded Web Application (WAR) Service

Overview

Table 3.71. Overview
Description:	Web Application embedded inside of an Enterprise Application
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.72.
Name	Description	Required	Internal Name
Name	The name of this WAR	yes	name
Filename		yes	filename
Object Name		yes	objectName
Context Root	this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR	no	contextRoot
Virtual Host	The (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost'	no	vHost
Jboss Web Name	the objectName for the jboss.web WebModule that will be used to fire operations	no	jbossWebName
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Name Template		yes	nameTemplate
Extension		yes	extension
Description Template		yes	descriptionTemplate

Note

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

Metrics

Table 3.73. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this WAR file or directory	Application.path
Exploded?	trait	whether this WAR is deployed exploded (i.e. as a directory)	Application.exploded
Context Root	trait	this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR	ContextRoot
HTTP Response Time	calltime	the minimum, maximum, and average response times for HTTP requests serviced by this webapp	ResponseTime
Min. Servlet Resp. Time	measurement	Minimum response time of a servlet	Servlet.MinResponseTime
Avg. Servlet Resp. Time	measurement	Average response time of a servlet	Servlet.AvgResponseTime
Max. Servlet Resp. Time	measurement	Maximum response time of a servlet	Servlet.MaxResponseTime
Total processing time	measurement	Total processing time of the webapp	Servlet.TotalTime
Total processing time per Minute	measurement	Total processing time of the webapp	Servlet.TotalTime
Requests served	measurement	Number of requests served by servlets	Servlet.NumRequests
Requests served per Minute	measurement	Number of requests served by servlets	Servlet.NumRequests
Errors while processing	measurement	Number of errors while processing	Servlet.NumErrors
Errors while processing per Minute	measurement	Number of errors while processing	Servlet.NumErrors
Currently Active Sessions	measurement	Number active sessions for the webapp right now	Session.activeSessions
Maximum number of Active Sessions	measurement	Maximum number of active sessions for the webapp	Session.maxActive
Sessions created	measurement	Number of sessions created for the webapp	Session.sessionCounter
Sessions created per Minute	measurement	Number of sessions created for the webapp	Session.sessionCounter
Expired Sessions	measurement	Number of expired sessions for the webapp	Session.expiredSessions
Expired Sessions per Minute	measurement	Number of expired sessions for the webapp	Session.expiredSessions
Rejected Sessions	measurement	Number of sessions rejected for the webapp	Session.rejectedSessions
Rejected Sessions per Minute	measurement	Number of sessions rejected for the webapp	Session.rejectedSessions
Session Average alive time	measurement	Average alive time of a Sessions	Session.sessionAverageAliveTime
Max Session alive time	measurement	Maximum alive time of a Sessions	Session.sessionMaxAliveTime
Vhost	trait	Virtual hosts this app runs on	Vhost.name

Note

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

Configuration Properties

none

Operations

Table 3.74. Metrics
Name	Description
Start	starts this webapp; NOTE: this operation is not supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Stop	stops this webapp; NOTE: this operation is not supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Reload	reloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail

Package Types

none

3.1.1.12. JBossAS - Web Application (WAR) Service

Overview

Table 3.75. Overview
Description:	Web Application
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.76.
Name	Description	Required	Internal Name
Name	The name of this WAR	yes	name
Filename		yes	filename
Object Name		yes	objectName
Context Root	this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR	no	contextRoot
Virtual Host	The (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost'	no	vHost
Jboss Web Name	the objectName for the jboss.web WebModule that will be used to fire operations	no	jbossWebName
Response Time Log File	the full path to the log file containing response-time stats for this webapp. The location is determined by the RtFilter and is usually something like ...server/.../log/rt/appname_rt.log	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Name Template		yes	nameTemplate
Extension		yes	extension
Description Template		yes	descriptionTemplate

Note

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

Metrics

Table 3.77. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this WAR file or directory	Application.path
Exploded?	trait	whether this WAR is deployed exploded (i.e. as a directory)	Application.exploded
Context Root	trait	this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR	ContextRoot
HTTP Response Time	calltime	the minimum, maximum, and average response times for HTTP requests serviced by this webapp	ResponseTime
Min. Servlet Resp. Time	measurement	Minimum response time of a servlet	Servlet.MinResponseTime
Avg. Servlet Resp. Time	measurement	Average response time of a servlet	Servlet.AvgResponseTime
Max. Servlet Resp. Time	measurement	Maximum response time of a servlet	Servlet.MaxResponseTime
Total processing time	measurement	Total processing time of the webapp	Servlet.TotalTime
Total processing time per Minute	measurement	Total processing time of the webapp	Servlet.TotalTime
Requests served	measurement	Number of requests served by servlets	Servlet.NumRequests
Requests served per Minute	measurement	Number of requests served by servlets	Servlet.NumRequests
Errors while processing	measurement	Number of errors while processing	Servlet.NumErrors
Errors while processing per Minute	measurement	Number of errors while processing	Servlet.NumErrors
Currently Active Sessions	measurement	Number active sessions for the webapp right now	Session.activeSessions
Maximum number of Active Sessions	measurement	Maximum number of active sessions for the webapp	Session.maxActive
Sessions created	measurement	Number of sessions created for the webapp	Session.sessionCounter
Sessions created per Minute	measurement	Number of sessions created for the webapp	Session.sessionCounter
Expired Sessions	measurement	Number of expired sessions for the webapp	Session.expiredSessions
Expired Sessions per Minute	measurement	Number of expired sessions for the webapp	Session.expiredSessions
Rejected Sessions	measurement	Number of sessions rejected for the webapp	Session.rejectedSessions
Rejected Sessions per Minute	measurement	Number of sessions rejected for the webapp	Session.rejectedSessions
Session Average alive time	measurement	Average alive time of a Sessions	Session.sessionAverageAliveTime
Max Session alive time	measurement	Maximum alive time of a Sessions	Session.sessionMaxAliveTime
Vhost	trait	Virtual hosts this app runs on	Vhost.name

Note

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

Configuration Properties

none

Operations

Table 3.78. Metrics
Name	Description
Start	starts this webapp; NOTE: this operation is not supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Stop	stops this webapp; NOTE: this operation is not supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006)
Reload	reloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail
Revert	Tries to revert this web application from a saved backup in the same directory and with a name ending in .bak

Package Types

Table 3.79. Package Types
Name	Category	Description
WAR File	Deployable

3.1.1.13. JBossAS - EJB3 Entity Tree Cache Service

Overview

Table 3.80. Overview
Description:	The entity cache
Singleton:	no
Plugin:	JBossAS

Child Resource Types

Section 3.1.1.13.1, “JBossAS - EJB3 Entity Tree Cache Interceptor Service”

Connection Properties

Table 3.81.
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

Table 3.82. Metrics
Name	Type	Description	Internal Name
Number Of Locks Held	measurement	The number of entities locked for update / replication across the (clustered) tree cache	NumberOfLocksHeld
Number Of Nodes	measurement	The total number of entities currently cached across the (clustered) tree cache	NumberOfNodes

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.13.1. JBossAS - EJB3 Entity Tree Cache Interceptor Service

Overview

Table 3.83. Overview
Description:	The entity cache interceptor
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.84.
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

Table 3.85. Metrics
Name	Type	Description	Internal Name
Hit Miss Ratio	measurement	Returns the hit/miss ratio for the cache. This ratio is defined as hits/(hits + misses).	HitMissRatio
Read Write Ratio	measurement	Returns the read/write ratio for the cache. This ratio is defined as (hits + misses)/stores.	ReadWriteRatio
Hits	measurement	Returns the number of requests made to this cache which it could answer without interrogating the underlying data store	Hits
Misses	measurement	Returns the number of requests made to this cache which required interrogating the underlying data store	Misses
Evictions	measurement	Returns the number of elements purged from this cache in accordance with its specific eviction policy	Evictions
Number Of Locks Held	measurement	The number of elements locked by this interceptor for update / replication across the (clustered) tree cache	NumberOfLocksHeld
Number Of Nodes	measurement	The total number of entities currently cached across the (clustered) tree cache	NumberOfNodes
Average Write Time	measurement	The average time it takes to insert or update elements for the cache	AverageWriteTime
Time Since Reset	measurement	The amount of time since this cache was reset / cleared	TimeSinceReset
Average Read Time	measurement	The average time it takes to read elements for the cache, includes	AverageReadTime
Stores	measurement	Number of store / writes into this cache made by this interceptor	Stores
Number Of Attributes	measurement	The total number of attributes (properties of an entity) currently cached across the (clustered) tree cache	NumberOfAttributes
Elapsed Time	measurement	The amount of time since this cache was created	ElapsedTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.1.1.14. JBossAS - Script Service

Overview

Table 3.86. Overview
Description:	provides the ability to execute a script that performs some task related to its parent JBossAS server
Singleton:	no
Plugin:	JBossAS

Child Resource Types

none

Connection Properties

Table 3.87.
Name	Description	Required	Internal Name
Path	the absolute path to the script file	yes	path
Environment Variables	the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties	no	environmentVariables

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 3.88. Metrics
Name	Description
Execute Script	execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory>Connection tab)

Package Types

none

3.2. Red Hat JBoss Enterprise Application Platform 5.x (EAP 5) and JBoss Application Server 5.x/6.x Plugin

Table 3.89. Basic Details
Internal Name:	JBossAS5
Description:	provides management and monitoring of JBoss AS 6.x and JBoss EAP/EWP/SOA-P 5.x
Version:	4.4.0

Top-Level Resource Types

Section 3.2.1, “JBossAS5 - JBossAS Server”

3.2.1. JBossAS5 - JBossAS Server

Overview

Table 3.90. Overview
Description:	JBoss Application Server (AS), Enterprise Application Platform (EAP), Enterprise SOA Platform (SOA-P), or Enterprise Web Platform (EWP) 5.x or 6.x instance
Singleton:	no
Plugin:	JBossAS5

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 run.sh on UNIX or run.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-eap-5.0/jboss-as/bin/run.sh") * Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") the prefix is also prepsended to the stop script command line if the Stop operation is configured to stop the app server via script. * Start Script Arguments - arguments to be passed to the start script (e.g. "--configuration=production") * 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 JBossAS5 plugin discovery code to match the currently running server process' command line and environment. For more detailed descriptions of the settings, see the Connection Settings section below.

Child Resource Types

Section 3.2.1.1, “JBossAS5 - JBoss Web Service”
Section 3.2.1.2, “JBossAS5 - No Tx Datasource Service”
Section 3.2.1.3, “JBossAS5 - Local Tx Datasource Service”
Section 3.2.1.4, “JBossAS5 - XA Datasource Service”
Section 3.2.1.5, “JBossAS5 - No Tx ConnectionFactory Service”
Section 3.2.1.6, “JBossAS5 - Tx ConnectionFactory Service”
Section 3.2.1.7, “JBossAS5 - JBoss Messaging Service”
Section 3.2.1.8, “JBossAS5 - Enterprise Application (EAR) Service”
Section 3.2.1.9, “JBossAS5 - Web Application (WAR) Service”
Section 3.2.1.10, “JBossAS5 - Embedded Web Application (WAR) Service”
Section 3.2.1.11, “JBossAS5 - EJB2 JAR Service”
Section 3.2.1.12, “JBossAS5 - Embedded EJB2 JAR Service”
Section 3.2.1.13, “JBossAS5 - EJB3 JAR Service”
Section 3.2.1.14, “JBossAS5 - Embedded EJB3 JAR Service”
Section 3.2.1.15, “JBossAS5 - Resource Adapter Archive (RAR) Service”
Section 3.2.1.16, “JBossAS5 - Embedded Resource Adapter Archive (RAR) Service”
Section 3.2.1.17, “JBossAS5 - Script Service”
Section 3.2.1.18, “JBossAS5 - Service Binding Manager Service”

Autodiscovery Process Scans

Table 3.91. Metrics
Name	Query
jbossas	process\|basename\|match=^java.,arg\|org.jboss.Main\|match=.

Connection Properties

Table 3.92.
Name	Description	Required	Internal Name
Naming Provider URL	The JBoss Naming Provider (JNP) URL with which to connect to the JBoss AS or EAP instance (e.g. jnp://127.0.0.1:1099).	yes	namingURL
Principal	The name of the principal (i.e. user) to authenticate.	no	principal
Credentials	The credentials (i.e. password) that should be used to authenticate the principal.	no	credentials
JBoss Home Directory	The absolute path to the directory where JBoss AS or EAP is installed (e.g. /opt/jboss-5.1.0.GA).	yes	homeDir
Server Home Dir	The path to the configuration directory under which this instance operates (e.g. /opt/jboss-5.2.0.GA/server/default); if the path is not absolute, then it will be resolved relative to {homeDir}.	yes	serverHomeDir
Server Name	The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {serverHomeDir}. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -c option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead.	no	serverName
Client Url	The URL of the server's client JAR library directory; if not specified, it will default to {homeDir}/client.	no	clientUrl
Lib Url	The URL of the server's main JAR library directory; if not specified, it will default to {homeDir}/lib.	no	libUrl
Common Lib Url	The URL of the server's common JAR library directory; if not specified, it will default to {homeDir}/common/lib.	no	commonLibUrl
Script Prefix	A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set.	no	scriptPrefix
Start Script	The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows.	no	startScript
Start Script Environment Variables	The 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. JAVA_OPTS=-Xms512M -Xmx1024M). 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 Arguments	The 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 default. There is currently a 2000 character limit for this value.	no	startScriptArgs
Shutdown Script	The path to the script used by the Shut Down operation to shut down this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows.	no	shutdownScript
Shutdown Method	The method used to execute the Shut Down operation; defaults to 'JMX MBean'. 'JMX MBean' is the preferred shutdown method and should be used unless there is a specific use case for using a script.	no	shutdownMethod
Bind Address	The host or IP address that all application server services should listen on (e.g. 10.11.14.233 or foo.example.com); specify 0.0.0.0 to tell the application server to bind to all available network interfaces; defaults to '127.0.0.1'. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -b option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead.	no	bindAddress
Java Home	The absolute path to a JRE or JDK installation directory containing the JVM that should be used by the operations that start and/or shut down this JBoss AS server; for the Shutdown operation to work when the shutdown method is set to 'shutdown script', the property must be set. For the Start operation, this property is deprecated and will be ignored if the 'startScriptEnv' property is set.	no	javaHome
Start Wait Max	The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes.	no	startWaitMax
Stop Wait Max	The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes.	no	stopWaitMax
Shutdown MBean Name	Name of the MBean to use when shutting down this server through JMX.	yes	shutdownMBeanName
Shutdown MBean Operation	Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied.	yes	shutdownMBeanOperation
Service Availability Refresh Interval	The amount of time, in minutes, that can elapse for service resource (e.g., EJBs, data sources) availability checks without having to refresh the managed object from the JBoss server. The information used to perform availability checks is cached. This property determines how frequently that data needs to be reloaded from the JBoss server. Any time the managed object is loaded from the server, like for collecting metrics, the availability information is updated and the interval is reset.	no	serviceAvailabilityRefreshInterval
JBoss AS JVM Name	The name of the JBoss AS JVM resource.	no	childJmxServerName
Log Event Sources		yes	logEventSources

Note

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

Metrics

Table 3.93. Metrics
Name	Type	Description	Internal Name
Cluster Partition Name	trait	the name of the cluster partition this server belongs to	MCBean\|ServerConfig\|*\|partitionName
Server Name	trait	the name of the active profile (i.e. configuration set) this server is using	MCBean\|ServerConfig\|*\|serverName
Server Home Dir	trait	the full path of the configuration set directory this server is using (e.g. /opt/jboss-5.1.0.CR1/server/default)	MCBean\|ServerConfig\|*\|serverHomeDir
Version Name	trait	the code name for this app server's version (AS 5.0 = Morpheus, AS 5.1 = The Oracle, AS 6.x = Neo)	MCBean\|MCServer\|*\|versionName
Build Date	trait	the date this app server was built	MCBean\|MCServer\|*\|buildDate
Start Date	trait	the date and time this app server instance was started	MCBean\|MCServer\|*\|startDate
Active Thread Count	measurement	The current number of active threads for this app server instance	MCBean\|ServerInfo\|*\|activeThreadCount
Active Thread Group Count	measurement	The current number of active thread groups for this app server instance	MCBean\|ServerInfo\|*\|activeThreadGroupCount
JVM Free Memory	measurement	An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes	MCBean\|ServerInfo\|*\|freeMemory
JVM Max Memory	measurement	The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned	MCBean\|ServerInfo\|*\|maxMemory
JVM Total Memory	measurement	The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes	MCBean\|ServerInfo\|*\|totalMemory
Total Transactions	measurement	Total number of transactions since last restart	MCBean\|JTA\|*\|transactionCount
Total Transactions per Minute	measurement	Total number of transactions since last restart	MCBean\|JTA\|*\|transactionCount
Transactions Committed	measurement	Number of transactions committed since last restart	MCBean\|JTA\|*\|commitCount
Transactions Committed per Minute	measurement	Number of transactions committed since last restart	MCBean\|JTA\|*\|commitCount
Transactions Rolled Back	measurement	Number of transactions rolled back since last restart	MCBean\|JTA\|*\|rollbackCount
Transactions Rolled Back per Minute	measurement	Number of transactions rolled back since last restart	MCBean\|JTA\|*\|rollbackCount

Note

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

Configuration Properties

none

Operations

Table 3.94. Metrics
Name	Description
Start	Start this application server. The script used is specified in the Operations group of connection properties. This operation will fail if the server is already started.
Shut Down	Shut down this application server via script or JMX, depending on the settings in the Operations and Advanced groups of connection properties. This operation will fail if the server is already shut down.
Restart	Shut down (if started) and then start this application server.

Package Types

Table 3.95. Package Types
Name	Category	Description
Cumulative Patch	Deployable	Automatically installable application server patches
JAR Library	Deployable	Library Jar files deployed in JBoss AS

3.2.1.1. JBossAS5 - JBoss Web Service

Overview

Table 3.96. Overview
Description:	JBoss Web Servlet Container
Singleton:	yes
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.1.1, “JBossAS5 - Connector Service”
Section 3.2.1.1.2, “JBossAS5 - Virtual Host Service”

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.1.1. JBossAS5 - Connector Service

Overview

Table 3.97. Overview
Description:	a JBoss Web Connector
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.98.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Protocol	this connector's protocol (e.g. jk, ajp, http)	yes	protocol
Address	the IP address this connector listens on	yes	address
Port	the port this connector listens on	yes	port

Note

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

Metrics

Table 3.99. Metrics
Name	Type	Description	Internal Name
Maximum Request Time	measurement	the maximum time it took to process a request since the last restart	maxTime
Request Count	measurement	the total number of requests processed since the last restart	requestCount
Request Count per Minute	measurement	the total number of requests processed since the last restart	requestCount
Error Count	measurement	the number of errors while processing requests since the last restart	errorCount
Error Count per Minute	measurement	the number of errors while processing requests since the last restart	errorCount
Current Active Threads	measurement	the number of threads for this connector that are currently active	ThreadPool\|currentThreadsBusy
Current Thread Count	measurement	the number of threads for this connector that currently exist	ThreadPool\|currentThreadCount
Maximum Threads	trait	Maximum number of threads that can be allocated for the thread pool of this connector	ThreadPool\|maxThreads

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.1.2. JBossAS5 - Virtual Host Service

Overview

Table 3.100. Overview
Description:	a JBoss Web virtual host
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.101.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Name	the virtual host's name (e.g. localhost)	yes	name

Note

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

Metrics

Table 3.102. Metrics
Name	Type	Description	Internal Name
Aliases	trait	the aliases for this virtual host, if any	aliases

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.2. JBossAS5 - No Tx Datasource Service

Overview

Table 3.103. Overview
Description:	No Transaction Datasources deployed in the instance of JBoss AS
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.104.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.105. Metrics
Name	Type	Description	Internal Name
Run State	trait	Run State	runState
Connection Available?	trait	could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric	custom.connectionAvailable
Pool JNDI Name	trait	the JNDI name of the connection pool for this datasource	poolJndiName
Available Connection Count	measurement	the maximum number of connections that are available	availableConnectionCount
Connection Count	measurement	the number of connections that are currently in the pool	connectionCount
Connection Created Count	measurement	the number of connections that have been created since the datasource was last started	connectionCreatedCount
Connection Destroyed Count	measurement	the number of connections that have been destroyed since the datasource was last started	connectionDestroyedCount
In Use Connection Count	measurement	the number of connections that are currently in use	inUseConnectionCount
Local Transaction	trait	Local Transaction	local-transaction
Max Connections In Use Count	measurement	the most connections that have been simultaneously in use since this datasource was started	maxConnectionsInUseCount
Max Size	measurement	Max Size	maxSize
Min Size	measurement	Min Size	minSize

Note

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

Configuration Properties

Table 3.106.
Name	Description	Required	Internal Name
JNDI Name	The global JNDI Name under which to bind the datasource	yes	jndi-name
Username	The default username when creating a new connection.	no	user-name
Password	The default password when creating a new connection.	no	password
Minimum Pool Size	The minimum number of connections the pool should hold. The default is 0.	no	min-pool-size
Maximum Pool Size	The maximum number of connections the pool should hold. The default is 10.	no	max-pool-size
JDBC Driver Class	The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver").	yes	driver-class
Connection URL	The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1\|jdbc:oracle:thin:@host2.example.com:1521:db2").	yes	connection-url
Connection Properties	Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method.	no	connection-properties
Allocation Retry	The number of times that allocating a connection should be tried before throwing an exception. The default is 0.	no	allocation-retry
Allocation Retry Wait Millis	The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).	no	allocation-retry-wait-millis
Background Validation	Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No.	no	background-validation
Background Validation Millis	The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0.	no	background-validation-millis
Blocking Timeout in Milliseconds	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).	no	blocking-timeout-millis
Idle Timeout	The maximum time, in minutes, a connection may be idle before being closed. The default is 30.	no	idle-timeout-minutes
Is Same RM Override Value	If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource).	no	isSameRM-override-value
Jmx Invoker Name	The ObjectName of the JMX Invoker MBean associated with this datasource.	no	jmx-invoker-name
Metadata	Metadata properties.	no	metadata
No Tx Separate Pools	If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes.	no	no-tx-separate-pools
Prefill	Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No.	no	prefill
Security Settings	Security settings for connections in the pool.	no	security-domain
Statistics Formatter	The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter".	no	statistics-formatter
Type Mapping	The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings.	no	type-mapping
Use Java Context	Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes.	no	use-java-context
Use Strict Min	Whether idle connections below the min-pool-size should be closed. The default is No.	no	use-strict-min
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes.	no	validate-on-match
Check Valid Connection SQL	The SQL statement to use to check the validity of a pool connection.	no	check-valid-connection-sql
Connection Definition	The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource".	no	connection-definition
Exception Sorter Class Name	The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast.	no	exception-sorter-class-name
New Connection SQL	An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc.	no	new-connection-sql
Prepared Statement Cache Size	The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0.	no	prepared-statement-cache-size
Query Timeout	Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0.	no	query-timeout
Rar Name	The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars.	no	rar-name
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout; any configured query timeout will be used if there is no transaction. The default is No.	no	set-tx-query-timeout
Share Prepared Statements	Should prepared statements be shared? The default is No.	no	share-prepared-statements
Stale Connection Checker Class Name	Fully qualified name of the Java class used to check if a connection has become stale.	no	stale-connection-checker-class-name
Track Statements	Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings".	no	track-statements
Transaction Isolation	The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database.	no	transaction-isolation
Url Delimiter	Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "\|".	no	url-delimiter
Url Selector Strategy Class Name	The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface.	no	url-selector-strategy-class-name
Use Try Lock	Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0.	no	use-try-lock
Valid Connection Checker Class Name	The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool.	no	valid-connection-checker-class-name

Note

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

Operations

Table 3.107. Metrics
Name	Description
Flush	Flush the connections in the pool
List Formatted Sub Pool Statistics	Obtain a formatted sub pool statistics report
List Statistics	Obtain a statistics report
Test Connection	Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained

Package Types

none

3.2.1.3. JBossAS5 - Local Tx Datasource Service

Overview

Table 3.108. Overview
Description:	Local Transaction Datasources deployed in the instance of JBoss AS
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.109.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.110. Metrics
Name	Type	Description	Internal Name
Run State	trait	Run State	runState
Connection Available?	trait	could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric	custom.connectionAvailable
Pool JNDI Name	trait	the JNDI name of the connection pool for this datasource	poolJndiName
Available Connection Count	measurement	the maximum number of connections that are available	availableConnectionCount
Connection Count	measurement	the number of connections that are currently in the pool	connectionCount
Connection Created Count	measurement	the number of connections that have been created since the datasource was last started	connectionCreatedCount
Connection Destroyed Count	measurement	the number of connections that have been destroyed since the datasource was last started	connectionDestroyedCount
In Use Connection Count	measurement	the number of connections that are currently in use	inUseConnectionCount
Local Transaction	trait	Local Transaction	local-transaction
Max Connections In Use Count	measurement	the most connections that have been simultaneously in use since this datasource was started	maxConnectionsInUseCount
Max Size	measurement	Max Size	maxSize
Min Size	measurement	Min Size	minSize

Note

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

Configuration Properties

Table 3.111.
Name	Description	Required	Internal Name
JNDI Name	The global JNDI Name under which to bind the datasource	yes	jndi-name
Username	The default username when creating a new connection.	no	user-name
Password	The default password when creating a new connection.	no	password
Minimum Pool Size	The minimum number of connections the pool should hold. The default is 0.	no	min-pool-size
Maximum Pool Size	The maximum number of connections the pool should hold. The default is 10.	no	max-pool-size
JDBC Driver Class	The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver").	yes	driver-class
Connection URL	The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1\|jdbc:oracle:thin:@host2.example.com:1521:db2").	yes	connection-url
Connection Properties	Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method.	no	connection-properties
Allocation Retry	The number of times that allocating a connection should be tried before throwing an exception. The default is 0.	no	allocation-retry
Allocation Retry Wait Millis	The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).	no	allocation-retry-wait-millis
Background Validation	Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No.	no	background-validation
Background Validation Millis	The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0.	no	background-validation-millis
Blocking Timeout in Milliseconds	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).	no	blocking-timeout-millis
Idle Timeout	The maximum time, in minutes, a connection may be idle before being closed. The default is 30.	no	idle-timeout-minutes
Is Same RM Override Value	If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource).	no	isSameRM-override-value
Jmx Invoker Name	The ObjectName of the JMX Invoker MBean associated with this datasource.	no	jmx-invoker-name
Metadata	Metadata properties.	no	metadata
No Tx Separate Pools	If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes.	no	no-tx-separate-pools
Prefill	Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No.	no	prefill
Security Settings	Security settings for connections in the pool.	no	security-domain
Statistics Formatter	The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter".	no	statistics-formatter
Type Mapping	The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings.	no	type-mapping
Use Java Context	Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes.	no	use-java-context
Use Strict Min	Whether idle connections below the min-pool-size should be closed. The default is No.	no	use-strict-min
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes.	no	validate-on-match
Check Valid Connection SQL	The SQL statement to use to check the validity of a pool connection.	no	check-valid-connection-sql
Connection Definition	The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource".	no	connection-definition
Exception Sorter Class Name	The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast.	no	exception-sorter-class-name
New Connection SQL	An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc.	no	new-connection-sql
Prepared Statement Cache Size	The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0.	no	prepared-statement-cache-size
Query Timeout	Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0.	no	query-timeout
Rar Name	The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars.	no	rar-name
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout; any configured query timeout will be used if there is no transaction. The default is No.	no	set-tx-query-timeout
Share Prepared Statements	Should prepared statements be shared? The default is No.	no	share-prepared-statements
Stale Connection Checker Class Name	Fully qualified name of the Java class used to check if a connection has become stale.	no	stale-connection-checker-class-name
Track Statements	Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings".	no	track-statements
Transaction Isolation	The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database.	no	transaction-isolation
Url Delimiter	Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "\|".	no	url-delimiter
Url Selector Strategy Class Name	The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface.	no	url-selector-strategy-class-name
Use Try Lock	Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0.	no	use-try-lock
Valid Connection Checker Class Name	The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool.	no	valid-connection-checker-class-name

Note

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

Operations

Table 3.112. Metrics
Name	Description
Flush	Flush the connections in the pool
List Formatted Sub Pool Statistics	Obtain a formatted sub pool statistics report
List Statistics	Obtain a statistics report
Test Connection	Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained

Package Types

none

3.2.1.4. JBossAS5 - XA Datasource Service

Overview

Table 3.113. Overview
Description:	XA Datasources deployed in the instance of JBoss AS
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.114.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.115. Metrics
Name	Type	Description	Internal Name
Run State	trait	Run State	runState
Connection Available?	trait	could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric	custom.connectionAvailable
Pool JNDI Name	trait	the JNDI name of the connection pool for this datasource	poolJndiName
Available Connection Count	measurement	the maximum number of connections that are available	availableConnectionCount
Connection Count	measurement	the number of connections that are currently in the pool	connectionCount
Connection Created Count	measurement	the number of connections that have been created since the datasource was last started	connectionCreatedCount
Connection Destroyed Count	measurement	the number of connections that have been destroyed since the datasource was last started	connectionDestroyedCount
In Use Connection Count	measurement	the number of connections that are currently in use	inUseConnectionCount
Local Transaction	trait	Local Transaction	local-transaction
Max Connections In Use Count	measurement	the most connections that have been simultaneously in use since this datasource was started	maxConnectionsInUseCount
Max Size	measurement	Max Size	maxSize
Min Size	measurement	Min Size	minSize

Note

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

Configuration Properties

Table 3.116.
Name	Description	Required	Internal Name
JNDI Name	The global JNDI Name under which to bind the datasource	yes	jndi-name
Username	The default username when creating a new connection.	no	user-name
Password	The default password when creating a new connection.	no	password
Minimum Pool Size	The minimum number of connections the pool should hold. The default is 0.	no	min-pool-size
Maximum Pool Size	The maximum number of connections the pool should hold. The default is 10.	no	max-pool-size
XA DataSource Class	The fully qualified name of the javax.sql.XADataSource implementation class.	yes	xa-datasource-class
XA Datasource Properties	The properties to assign to the XADataSource implementation class. Each property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor for the type.	no	xa-datasource-properties
XA Resource Timeout	XA transaction timeout, in seconds (passed to XAResource.setTransactionTimeout()) - default is zero which does not invoke the setter.	no	xa-resource-timeout
URL Property	For HA XA datasources, specifies the name of an XADataSource property that contains a list of URLs.	no	url-property
Allocation Retry	The number of times that allocating a connection should be tried before throwing an exception. The default is 0.	no	allocation-retry
Allocation Retry Wait Millis	The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).	no	allocation-retry-wait-millis
Background Validation	Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No.	no	background-validation
Background Validation Millis	The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0.	no	background-validation-millis
Blocking Timeout in Milliseconds	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).	no	blocking-timeout-millis
Idle Timeout	The maximum time, in minutes, a connection may be idle before being closed. The default is 30.	no	idle-timeout-minutes
Is Same RM Override Value	If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource).	no	isSameRM-override-value
Jmx Invoker Name	The ObjectName of the JMX Invoker MBean associated with this datasource.	no	jmx-invoker-name
Metadata	Metadata properties.	no	metadata
No Tx Separate Pools	If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes.	no	no-tx-separate-pools
Prefill	Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No.	no	prefill
Security Settings	Security settings for connections in the pool.	no	security-domain
Statistics Formatter	The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter".	no	statistics-formatter
Type Mapping	The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings.	no	type-mapping
Use Java Context	Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes.	no	use-java-context
Use Strict Min	Whether idle connections below the min-pool-size should be closed. The default is No.	no	use-strict-min
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes.	no	validate-on-match
Check Valid Connection SQL	The SQL statement to use to check the validity of a pool connection.	no	check-valid-connection-sql
Connection Definition	The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource".	no	connection-definition
Exception Sorter Class Name	The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast.	no	exception-sorter-class-name
New Connection SQL	An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc.	no	new-connection-sql
Prepared Statement Cache Size	The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0.	no	prepared-statement-cache-size
Query Timeout	Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0.	no	query-timeout
Rar Name	The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars.	no	rar-name
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout; any configured query timeout will be used if there is no transaction. The default is No.	no	set-tx-query-timeout
Share Prepared Statements	Should prepared statements be shared? The default is No.	no	share-prepared-statements
Stale Connection Checker Class Name	Fully qualified name of the Java class used to check if a connection has become stale.	no	stale-connection-checker-class-name
Track Statements	Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings".	no	track-statements
Transaction Isolation	The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database.	no	transaction-isolation
Url Delimiter	Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "\|".	no	url-delimiter
Url Selector Strategy Class Name	The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface.	no	url-selector-strategy-class-name
Use Try Lock	Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0.	no	use-try-lock
Valid Connection Checker Class Name	The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool.	no	valid-connection-checker-class-name
Interleaving	If true, enable transaction interleaving if the DB vendor supports it (most do not). This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false.	no	interleaving

Note

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

Operations

Table 3.117. Metrics
Name	Description
Flush	Flush the connections in the pool
List Formatted Sub Pool Statistics	Obtain a formatted sub pool statistics report
List Statistics	Obtain a statistics report
Test Connection	Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained

Package Types

none

3.2.1.5. JBossAS5 - No Tx ConnectionFactory Service

Overview

Table 3.118. Overview
Description:	A ConnectionFactory that does not take part in JTA transactions.
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.119.
Name	Description	Required	Internal Name
Custom Properties	Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties.	no	customProperties
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.120. Metrics
Name	Type	Description	Internal Name
Run State	trait	Run State	runState
Connection Available?	trait	could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric	custom.connectionAvailable
Pool JNDI Name	trait	Pool JNDI Name	poolJndiName
Available Connection Count	measurement	Number of available connections.	availableConnectionCount
Connection Count	measurement	Connection Count	connectionCount
Connection Created Count	measurement	Connection Created Count	connectionCreatedCount
Connection Destroyed Count	measurement	Connection Destroyed Count	connectionDestroyedCount
In Use Connection Count	measurement	Mumber of connections currently in use.	inUseConnectionCount
Max Connections In Use Count	measurement	Maximum number of maximum connections that have been in use.	maxConnectionsInUseCount
Max Size	measurement	Max Size	maxSize
Min Size	measurement	Min Size	minSize

Note

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

Configuration Properties

Table 3.121.
Name	Description	Required	Internal Name
JNDI Name	The global JNDI name to bind the connection factory under.	yes	jndi-name
RAR Name	The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar.	yes	rar-name
Connection Definition	The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file.	yes	connection-definition
Minimum Pool Size	The minimum number of connections the pool should hold. The default is 0.	no	min-pool-size
Maximum Pool Size	The maximum number of connections the pool should hold. The default is 10.	no	max-pool-size
Allocation Retry	The number of times that allocating a connection should be tried before throwing an exception. The default is 0.	no	allocation-retry
Allocation Retry Wait Millis	The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).	no	allocation-retry-wait-millis
Background Validation	Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No.	no	background-validation
Background Validation Millis	The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0.	no	background-validation-millis
Blocking Timeout in Milliseconds	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).	no	blocking-timeout-millis
Idle Timeout	The maximum time, in minutes, a connection may be idle before being closed. The default is 30.	no	idle-timeout-minutes
Is Same RM Override Value	If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource).	no	isSameRM-override-value
Jmx Invoker Name	The ObjectName of the JMX Invoker MBean associated with this datasource.	no	jmx-invoker-name
Metadata	Metadata properties.	no	metadata
No Tx Separate Pools	If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes.	no	no-tx-separate-pools
Prefill	Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No.	no	prefill
Security Settings	Security settings for connections in the pool.	no	security-domain
Statistics Formatter	The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter".	no	statistics-formatter
Type Mapping	The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings.	no	type-mapping
Use Java Context	Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes.	no	use-java-context
Use Strict Min	Whether idle connections below the min-pool-size should be closed. The default is No.	no	use-strict-min
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes.	no	validate-on-match
Config Property	Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration.	no	config-property

Note

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

Operations

Table 3.122. Metrics
Name	Description
Flush	Flush the connections in the pool
List Formatted Sub Pool Statistics	Obtain a formatted sub pool statistics report
List Statistics	Obtain a statistics report
Test Connection	Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained

Package Types

none

3.2.1.6. JBossAS5 - Tx ConnectionFactory Service

Overview

Table 3.123. Overview
Description:	A ConnectionFactory that takes part in JTA transactions.
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.124.
Name	Description	Required	Internal Name
Custom Properties	Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties.	no	customProperties
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.125. Metrics
Name	Type	Description	Internal Name
Transaction Type	trait	The type of transactions used by this connection factory - Local or XA	custom.transactionType
Run State	trait	Run State	runState
Connection Available?	trait	could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric	custom.connectionAvailable
Pool JNDI Name	trait	Pool JNDI Name	poolJndiName
Available Connection Count	measurement	Number of available connections.	availableConnectionCount
Connection Count	measurement	Connection Count	connectionCount
Connection Created Count	measurement	Connection Created Count	connectionCreatedCount
Connection Destroyed Count	measurement	Connection Destroyed Count	connectionDestroyedCount
In Use Connection Count	measurement	Mumber of connections currently in use.	inUseConnectionCount
Max Connections In Use Count	measurement	Maximum number of maximum connections that have been in use.	maxConnectionsInUseCount
Max Size	measurement	Max Size	maxSize
Min Size	measurement	Min Size	minSize

Note

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

Configuration Properties

Table 3.126.
Name	Description	Required	Internal Name
JNDI Name	The global JNDI name to bind the connection factory under.	yes	jndi-name
RAR Name	The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar.	yes	rar-name
Connection Definition	The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file.	yes	connection-definition
Minimum Pool Size	The minimum number of connections the pool should hold. The default is 0.	no	min-pool-size
Maximum Pool Size	The maximum number of connections the pool should hold. The default is 10.	no	max-pool-size
XA Transaction	Whether on not to use XA transactions. The default is No.	no	xa-transaction
Allocation Retry	The number of times that allocating a connection should be tried before throwing an exception. The default is 0.	no	allocation-retry
Allocation Retry Wait Millis	The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds).	no	allocation-retry-wait-millis
Background Validation	Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No.	no	background-validation
Background Validation Millis	The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0.	no	background-validation-millis
Blocking Timeout in Milliseconds	Indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. The default is 30000 (30 seconds).	no	blocking-timeout-millis
Idle Timeout	The maximum time, in minutes, a connection may be idle before being closed. The default is 30.	no	idle-timeout-minutes
Is Same RM Override Value	If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource).	no	isSameRM-override-value
Jmx Invoker Name	The ObjectName of the JMX Invoker MBean associated with this datasource.	no	jmx-invoker-name
Metadata	Metadata properties.	no	metadata
No Tx Separate Pools	If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes.	no	no-tx-separate-pools
Prefill	Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No.	no	prefill
Security Settings	Security settings for connections in the pool.	no	security-domain
Statistics Formatter	The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter".	no	statistics-formatter
Type Mapping	The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings.	no	type-mapping
Use Java Context	Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes.	no	use-java-context
Use Strict Min	Whether idle connections below the min-pool-size should be closed. The default is No.	no	use-strict-min
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation. The default is Yes.	no	validate-on-match
Config Property	Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration.	no	config-property
Interleaving	If true, enable transaction interleaving if the DB vendor supports it (most do not). Can only be set to true if XA transactions are enabled. This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false.	no	interleaving
XA Resource Timeout	The maximum time, in minutes, an XA Resource can be idle before it is removed. 0 means no timeout. The default is 0.	no	xa-resource-timeout

Note

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

Operations

Table 3.127. Metrics
Name	Description
Flush	Flush the connections in the pool
List Formatted Sub Pool Statistics	Obtain a formatted sub pool statistics report
List Statistics	Obtain a statistics report
Test Connection	Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained

Package Types

none

3.2.1.7. JBossAS5 - JBoss Messaging Service

Overview

Table 3.128. Overview
Description:	the JBoss Messaging JMS provider
Singleton:	yes
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.7.1, “JBossAS5 - Queue Service”
Section 3.2.1.7.2, “JBossAS5 - Topic Service”

Connection Properties

Table 3.129.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName

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.2.1.7.1. JBossAS5 - Queue Service

Overview

Table 3.130. Overview
Description:	a JMS queue
Singleton:	no
Plugin:	JBossAS5

Note

The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the {{enableMessageCounters}} operation on the {{jboss.messaging:service=ServerPeer}} MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's {{deploy/messaging/messaging-service.xml}} file and set the {{EnableMessageCounters}} attribute to "true".

Child Resource Types

none

Connection Properties

Table 3.131.
Name	Description	Required	Internal Name
Jms Type		yes	jms-type
Custom Properties	Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties.	no	customProperties
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.132. Metrics
Name	Type	Description	Internal Name
Run State	trait	Run State	runState
Created Programmatically	trait	Was this queue created programmatically? If Yes, the queue will not survive a restart of the application server. If No, the queue was created via a deployment XML file.	createdProgrammatically
Message Counter History Day Limit	trait	This queue's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count	messageCounterHistoryDayLimit
Consumer Count	measurement	The number of consumers on the queue	consumerCount
Delivering Count	measurement	The number of messages currently being delivered	deliveringCount
Message Count	measurement	The number of messages in the queue	messageCount
Scheduled Message Count	measurement	The number of scheduled messages in the queue	scheduledMessageCount
Count	measurement	The total message count since startup or last counter reset	messageStatistics.count
Count Delta	measurement	The message count delta since last method call	messageStatistics.countDelta
Depth	measurement	The current message count of pending messages within the queue waiting for dispatch	messageStatistics.depth
Depth Delta	measurement	The message count delta of pending messages since last method call	messageStatistics.depthDelta
Time Last Update	measurement	The timestamp of the last message add	messageStatistics.timeLastUpdate
Clustered	trait	True if this queue is clustered, false otherwise	clustered

Note

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

Configuration Properties

Table 3.133.
Name	Description	Required	Internal Name
Name	The name of this queue (e.g. 'MyQueue').	yes	name
JNDI Name	This queue's JNDI name (e.g. '/queue/MyQueue').	yes	JNDIName
Clustered	Is this queue clustered? For an existing queue, this property is read-only. If not specified when creating a new queue, the default value is false.	no	clustered
Down Cache Size	When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000.	no	downCacheSize
Full Size	The maximum number of messages for the queue held in memory at any one time. The actual queue can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the queue has been restarted. The default value is 200000.	no	fullSize
Max Delivery Attempts	The number of delivery attempts before a message to a subscriber of this queue is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used.	no	maxDeliveryAttempts
Max Size	The maximum number of messages this queue can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1.	no	maxSize
Page Size	When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000.	no	pageSize
Redelivery Delay	The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used.	no	redeliveryDelay
DLQ	The JMX ObjectName of the dead letter queue (DLQ) for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer.	no	DLQ
Expiry Queue	The JMX ObjectName of the expiry queue for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer.	no	expiryQueue
Server Peer	The JMX ObjectName of the server peer this queue was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the queue has been restarted.	no	serverPeer
Security Configurations	This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute.	yes	securityConfig

Note

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

Operations

Table 3.134. Metrics
Name	Description
Remove All Messages	Remove all messages from the destination.
Start	Start the destination.
Stop	Stop the destination.
List All Messages	List all messages for the specified selector
List Durable Messages	List all durable messages for the specified selector
List Non Durable Messages	List all non durable messages for the specified selector
List Message Counter As HTML	Get the message counter as HTML
List Message Counter History As HTML	Get the message counter history as HTML
Reset Message Counter	Reset the message counter
Reset Message Counter History	Reset the message counter history

Package Types

none

3.2.1.7.2. JBossAS5 - Topic Service

Overview

Table 3.135. Overview
Description:	a JMS topic
Singleton:	no
Plugin:	JBossAS5

Note

Child Resource Types

none

Connection Properties

Table 3.136.
Name	Description	Required	Internal Name
Jms Type		yes	jms-type
Custom Properties	Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties.	no	customProperties
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Template Name		yes	templateName
Component Name Property	The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type.	yes	componentNameProperty

Note

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

Metrics

Table 3.137. Metrics
Name	Type	Description	Internal Name
Run State	trait	Run State	runState
Created Programmatically	trait	Was this topic created programmatically? If Yes, the topic will not survive a restart of the application server. If No, the topic was created via a deployment XML file.	createdProgrammatically
Message Counter History Day Limit	trait	This topic's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count	messageCounterHistoryDayLimit
All Message Count	measurement	The count of all messages in all subscriptions to this topic	allMessageCount
All Subscriptions Count	measurement	The count of all subscriptions to this topic	allSubscriptionsCount
Durable Message Count	measurement	The count of all messages for all durable subscriptions to this topic	durableMessageCount
Durable Subscriptions Count	measurement	The count of all durable subscriptions to this topic	durableSubscriptionsCount
Non Durable Message Count	measurement	The count of all messages in all non durable subscriptions to this topic	nonDurableMessageCount
Non Durable Subscriptions Count	measurement	The count of all non durable subscriptions to this topic	nonDurableSubscriptionsCount
Clustered	trait	True if this topic is clustered, false otherwise	clustered

Note

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

Configuration Properties

Table 3.138.
Name	Description	Required	Internal Name
Name	The name of this topic (e.g. 'MyTopic').	yes	name
JNDI Name	This topic's JNDI name (e.g. '/topic/MyTopic')	yes	JNDIName
Clustered	Is this topic clustered? For an existing topic, this property is read-only. If not specified when creating a new topic, the default value is false.	no	clustered
Down Cache Size	When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000.	no	downCacheSize
Full Size	The maximum number of messages held by the topic subscriptions in memory at any one time. The actual subscription can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the topic has been restarted. The default value is 200000.	no	fullSize
Max Delivery Attempts	The number of delivery attempts before a message to a subscriber of this topic is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used.	no	maxDeliveryAttempts
Max Size	The maximum number of messages this topic can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1.	no	maxSize
Page Size	When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000.	no	pageSize
Redelivery Delay	The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used.	no	redeliveryDelay
DLQ	The JMX ObjectName of the dead letter queue (DLQ) for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer.	no	DLQ
Expiry Queue	The JMX ObjectName of the expiry queue for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer.	no	expiryQueue
Server Peer	The JMX ObjectName of the server peer this topic was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the topic has been restarted.	no	serverPeer
Security Configurations	This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute.	yes	securityConfig

Note

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

Operations

Table 3.139. Metrics
Name	Description
Remove All Messages	Remove all messages from the destination.
Start	Start the destination.
Stop	Stop the destination.
List All Messages	List all messages for the specified subscription with the specified selector
List Durable Messages	List all durable messages for the specified subscription with the specified selector
List Non Durable Messages	List all non durable messages for the specified subscription with the specified selector
List All Subscriptions	Return all subscriptions for the topic
List All Subscriptions As HTML	Return all subscriptions for the topic as HTML
List Durable Subscriptions	Return all durable subscriptions for the topic
List Durable Subscriptions As HTML	Return all durable subscriptions for the topic as HTML
List Non-Durable Subscriptions	Return all non-durable subscriptions for the topic
List Non-Durable Subscriptions As HTML	Return all non-durable subscriptions for the topic as HTML

Package Types

none

3.2.1.8. JBossAS5 - Enterprise Application (EAR) Service

Overview

Table 3.140. Overview
Description:	JEE enterprise application (EAR)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.141.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this EAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.142. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this EAR file or directory	custom.path
Exploded?	trait	whether this EAR is deployed exploded (i.e. as a directory)	custom.exploded

Note

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

Configuration Properties

none

Operations

Table 3.143. Metrics
Name	Description
Start	starts this EAR
Stop	stops this EAR
Restart	stops and then restarts this EAR

Package Types

Table 3.144. Package Types
Name	Category	Description
EAR File	Deployable

3.2.1.9. JBossAS5 - Web Application (WAR) Service

Overview

Table 3.145. Overview
Description:	a standalone web application (WAR)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.9.1, “JBossAS5 - Web Application Context Service”

Connection Properties

Table 3.146.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this WAR	yes	deploymentKey
Context Path	this WAR's context path (e.g. /admin-console)	no	contextPath
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.147. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this WAR file or directory	custom.path
Exploded?	trait	whether this WAR is deployed exploded (i.e. as a directory)	custom.exploded
Context Root	trait	this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR	contextRoot
Virtual Hosts	trait	the virtual host(s) to which this WAR is deployed	virtualHosts

Note

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

Configuration Properties

none

Operations

Table 3.148. Metrics
Name	Description
Start	starts this WAR
Stop	stops this WAR
Restart	stops and then restarts this WAR

Package Types

Table 3.149. Package Types
Name	Category	Description
WAR File	Deployable

3.2.1.9.1. JBossAS5 - Web Application Context Service

Overview

Table 3.150. Overview
Description:	a web application context
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.151.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Virtual Host	this WAR's virtual host (e.g. localhost)	yes	virtualHost

Note

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

Metrics

Table 3.152. Metrics
Name	Type	Description	Internal Name
Clustered	trait	True if this web application context is clustered	clustered
Virtual Host	trait	the virtual host with which this context is associated	virtualHost
Response Time	calltime	the minimum, maximum, and average response times for requests serviced by this webapp	responseTime
Currently Active Sessions	measurement	the number of sessions that are currently active for this WAR	activeSessions
Maximum Active Sessions	measurement	the maximum number of sessions that have been active for this WAR	maxActive
Created Sessions	measurement	the number of sessions created for this WAR	sessionCounter
Created Sessions per Minute	measurement	the number of sessions created for this WAR	sessionCounter
Expired Sessions	measurement	the number of expired sessions for this WAR	expiredSessions
Expired Sessions per Minute	measurement	the number of expired sessions for this WAR	expiredSessions
Rejected Sessions	measurement	the number of sessions rejected for this WAR	rejectedSessions
Rejected Sessions per Minute	measurement	the number of sessions rejected for this WAR	rejectedSessions
Average Session Alive Time	measurement	the average alive time of sessions for this WAR	sessionAverageAliveTime
Max Session Alive Time	measurement	the maximum alive time of sessions for this WAR	sessionMaxAliveTime
Minimum Response Time	measurement	the minimum response time for requests serviced by this WAR	Servlet.minimumResponseTime
Average Response Time	measurement	the average response time for requests serviced by this WAR	Servlet.averageResponseTime
Maximum Response Time	measurement	the maximum response time for requests serviced by this WAR	Servlet.maximumResponseTime
Total Response Time	measurement	the total response time for requests serviced by this WAR	Servlet.totalResponseTime
Total Response Time per Minute	measurement	the total response time for requests serviced by this WAR	Servlet.totalResponseTime
Number of Requests Serviced	measurement	the number of requests serviced by this WAR	Servlet.requestCount
Number of Requests Serviced per Minute	measurement	the number of requests serviced by this WAR	Servlet.requestCount
Number of Error Responses	measurement	the number of error responses sent by this WAR	Servlet.errorCount
Number of Error Responses per Minute	measurement	the number of error responses sent by this WAR	Servlet.errorCount

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.10. JBossAS5 - Embedded Web Application (WAR) Service

Overview

Table 3.153. Overview
Description:	an embedded web application (WAR)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.10.1, “JBossAS5 - Embedded Web Application Context Service”

Connection Properties

Table 3.154.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this WAR	yes	deploymentKey
Context Path	this WAR's context path (e.g. /admin-console	no	contextPath
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName
Embedded		yes	embedded

Note

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

Metrics

Table 3.155. Metrics
Name	Type	Description	Internal Name
Parent	trait	the name of this WAR's parent deployment	custom.parent
Context Root	trait	this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR	contextRoot
Virtual Hosts	trait	the virtual host(s) to which this WAR is deployed	virtualHosts

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.10.1. JBossAS5 - Embedded Web Application Context Service

Overview

Table 3.156. Overview
Description:	a web application context
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.157.
Name	Description	Required	Internal Name
Component Type		yes	componentType
Component Subtype		yes	componentSubtype
Component Name		yes	componentName
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Virtual Host	this WAR's virtual host (e.g. localhost)	yes	virtualHost

Note

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

Metrics

Table 3.158. Metrics
Name	Type	Description	Internal Name
Clustered	trait	True if this web application context is clustered	clustered
Virtual Host	trait	the virtual host with which this context is associated	virtualHost
Response Time	calltime	the minimum, maximum, and average response times for requests serviced by this webapp	responseTime
Currently Active Sessions	measurement	the number of sessions that are currently active for this WAR	activeSessions
Maximum Active Sessions	measurement	the maximum number of sessions that have been active for this WAR	maxActive
Created Sessions	measurement	the number of sessions created for this WAR	sessionCounter
Created Sessions per Minute	measurement	the number of sessions created for this WAR	sessionCounter
Expired Sessions	measurement	the number of expired sessions for this WAR	expiredSessions
Expired Sessions per Minute	measurement	the number of expired sessions for this WAR	expiredSessions
Rejected Sessions	measurement	the number of sessions rejected for this WAR	rejectedSessions
Rejected Sessions per Minute	measurement	the number of sessions rejected for this WAR	rejectedSessions
Average Session Alive Time	measurement	the average alive time of sessions for this WAR	sessionAverageAliveTime
Max Session Alive Time	measurement	the maximum alive time of sessions for this WAR	sessionMaxAliveTime
Minimum Response Time	measurement	the minimum response time for requests serviced by this WAR	Servlet.minimumResponseTime
Average Response Time	measurement	the average response time for requests serviced by this WAR	Servlet.averageResponseTime
Maximum Response Time	measurement	the maximum response time for requests serviced by this WAR	Servlet.maximumResponseTime
Total Response Time	measurement	the total response time for requests serviced by this WAR	Servlet.totalResponseTime
Total Response Time per Minute	measurement	the total response time for requests serviced by this WAR	Servlet.totalResponseTime
Number of Requests Serviced	measurement	the number of requests serviced by this WAR	Servlet.requestCount
Number of Requests Serviced per Minute	measurement	the number of requests serviced by this WAR	Servlet.requestCount
Number of Error Responses	measurement	the number of error responses sent by this WAR	Servlet.errorCount
Number of Error Responses per Minute	measurement	the number of error responses sent by this WAR	Servlet.errorCount

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.11. JBossAS5 - EJB2 JAR Service

Overview

Table 3.159. Overview
Description:	a standalone EJB 2.x application
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.11.1, “JBossAS5 - EJB2 Stateless Session Bean Service”
Section 3.2.1.11.2, “JBossAS5 - EJB2 Stateful Session Bean Service”
Section 3.2.1.11.3, “JBossAS5 - EJB2 Message-Driven Bean Service”
Section 3.2.1.11.4, “JBossAS5 - EJB2 Entity Bean Service”

Connection Properties

Table 3.160.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this EJB JAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.161. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this EJB JAR file or directory	custom.path
Exploded?	trait	whether this EJB JAR is deployed exploded (i.e. as a directory)	custom.exploded

Note

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

Configuration Properties

none

Operations

Table 3.162. Metrics
Name	Description
Start	starts this EJB JAR
Stop	stops this EJB JAR
Restart	stops and then restarts this EJB JAR

Package Types

Table 3.163. Package Types
Name	Category	Description
EJB JAR File	Deployable

3.2.1.11.1. JBossAS5 - EJB2 Stateless Session Bean Service

Overview

Table 3.164. Overview
Description:	An EJB2 Stateless Session Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.165.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.166. Metrics
Name	Type	Description	Internal Name
Create Count	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Remove Count	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 3.167. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.11.2. JBossAS5 - EJB2 Stateful Session Bean Service

Overview

Table 3.168. Overview
Description:	An EJB2 Stateful Session Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.169.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.170. Metrics
Name	Type	Description	Internal Name
Create Count	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Remove Count	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime
Passive Beans	measurement	The count of beans in the passivated state	PassivatedCount

Note

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

Configuration Properties

none

Operations

Table 3.171. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.11.3. JBossAS5 - EJB2 Message-Driven Bean Service

Overview

Table 3.172. Overview
Description:	An EJB2 Message Driven Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.173.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName

Note

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

Metrics

Table 3.174. Metrics
Name	Type	Description	Internal Name
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Message Count	measurement	The number of messages sent/received	MessageCount
Message Count per Minute	measurement	The number of messages sent/received	MessageCount

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.11.4. JBossAS5 - EJB2 Entity Bean Service

Overview

Table 3.175. Overview
Description:	An EJB2 Entity Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.176.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName

Note

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

Metrics

Table 3.177. Metrics
Name	Type	Description	Internal Name
Create Count	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Remove Count	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Cache Size	measurement	Cache Size	CacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.12. JBossAS5 - Embedded EJB2 JAR Service

Overview

Table 3.178. Overview
Description:	an embedded EJB 2.x application
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.12.1, “JBossAS5 - EJB2 Stateless Session Bean (Embedded) Service”
Section 3.2.1.12.2, “JBossAS5 - EJB2 Stateful Session Bean (Embedded) Service”
Section 3.2.1.12.3, “JBossAS5 - EJB2 Message-Driven Bean (Embedded) Service”
Section 3.2.1.12.4, “JBossAS5 - EJB2 Entity Bean (Embedded) Service”

Connection Properties

Table 3.179.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this EJB JAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.180. Metrics
Name	Type	Description	Internal Name
Parent	trait	the name of this EJB JAR's parent deployment	custom.parent

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.12.1. JBossAS5 - EJB2 Stateless Session Bean (Embedded) Service

Overview

Table 3.181. Overview
Description:	An EJB2 Stateless Session Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.182.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.183. Metrics
Name	Type	Description	Internal Name
Create Count	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Remove Count	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 3.184. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.12.2. JBossAS5 - EJB2 Stateful Session Bean (Embedded) Service

Overview

Table 3.185. Overview
Description:	An EJB2 Stateful Session Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.186.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.187. Metrics
Name	Type	Description	Internal Name
Create Count	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Remove Count	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime
Passive Beans	measurement	The count of beans in the passivated state	PassivatedCount

Note

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

Configuration Properties

none

Operations

Table 3.188. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.12.3. JBossAS5 - EJB2 Message-Driven Bean (Embedded) Service

Overview

Table 3.189. Overview
Description:	An EJB2 Message Driven Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.190.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName

Note

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

Metrics

Table 3.191. Metrics
Name	Type	Description	Internal Name
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Message Count	measurement	The number of messages sent/received	MessageCount
Message Count per Minute	measurement	The number of messages sent/received	MessageCount

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.12.4. JBossAS5 - EJB2 Entity Bean (Embedded) Service

Overview

Table 3.192. Overview
Description:	An EJB2 Entity Bean
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.193.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName

Note

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

Metrics

Table 3.194. Metrics
Name	Type	Description	Internal Name
Create Count	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Create Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been created since server start.	CreateCount
Remove Count	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Remove Count per Minute	measurement	The number of instances of this EJB2 Session Bean that have been removed since server start.	RemoveCount
Current Pool Size	measurement	The number of beans in the pool.	CurrentPoolSize
Max Pool Size	measurement	The maximum pool size.	MaxPoolSize
Cache Size	measurement	Cache Size	CacheSize

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.13. JBossAS5 - EJB3 JAR Service

Overview

Table 3.195. Overview
Description:	a standalone EJB 3.x application
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.13.1, “JBossAS5 - EJB3 Stateless Session Bean Service”
Section 3.2.1.13.2, “JBossAS5 - EJB3 Stateful Session Bean Service”
Section 3.2.1.13.3, “JBossAS5 - EJB3 Message-Driven Bean Service”

Connection Properties

Table 3.196.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this EJB JAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.197. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this EJB JAR file or directory	custom.path
Exploded?	trait	whether this EJB JAR is deployed exploded (i.e. as a directory)	custom.exploded

Note

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

Configuration Properties

none

Operations

Table 3.198. Metrics
Name	Description
Start	starts this EJB JAR
Stop	stops this EJB JAR
Restart	stops and then restarts this EJB JAR

Package Types

Table 3.199. Package Types
Name	Category	Description
EJB JAR File	Deployable

3.2.1.13.1. JBossAS5 - EJB3 Stateless Session Bean Service

Overview

Table 3.200. Overview
Description:	An EJB3 Stateless Session Bean (SLSB)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.201.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.202. Metrics
Name	Type	Description	Internal Name
EJB Name	trait	the name of this EJB	name
Available Count	measurement	The number of pooled instances of this EJB3 Session Bean in the method-ready state	availableCount
Create Count	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Create Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Current Count	measurement	The total number of currently pooled instances of this EJB3 Session Bean	currentSize
Max Size	measurement	The maximum number of instances that are allowed to be pooled	maxSize
Remove Count	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Remove Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 3.203. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.13.2. JBossAS5 - EJB3 Stateful Session Bean Service

Overview

Table 3.204. Overview
Description:	An EJB3 Stateful Session Bean (SFSB)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.205.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.206. Metrics
Name	Type	Description	Internal Name
EJB Name	trait	the name of this EJB	name
Available Count	measurement	The number of pooled instances of this EJB3 Session Bean in the method-ready state	availableCount
Create Count	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Create Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Current Count	measurement	The total number of currently pooled instances of this EJB3 Session Bean	currentSize
Max Size	measurement	The maximum number of instances that are allowed to be pooled	maxSize
Remove Count	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Remove Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime
Cache Size	measurement	Cache Size	cacheSize
Passivated Count	measurement	Passivated Count	passivatedCount
Total Size	measurement	Total Size	totalSize

Note

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

Configuration Properties

none

Operations

Table 3.207. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.13.3. JBossAS5 - EJB3 Message-Driven Bean Service

Overview

Table 3.208. Overview
Description:	An EJB3 Message-Driven Bean (MDB)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.209.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.210. Metrics
Name	Type	Description	Internal Name
EJB Name	trait	the name of this EJB	name
Minimum Pool Size	measurement	Minimum Pool Size	minPoolSize
Maximum Pool Size	measurement	Maximum Pool Size	maxPoolSize
Maximum number of Messages	measurement	Maximum number of Messages	maxMessages

Note

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

Configuration Properties

none

Operations

Table 3.211. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.14. JBossAS5 - Embedded EJB3 JAR Service

Overview

Table 3.212. Overview
Description:	an embedded EJB 3.x application
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.14.1, “JBossAS5 - EJB3 Stateless Session Bean (Embedded) Service”
Section 3.2.1.14.2, “JBossAS5 - EJB3 Stateful Session Bean (Embedded) Service”
Section 3.2.1.14.3, “JBossAS5 - EJB3 Message-Driven Bean (Embedded) Service”

Connection Properties

Table 3.213.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this EJB JAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.214. Metrics
Name	Type	Description	Internal Name
Parent	trait	the name of this EJB JAR's parent deployment	custom.parent

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.14.1. JBossAS5 - EJB3 Stateless Session Bean (Embedded) Service

Overview

Table 3.215. Overview
Description:	An EJB3 Stateless Session Bean (SLSB)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.216.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.217. Metrics
Name	Type	Description	Internal Name
EJB Name	trait	the name of this EJB	name
Available Count	measurement	The number of pooled instances of this EJB3 Session Bean in the method-ready state	availableCount
Create Count	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Create Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Current Count	measurement	The total number of currently pooled instances of this EJB3 Session Bean	currentSize
Max Size	measurement	The maximum number of instances that are allowed to be pooled	maxSize
Remove Count	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Remove Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime

Note

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

Configuration Properties

none

Operations

Table 3.218. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.14.2. JBossAS5 - EJB3 Stateful Session Bean (Embedded) Service

Overview

Table 3.219. Overview
Description:	An EJB3 Stateful Session Bean (SFSB)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.220.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.221. Metrics
Name	Type	Description	Internal Name
EJB Name	trait	the name of this EJB	name
Available Count	measurement	The number of pooled instances of this EJB3 Session Bean in the method-ready state	availableCount
Create Count	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Create Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been created since server start	createCount
Current Count	measurement	The total number of currently pooled instances of this EJB3 Session Bean	currentSize
Max Size	measurement	The maximum number of instances that are allowed to be pooled	maxSize
Remove Count	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Remove Count per Minute	measurement	The number of instances of this EJB3 Session Bean that have been removed since server start	removeCount
Method Invocation Time	calltime	The minimum, maximum, and average invocation times for each of the methods exposed by this EJB	methodInvocationTime
Cache Size	measurement	Cache Size	cacheSize
Passivated Count	measurement	Passivated Count	passivatedCount
Total Size	measurement	Total Size	totalSize

Note

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

Configuration Properties

none

Operations

Table 3.222. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.14.3. JBossAS5 - EJB3 Message-Driven Bean (Embedded) Service

Overview

Table 3.223. Overview
Description:	An EJB3 Message-Driven Bean (MDB)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.224.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName
Invocation Stats Property Name	yes	invocationStatsPropertyName

Note

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

Metrics

Table 3.225. Metrics
Name	Type	Description	Internal Name
EJB Name	trait	the name of this EJB	name
Minimum Pool Size	measurement	Minimum Pool Size	minPoolSize
Maximum Pool Size	measurement	Maximum Pool Size	maxPoolSize
Maximum number of Messages	measurement	Maximum number of Messages	maxMessages

Note

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

Configuration Properties

none

Operations

Table 3.226. Metrics
Name	Description
View Method Statistics	Display detailed method invocation statistics.

Package Types

none

3.2.1.15. JBossAS5 - Resource Adapter Archive (RAR) Service

Overview

Table 3.227. Overview
Description:	a standalone JCA resource adapter archive (RAR)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.228.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this RAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.229. Metrics
Name	Type	Description	Internal Name
Path	trait	the absolute path of this RAR file or directory	custom.path
Exploded?	trait	whether this RAR is deployed exploded (i.e. as a directory)	custom.exploded

Note

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

Configuration Properties

none

Operations

Table 3.230. Metrics
Name	Description
Start	starts this RAR
Stop	stops this RAR
Restart	stops and then restarts this RAR

Package Types

Table 3.231. Package Types
Name	Category	Description
RAR File	Deployable

3.2.1.16. JBossAS5 - Embedded Resource Adapter Archive (RAR) Service

Overview

Table 3.232. Overview
Description:	an embedded JCA resource adapter archive (RAR)
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.233.
Name	Description	Required	Internal Name
Deployment Key	The profile service key for this RAR	yes	deploymentKey
Extension		yes	extension
Description Template		yes	descriptionTemplate
Deployment Type Name	The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type.	yes	deploymentTypeName

Note

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

Metrics

Table 3.234. Metrics
Name	Type	Description	Internal Name
Parent	trait	the name of this RAR's parent deployment	custom.parent

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.2.1.17. JBossAS5 - Script Service

Overview

Table 3.235. Overview
Description:	provides the ability to execute a script that performs some task related to its parent JBossAS server
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

Table 3.236.
Name	Description	Required	Internal Name
Path	the absolute path to the script file	yes	path
Environment Variables	the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties	no	environmentVariables

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 3.237. Metrics
Name	Description
Execute Script	execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory tab)

Package Types

Table 3.238. Package Types
Name	Category	Description
Executable Script	Executable Script	This is the script file to be uploaded to the server's bin directory.

3.2.1.18. JBossAS5 - Service Binding Manager Service

Overview

Table 3.239. Overview
Description:	The Service Binding Manager manages the ports of the deployed services
Singleton:	yes
Plugin:	JBossAS5

Child Resource Types

Section 3.2.1.18.1, “JBossAS5 - Service Binding Set Service”

Connection Properties

Table 3.240.
Name	Required	Internal Name
Component Type	yes	componentType
Component Subtype	yes	componentSubtype
Component Name	yes	componentName

Note

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

Metrics

Table 3.241. Metrics
Name	Type	Description	Internal Name
Active Binding Set	trait	The active binding set used to obtain port bindings from.	activeBindingSetName

Note

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

Configuration Properties

Table 3.242.
Name	Description	Required	Internal Name
Active Binding Set Name	The name of the binding set the Service Binding Manager should use when resolving bindings. Note to JBoss ON or Jopr users (does not apply to JBoss AS admin console): CHANGING THIS PROPERTY IS POTENTIALLY DANGEROUS because if there are any port conflicts on the machine the Application Server is running on, the server will not start up again and it will not be possible to monitor it. To be able to monitor the server again after the restart you have to update the "Naming Provider Url" in the "Connection" subtab in the "Inventory" of the Application Server to the value of "jboss:service=Naming:Port" binding of the active binding set. I.e. if the "jboss:service=Naming:Port" binding of the active binding set has the port set to 4099 and hostname to 127.0.0.1, you have to set the "Naming Provider Url" to jnp://127.0.0.1:4099.	yes	activeBindingSetName
Standard Bindings	The standard port bindings inherited by the binding sets.	yes	standardBindings

Note

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

Operations

none

Package Types

none

3.2.1.18.1. JBossAS5 - Service Binding Set Service

Overview

Table 3.243. Overview
Description:	The Service Binding Set defines all bindings of a profile. It inherits the standard bindings from the Service Binding Manager and defines a port offset and overridden and additional bindings.
Singleton:	no
Plugin:	JBossAS5

Child Resource Types

none

Connection Properties

none

Metrics

Table 3.244. Metrics
Name	Type	Description	Internal Name
Name	trait	The name of this binding set.	name
Default Host Name	trait	The default host name of this binding set.	defaultHostName
Port Offset	trait	The port offset of this binding set.	portOffset

Note

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

Configuration Properties

Table 3.245.
Name	Description	Required	Internal Name
Name	The name of this binding set.	yes	name
Default Host Name	The host name that should be used for all bindings whose configuration does not specify "fixed host name".	yes	defaultHostName
Port Offset	A value to add to the port configuration for a standard binding to derive the port to use in this binding set. This doesn't apply to standard bindings defined as 'fixed port'.	yes	portOffset
Override Bindings	The binding configurations that apply only to this binding set, either non-standard bindings or ones that override standard binding configurations. The binding set inherits the standard bindings from the Service Binding Manager, applies the port offset to them (unless the standard binding is defined as "fixed port"), and appends the override bindings. These can either redefine a standard binding or define a brand new binding. The standard bindings and the override bindings then define the full set of the bindings that are defined by the binding set.	yes	overrideBindings

Note

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

Operations

Table 3.246. Metrics
Name	Description
Display Bindings	Displays the full set of bindings as they would look if this bindings set was active.

Package Types

none

3.3. Red Hat JBoss Enterprise Application Platform 6.x (EAP 6) and JBoss Application Server 7.x Plugin

Table 3.247. Basic Details
Internal Name:	JBossAS7
Description:	provides monitoring and management of JBossAS 7.x and JBoss EAP/JDG 6.x
Version:	4.4.0

Top-Level Resource Types

Section 3.3.2, “JBossAS7 - Host Controller Server”
Section 3.3.1, “JBossAS7 - Standalone Server”
Section 3.3.3, “JBossAS7 - Wildfly/JBoss EAP Patch Handler Service”

3.3.1. JBossAS7 - Standalone Server

Overview

Table 3.248. Overview
Description:	Standalone AS7 server
Singleton:	no
Plugin:	JBossAS7

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 JBossAS7 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

Section 3.3.1.1, “JBossAS7 - ModCluster Standalone Service”
Section 3.3.1.2, “JBossAS7 - JVM Service”
Section 3.3.1.3, “JBossAS7 - JBossWeb Service”
Section 3.3.1.4, “JBossAS7 - General JCA connectors Service”
Section 3.3.1.5, “JBossAS7 - Datasources (Standalone) Service”
Section 3.3.1.6, “JBossAS7 - Logging Service”
Section 3.3.1.7, “JBossAS7 - Webservices Service”
Section 3.3.1.8, “JBossAS7 - Naming Service”
Section 3.3.1.9, “JBossAS7 - Transactions Subsystem (Standalone) Service”
Section 3.3.1.10, “JBossAS7 - Network Interface Service”
Section 3.3.1.11, “JBossAS7 - SocketBindingGroup Service”
Section 3.3.1.12, “JBossAS7 - Deployment Service”
Section 3.3.1.13, “JBossAS7 - DeploymentScanner Service”
Section 3.3.1.14, “JBossAS7 - JacORB Service”
Section 3.3.1.15, “JBossAS7 - JDR Service”
Section 3.3.1.16, “JBossAS7 - JCA Service”
Section 3.3.1.17, “JBossAS7 - JAXR Service”
Section 3.3.1.18, “JBossAS7 - JPA Service”
Section 3.3.1.19, “JBossAS7 - CMP Service”
Section 3.3.1.20, “JBossAS7 - EE Service”
Section 3.3.1.21, “JBossAS7 - Security Service”
Section 3.3.1.22, “JBossAS7 - Threads Service”
Section 3.3.1.23, “JBossAS7 - EJB3 Service”
Section 3.3.1.24, “JBossAS7 - JMX Service”
Section 3.3.1.25, “JBossAS7 - Resource Adapters Service”
Section 3.3.1.26, “JBossAS7 - Infinispan Service”
Section 3.3.1.27, “JBossAS7 - JGroups Service”
Section 3.3.1.28, “JBossAS7 - Remoting Service”
Section 3.3.1.29, “JBossAS7 - Osgi Service”
Section 3.3.1.30, “JBossAS7 - Mail Service”
Section 3.3.1.31, “JBossAS7 - Messaging Service”

Autodiscovery Process Scans

Table 3.249. Metrics
Name	Query
StandaloneAS	process\|basename\|match=^java.,arg\|org.jboss.as.standalone\|match=.

Connection Properties

Table 3.250.
Name	Description	Required	Internal Name
Start Script Path	The 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 Prefix	A 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 Variables	The 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 Arguments	The 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_OPTS	Property 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
Native Host	Native management API host	yes	nativeHost
Native Port	Native management API port	yes	nativePort
Native Local Authentication	Specifies 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 Strategy	Defines 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 Verification	Defines 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
Truststore	Path to a truststore file. If undefined, the JVM default truststore is used.	no	truststore
Truststore Type	Truststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats.	no	truststoreType
Truststore Password	Password protecting the truststore file.	no	truststorePassword
Client Certificate Authentication		yes	clientcertAuthentication
Keystore	Path to a keystore file. Required when Client Certificate Authentication is on.	no	keystore
Keystore Type	Keystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats.	no	keystoreType
Keystore Password	Password protecting the keystore file.	no	keystorePassword
Key Password	Password protecting the secret key in the keystore file.	no	keyPassword
Hostname		yes	hostname
Port		yes	port
Secure	Encrypted transport indicator	yes	secure
User	Management user for a secured AS	no	user
Password	Password for the management user	no	password
Management Connection Timeout	Maximum 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 Directory	Root directory of the server installation	no	homeDir
Base Directory	Base directory for server content	no	baseDir
Configuration Directory	Base configuration directory	no	configDir
Log Directory	the directory where log files will be written for this server	no	logDir
Product Type	Server product type (e.g. AS or EAP)	no	productType
Supports Patching	Whether this EAP server supports patching. This should be automatically deduced by the agent. It is highly recommended to leave this with the discovered value. However, you will need to manually update this value if you manually upgrade your server from a version that does not support patching to a version that does.	yes	supportsPatching

Note

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

Metrics

Table 3.251. Metrics
Name	Type	Description	Internal Name
Number of management requests	measurement	Number of requests sent to the controller	_internal:mgmtRequests
Number of management requests per Minute	measurement	Number of requests sent to the controller	_internal:mgmtRequests
Time used for management requests	measurement	Total time for requests	_internal:requestTime
Time used for management requests per Minute	measurement	Total time for requests	_internal:requestTime
Maximum request time	measurement	Max time for a request since last metric get	_internal:maxTime
Server State	trait	Detailed server state	server-state
Server Code Name	trait	Server Code Name	_skm:release-codename
Server Version	trait	Server Version	_skm:release-version
Product Name	trait	Product Name	_skm:product-name
Product Version	trait	Product Version	_skm:product-version
Server Start Time	trait	Server Start Time	startTime
JGroups Multicast Address	trait	the host and port used by JGroups for multicast	multicastAddress
Server Config File	trait	The name of the server configuration file this server is using	config-file
Deploy Directory	trait	The deployment directory for file based bundles (usually 'standalone/deployments')	deployDir
Temporary Directory	trait	The temporary directory (usually 'standalone/tmp'). May serve as deployment directory for handover only bundles'	temp-dir
Active Patches	trait	The 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.252.
Name	Description	Required	Internal Name
Properties		no	*2
Path	The 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 Dir	The base directory for JBoss Application Server.	yes	base-dir
Config Dir	The directory where the configurations are stored.	yes	config-dir
Config File	The configuration file used to launch JBoss Application Server.	yes	config-file
Content Dir	The directory where user content (e.g. deployments) that is managed by the server is stored.	yes	content-dir
Data Dir	The data directory.	yes	data-dir
Deploy Dir	Deprecated variant of 'content-dir'.	yes	deploy-dir
Ext Dirs	A list of ext directories.	yes	ext-dirs
Home Dir	The home directory for JBoss Application Server.	yes	home-dir
Host Name	The host name.	yes	host-name
Initial Running Mode	The 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 Type	The type of the running server.	yes	launch-type
Log Dir	The directory where log files are sent.	yes	log-dir
Modules Dir	The directory where modules are found.	yes	modules-dir
Node Name	The name of the server node.	yes	node-name
Qualified Host Name	The qualified host name.	yes	qualified-host-name
Server Name	The name of the server.	yes	server-name
Temp Dir	The temporary directory.	yes	temp-dir

Note

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

Operations

Table 3.253. Metrics
Name	Description
Reload	Make the server re-load the (changed) configuration. To load a different startup config use 'restart'
Start	Start the server by invoking its start script
Restart	Restart the server by shutting it down and invoking its start script
Shutdown	Shut down the server.
Install RHQ user	Installs a user in the server for management
Execute CLI commands	Executes command via jboss-cli
Execute CLI script	Executes script via jboss-cli
Setup CLI	Setup 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.3.1.1. JBossAS7 - ModCluster Standalone Service

Overview

Table 3.254. Overview
Description:	Mod_cluster support
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.1.1, “JBossAS7 - Service Configuration Service”

Connection Properties

Table 3.255.
Name	Description	Required	Internal 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.256. Metrics
Name	Description
Add Proxy	Add the proxy to the list of httpd connected to the node.
List Proxies	Read the list of httpd connected to the node.
Read Proxies Configuration	Send a DUMP to httpd and display the result.
Read Proxies Info	Send a INFO to httpd and display the result.
Refresh	Refresh the node sending a new CONFIG message to Apache httpd.
Remove Proxy	Remove the proxy to the list of httpd connected to the node.
Reset	Reset the node connection to Apache httpd.

Package Types

none

3.3.1.1.1. JBossAS7 - Service Configuration Service

Overview

Table 3.257. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.1.1.1, “JBossAS7 - Dynamic Load Provider Service”
Section 3.3.1.1.1.2, “JBossAS7 - Ssl Service”

Connection Properties

Table 3.258.
Name	Description	Required	Internal 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.259.
Name	Description	Required	Internal Name
Proxy List	List of proxies, Format (hostname:port) separated with commas.	no	proxy-list
Proxy Url	Base URL for MCMP requests.	no	proxy-url
Advertise Socket	Name of Socket binding to use for the Advertise socket.	no	advertise-socket
Advertise	Use Advertise logic or not.	no	advertise
Advertise Security Key	String containing the security key for the Advertise logic.	no	advertise-security-key
Balancer	The balancer name.	no	balancer
Connector	Name of the web connector used to communicate with the load balancer.	yes	connector
Load Balancing Group	loadBalancingGroup name.	no	load-balancing-group
Excluded Contexts	List of contexts mod_cluster should ignore, Format String separated with commas.	no	excluded-contexts
Auto Enable Contexts	Enable contexts even if disabled in mod_cluster_manger (httpd).	no	auto-enable-contexts
Sticky Session	Use sticky sessions for requests.	no	sticky-session
Sticky Session Remove	Remove session information on failover.	no	sticky-session-remove
Sticky Session Force	Don't failover a request with session information.	no	sticky-session-force
Worker Timeout	Timeout to wait in httpd for an available worker to process the requests.	no	worker-timeout
Max Attempts	Max attempts to process an idempotent request.	no	max-attempts
Flush Packets	Enables/disables packet flushing in httpd.	no	flush-packets
Flush Wait	Time to wait before flushing packets in httpd.	no	flush-wait
Ping	Time (in seconds) in which to wait for a pong answer to a ping.	no	ping
Smax	Soft maximum idle connection count in httpd	no	smax
Ttl	Time to live (in seconds) for idle connections above smax	no	ttl
Node Timeout	Timeout (in seconds) for proxy connections to a node.	no	node-timeout
Stop Context Timeout	Max time to wait for context to process pending requests.	no	stop-context-timeout
Socket Timeout	Timeout 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.260. Metrics
Name	Description
Add Custom Metric	Add new custom metric to the load balancer provider.
Add Metric	Add new metric to the load balancer provider.
Remove Custom Metric	Remove a custom metric from the load balancer provider.
Remove Metric	Add new metric to the load balancer provider.

Package Types

none

3.3.1.1.1.1. JBossAS7 - Dynamic Load Provider Service

Overview

Table 3.261. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.1.1.1.1, “JBossAS7 - Custom Load Metric Service”
Section 3.3.1.1.1.1.2, “JBossAS7 - Load Metric Service”

Connection Properties

Table 3.262.
Name	Description	Required	Internal 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.263.
Name	Description	Required	Internal Name
Decay	Decay. The default value is 2.	no	decay
History	History. 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.3.1.1.1.1.1. JBossAS7 - Custom Load Metric Service

Overview

Table 3.264. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.265.
Name	Description	Required	Internal 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.266.
Name	Description	Required	Internal Name
Capacity	Capacity of the metric. The default value is 1	no	capacity
Class	Class name of the custom metric.	yes	class
Weight	Weight 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.3.1.1.1.1.2. JBossAS7 - Load Metric Service

Overview

Table 3.267. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.268.
Name	Description	Required	Internal 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.269.
Name	Description	Required	Internal Name
Capacity	Capacity of the metric. The default value is 1.	no	capacity
Type	Type of the metric	yes	type
Weight	Weight 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.3.1.1.1.2. JBossAS7 - Ssl Service

Overview

Table 3.270. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.271.
Name	Description	Required	Internal 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.272.
Name	Description	Required	Internal Name
Ca Certificate File	Certificate authority.	no	ca-certificate-file
Ca Revocation Ur	Certificate authority revocation list.	no	ca-revocation-ur
Certificate Key File	Key file for the certificate.	no	certificate-key-file
Cipher Suite	The allowed cipher suite.	no	cipher-suite
Key Alias	The key alias.	no	key-alias
Password	Password.	no	password
Protocol	The 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.3.1.2. JBossAS7 - JVM Service

Overview

Table 3.273. Overview
Description:	Information about the underlying JVM
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.2.1, “JBossAS7 - Operating System Service”
Section 3.3.1.2.2, “JBossAS7 - Memory Service”
Section 3.3.1.2.3, “JBossAS7 - Runtime Service”
Section 3.3.1.2.4, “JBossAS7 - Threading Service”
Section 3.3.1.2.5, “JBossAS7 - Garbage Collector Service”
Section 3.3.1.2.6, “JBossAS7 - Memory Pool Service”

Connection Properties

Table 3.274.
Name	Description	Required	Internal 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.3.1.2.1. JBossAS7 - Operating System Service

Overview

Table 3.275. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.276.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.277. Metrics
Name	Type	Description	Internal Name
Available Processors	measurement	The number of processors available to the Java virtual machine.	available-processors
System Load Average	measurement	The 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.3.1.2.2. JBossAS7 - Memory Service

Overview

Table 3.278. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.279.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.280. Metrics
Name	Type	Description	Internal Name
Object Pending Finalization Count	measurement	The approximate number of objects for which finalization is pending.	object-pending-finalization-count
Initial heap usage	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	heap-memory-usage:init
Used heap	measurement	The amount of used memory in bytes.	heap-memory-usage:used
Committed heap	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	heap-memory-usage:committed
Maximum heap usage	measurement	The maximum amount of memory in bytes that can be used for memory management.	heap-memory-usage:max
Initial non-heap usage	measurement	The 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 memory	measurement	The amount of used memory in bytes.	non-heap-memory-usage:used
Committed non-heap memory	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	non-heap-memory-usage:committed
Maximum non-heap usage	measurement	The 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.281. Metrics
Name	Description
Trigger GC	Runs the garbage collector.

Package Types

none

3.3.1.2.3. JBossAS7 - Runtime Service

Overview

Table 3.282. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.283.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.284. Metrics
Name	Type	Description	Internal Name
Uptime	measurement	The 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.3.1.2.4. JBossAS7 - Threading Service

Overview

Table 3.285. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.286.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.287. Metrics
Name	Type	Description	Internal Name
Thread Count	measurement	The current number of live threads including both daemon and non-daemon threads.	thread-count
Peak Thread Count	measurement	The peak live thread count since the Java virtual machine started or peak was reset.	peak-thread-count
Total Started Thread Count	measurement	The total number of threads created and also started since the Java virtual machine started.	total-started-thread-count
Daemon Thread Count	measurement	The current number of live daemon threads.	daemon-thread-count
Current Thread Cpu Time	measurement	The 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 Time	measurement	The 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.288.
Name	Description	Required	Internal Name
Thread Contention Monitoring Enabled	Whether thread contention monitoring is enabled.	no	thread-contention-monitoring-enabled
Thread Cpu Time Enabled	Whether thread CPU time measurement is enabled.	no	thread-cpu-time-enabled
Thread Contention Monitoring Supported	Whether the Java virtual machine supports thread contention monitoring.	no	thread-contention-monitoring-supported
Thread Cpu Time Supported	Whether the Java virtual machine implementation supports CPU time measurement for any thread.	no	thread-cpu-time-supported
Current Thread Cpu Time Supported	Whether the Java virtual machine supports CPU time measurement for the current thread.	no	current-thread-cpu-time-supported
Object Monitor Usage Supported	Whether the Java virtual machine supports monitoring of object monitor usage.	no	object-monitor-usage-supported
Synchronizer Usage Supported	Whether 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.289. Metrics
Name	Description
Dump All Threads	Returns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked Threads	Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked Threads	Finds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu Time	Returns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread Info	Returns 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 Infos	Returns the thread info for each thread whose ID is in the input list.
Get Thread User Time	Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread Count	Resets the peak thread count to the current number of live threads.
Get All thread ids	Get 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.3.1.2.5. JBossAS7 - Garbage Collector Service

Overview

Table 3.290. Overview
Description:	Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.2.5.1, “JBossAS7 - Garbage Collector Resource Service”

Connection Properties

Table 3.291.
Name	Description	Required	Internal 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.3.1.2.5.1. JBossAS7 - Garbage Collector Resource Service

Overview

Table 3.292. Overview
Description:	The management interface for one of the garbage collectors in the Java virtual machine.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.293.
Name	Description	Required	Internal 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.294. Metrics
Name	Type	Description	Internal Name
Collection Count	measurement	The total number of collections that have occurred.	collection-count
Collection Count per Minute	measurement	The total number of collections that have occurred.	collection-count
Collection Time	measurement	The approximate accumulated collection elapsed time in milliseconds.	collection-time
Collection Time per Minute	measurement	The approximate accumulated collection elapsed time in milliseconds.	collection-time
Name	trait	The name representing this garbage collector	name
Valid	trait	Whether 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.295.
Name	Description	Required	Internal Name
Memory Pool Names	The 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.3.1.2.6. JBossAS7 - Memory Pool Service

Overview

Table 3.296. Overview
Description:	Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.2.6.1, “JBossAS7 - Memory Pool Resource Service”

Connection Properties

Table 3.297.
Name	Description	Required	Internal 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.3.1.2.6.1. JBossAS7 - Memory Pool Resource Service

Overview

Table 3.298. 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:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.299.
Name	Description	Required	Internal 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.300. Metrics
Name	Type	Description	Internal Name
Collection Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	collection-usage:init
Collection Usage - Used	measurement	The amount of used memory in bytes.	collection-usage:used
Collection Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	collection-usage:committed
Collection Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	collection-usage:max
Collection Usage Threshold Count	measurement	The 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 Exceeded	trait	Whether 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 Supported	trait	Whether this memory pool supports a collection usage threshold.	collection-usage-threshold-supported
Name	trait	The name representing this memory pool.	name
Peak Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	peak-usage:init
Peak Usage - Used	measurement	The amount of used memory in bytes.	peak-usage:used
Peak Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	peak-usage:committed
Peak Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	peak-usage:max
Type	trait	The type of this memory pool.	type
Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	usage:init
Usage - Used	measurement	The amount of used memory in bytes.	usage:used
Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	usage:committed
Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	usage:max
Usage Threshold Count	measurement	The 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 Exceeded	trait	Whether 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 Supported	trait	Whether this memory pool supports usage threshold.	usage-threshold-supported
Valid	trait	Whether 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.301.
Name	Description	Required	Internal Name
Collection Usage Threshold	The 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 Names	The names of the memory managers that manage this memory pool.	yes	memory-manager-names
Usage Threshold	The 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.302. Metrics
Name	Description
Reset Peak Usage	Resets the peak memory usage statistic of this memory pool to the current memory usage.

Package Types

none

3.3.1.3. JBossAS7 - JBossWeb Service

Overview

Table 3.303. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.3.1, “JBossAS7 - Connector Service”
Section 3.3.1.3.2, “JBossAS7 - VHost Service”

Connection Properties

Table 3.304.
Name	Description	Required	Internal 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.305.
Name	Description	Required	Internal Name
Disabled: 0	Enable the default Servlet mapping. The default value is false.	no	disabled:0
File Encoding	Force a file encoding.	no	file-encoding
Listings	Enable folder listings. The default value is false.	no	listings
Max Depth	Maximum recursion for PROPFIND. The default value is 3.	no	max-depth
Read Only	Allow write HTTP methods (PUT, DELETE). The default value is true.	no	read-only
Sendfile	Enable sendfile if possible, for files bigger than the specified byte size. The default value is 49152.	no	sendfile
Secret	Secret for WebDAV locking operations.	no	secret
Webdav	Enable WebDAV functionality. The default value is false.	no	webdav
Check Interval	Check interval for JSP updates using a background thread. The default value is 0.	no	check-interval
Development	Enable the development mode, which gives more information when an error occurs. The default value is false.	no	development
Disabled: 1	Enable the JSP container. The default value is false.	no	disabled:1
Display Source Fragment	When a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true.	no	display-source-fragment
Dump Smap	Write SMAP data to a file. The default value is false.	no	dump-smap
Error On Use Bean Invalid Class Attribute	Enable errors when using a bad class in useBean. The default value is false.	no	error-on-use-bean-invalid-class-attribute
Generate Strings As Char Arrays	Generate String constants as char arrays. The default value is false.	no	generate-strings-as-char-arrays
Java Encoding	Specify the encoding used for Java sources. The default value is UTF8.	no	java-encoding
Keep Generated	Keep the generated Servlets. The default value is true.	no	keep-generated
Mapped File	Map to the JSP source. The default value is true.	no	mapped-file
Modification Test Interval	Minimum amount of time between two tests for updates, in seconds. The default value is 4.	no	modification-test-interval
Recompile On Fail	Retry failed JSP compilations on each request. The default value is false.	no	recompile-on-fail
Scratch Dir	Specify a different work directory.	no	scratch-dir
Smap	Enable SMAP. The default value is true.	no	smap
Source Vm	Source VM level for compilation. The default value is 1.5.	no	source-vm
Tag Pooling	Enable tag pooling. The default value is true.	no	tag-pooling
Target Vm	Target VM level for compilation. The default value is 1.5.	no	target-vm
Trim Spaces	Trim some spaces from the generated Servlet. The default value is false.	no	trim-spaces
X Powered By	Enable advertising the JSP engine in x-powered-by. The default value is true.	no	x-powered-by
Welcome File	A welcome file declaration.	no	welcome-file
Default Virtual Server	The web container's default virtual server. The default value is default-host.	yes	default-virtual-server
Instance Id	The identifier for this server instance.	no	instance-id
Native	Add the native initialization listener to the web container. The default value is true.	no	native

Note

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

Operations

none

Package Types

none

3.3.1.3.1. JBossAS7 - Connector Service

Overview

Table 3.306. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.307.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.308. Metrics
Name	Type	Description	Internal Name
Bytes Sent	measurement	Number of byte sent by the connector.	bytesSent
Bytes Sent per Minute	measurement	Number of byte sent by the connector.	bytesSent
Bytes Received	measurement	Number of byte received by the connector (POST data).	bytesReceived
Bytes Received per Minute	measurement	Number of byte received by the connector (POST data).	bytesReceived
Processing Time	measurement	Processing time used by the connector. Im milli-seconds.	processingTime
Processing Time per Minute	measurement	Processing time used by the connector. Im milli-seconds.	processingTime
Error Count	measurement	Number of error that occurs when processing requests by the connector.	errorCount
Error Count per Minute	measurement	Number of error that occurs when processing requests by the connector.	errorCount
Max Time	measurement	Max time spent to process a requests.	maxTime
Request Count	measurement	Number of the request processed by the connector.	requestCount
Request Count per Minute	measurement	Number of the request processed by the connector.	requestCount
Max connections	measurement	Number of max connections this connector can handle (see configuration to set it)	_expr:max-connections

Note

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

Configuration Properties

Table 3.309.
Name	Description	Required	Internal Name
Configuration		no	*Configuration+
Scheme	The web connector scheme.	yes	scheme
Socket Binding	The web connector socket-binding reference, this connector should be bound to.	yes	socket-binding
Enabled	Defines whether the connector should be started on startup. The default value is true.	no	enabled
Enable Lookups	Enable DNS lookups for Servlet API. The default value is false.	no	enable-lookups
Executor	The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool.	no	executor
Max connections	Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used.	no	max-connections:expr
Max Post Size	Maximum size in bytes of a POST request that can be parsed by the container. The default value is 2097152.	no	max-post-size
Max Save Post Size	Maximum size in bytes of a POST request that will be saved during certain authentication schemes. The default value is 4096.	no	max-save-post-size
Name	A unique name for the connector.	no	name
Protocol	The web connector protocol. (e.g. 'HTTP/1.1' or 'AJP' or a name of a class implementing ProtocolHandler and MBeanRegistration )	yes	protocol
Proxy Name	The host name that will be used when sending a redirect. The default value is null.	no	proxy-name
Proxy Port	The port that will be used when sending a redirect.	no	proxy-port
Redirect Port	The port for redirection to a secure connector. The default value is 8433.	no	redirect-port:expr
Secure	Indicates if content sent or received by the connector is secured from the user perspective. The default value is false.	no	secure
Virtual Server	The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers.	no	virtual-server

Note

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

Operations

none

Package Types

none

3.3.1.3.2. JBossAS7 - VHost Service

Overview

Table 3.310. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.3.2.1, “JBossAS7 - Rewrite Rules Service”
Section 3.3.1.3.2.2, “JBossAS7 - Access Log Service”

Connection Properties

Table 3.311.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.312. Metrics
Name	Type	Description	Internal Name
_aliases	trait	Aliases for this virtual host	_aliases

Note

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

Configuration Properties

Table 3.313.
Name	Description	Required	Internal Name
Configuration		no	*Configuration+
Virtual server aliases	The virtual server aliases	yes	alias
Default Web Module	The web module deployment name that will be mapped as the root webapp.	yes	default-web-module
Enable Welcome Root	Whether or not the bundled welcome directory is used as the root web context. The default value is false.	yes	enable-welcome-root
Name	A unique virtual host name	no	name

Note

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

Operations

none

Package Types

none

3.3.1.3.2.1. JBossAS7 - Rewrite Rules Service

Overview

Table 3.314. Overview
Description:	A list of rewrite rules that will be processed in order on the URL or vhost specified in the request. Those follow the rules for mod_rewrite. Please consult the manual for help on settings
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.315.
Name	Description	Required	Internal 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.316.
Name	Description	Required	Internal Name
Conditions		no	*1
Flags	Option flags for this rewrite rule. Consult the mod_rewrite docs.	yes	flags
Pattern	The pattern that will be matched. Consult the mod_rewrite docs.	yes	pattern
Substitution	The string that will replace the original URL or vhost. Consult the mod_rewrite docs.	yes	substitution

Note

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

Operations

none

Package Types

none

3.3.1.3.2.2. JBossAS7 - Access Log Service

Overview

Table 3.317. Overview
Description:	The access log configuration for this virtual server.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.318.
Name	Description	Required	Internal 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.319.
Name	Description	Required	Internal Name
Path	The relative folder path.	no	path
Relative To	The folder the path is relative to. The default value is jboss.server.log.dir.	no	relative-to
Extended	Enable extended pattern, with more options. The default value is false.	no	extended
Pattern	The access log pattern. The default value is common.	no	pattern
Prefix	Prefix for the log file name. The default value is false.	no	prefix
Resolve Hosts	Host resolution. The default value is false.	no	resolve-hosts
Rotate	Rotate the access log every day. The default value is true.	no	rotate

Note

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

Operations

none

Package Types

none

3.3.1.4. JBossAS7 - General JCA connectors Service

Overview

Table 3.320. Overview
Description:	General settings of the JCA engine. Not necessarily for end-users
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.321.
Name	Description	Required	Internal 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.322.
Name	Description	Required	Internal Name
Default Workmanager Short Running Thread Pool	Specify the name of short running thread pool	yes	default-workmanager-short-running-thread-pool
Default Workmanager Long Running Thread Pool	Specify the name of long running thread pool	yes	default-workmanager-long-running-thread-pool
Bean Validation Enabled	Specify whether bean validation is enabled	yes	bean-validation-enabled
Archive Validation Enabled	Enabling the validation	yes	archive-validation-enabled
Archive Validation Fail On Error	Should an archive validation error report fail the deployment. Default: true	yes	archive-validation-fail-on-error
Archive Validation Fail On Warn	Should an archive validation warning report fail the deployment. Default: false	yes	archive-validation-fail-on-warn
Cached Connection Manager Debug	enable/disable debug information logging for cached connection manager	yes	cached-connection-manager-debug
Cached Connection Manager Error	enable/disable error information logging for cached connection manager	yes	cached-connection-manager-error

Note

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

Operations

none

Package Types

none

3.3.1.5. JBossAS7 - Datasources (Standalone) Service

Overview

Table 3.323. Overview
Description:	Datasources subsystem for Standalone servers.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.5.1, “JBossAS7 - DataSource (Standalone) Service”
Section 3.3.1.5.2, “JBossAS7 - XADataSource (Standalone) Service”

Connection Properties

Table 3.324.
Name	Description	Required	Internal 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.325.
Name	Description	Required	Internal Name
Available drivers		yes	*4

Note

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

Operations

none

Package Types

none

3.3.1.5.1. JBossAS7 - DataSource (Standalone) Service

Overview

Table 3.326. Overview
Description:	A non-XA data source
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.327.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.328. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.329.
Name	Description	Required	Internal Name
Connection Property		no	*1
Connection Url	The JDBC driver connection URL	yes	connection-url
Driver Name	Name of the (existing) JDBC driver to use	yes	driver-name
Driver Class	The fully qualified name of the JDBC driver class	no	driver-class
Jndi Name	Specifies the JNDI name for the datasource	yes	jndi-name
Driver	Defines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class	no	driver
User Name	Specify the username used when creating a new connection.	no	user-name
Password	Specify the password used when creating a new connection.	no	password
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool.	no	new-connection-sql
Url Delimiter	Specifies the delimiter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Java Context	Setting this to false will bind the DataSource into global JNDI;	no	use-java-context
Enabled	Specifies if the datasource should be enabled	no	enabled
Jta	Enable JTA integration	no	jta
Max Pool Size	The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. Existing value cannot be unset.	no	max-pool-size
Min Pool Size	The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. Existing value cannot be unset.	no	min-pool-size
Pool Prefill	Whether to attempt to prefill the connection pool. Changing this value require a server restart. Existing value cannot be unset.	no	pool-prefill
Pool Use Strict Min	Define if the min-pool-size should be considered a strictly. Existing value cannot be unset.	no	pool-use-strict-min
Security Domain	Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute.	no	security-domain
Reauth Plugin Class Name	re-authentication plugin implementation provided for specific purpose (i.e vendor)	no	reauth-plugin-class-name
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Allow Multiple Users	Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that	no	allow-multiple-users
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Share Prepared Statements	Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement	no	share-prepared-statements
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed	no	track-statements
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.	no	allocation-retry
Allocation Retry Wait Millis	Indicates the time in milliseconds to wait between retrying to allocate a connection.	no	allocation-retry-wait-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. Existing value cannot be unset.	no	blocking-timeout-wait-millis
Idle Timeout Minutes	The idle-timeout-minutes elements indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. Existing value cannot be unset.	no	idle-timeout-minutes
Query Timeout	Any configured query timeout in seconds The default is no timeout	no	query-timeout
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction.	no	set-tx-query-timeout
Transaction Isolation	Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels.	no	transaction-isolation
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.	no	check-valid-connection-sql
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred	no	exception-sorter-class-name
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present.	no	valid-connection-checker-class-name
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. Existing value cannot be unset.	no	background-validation-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. Existing value cannot be unset.	no	background-validation
Use Fast Fail	Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)	no	use-fast-fail
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation	no	validate-on-match
Spy	whatever spy or not the jdbc connection	no	spy
Use Ccm	Enable the use of a cached connection manager	no	use-ccm

Note

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

Operations

Table 3.330. Metrics
Name	Description
Enable	Enables the data-source
Disable	Disables the data-source
Flush All Connection In Pool	Flushes the pool for all connections
Flush Idle Connection In Pool	Flushes the pool for idle connections
Test Connection In Pool	Tests if a connection can be obtained

Package Types

none

3.3.1.5.2. JBossAS7 - XADataSource (Standalone) Service

Overview

Table 3.331. Overview
Description:	An XA data source
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.332.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.333. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.334.
Name	Description	Required	Internal Name
Properties		yes	*2
Xa Datasource Class	The fully qualified name of the javax.sql.XADataSource implementation	yes	xa-datasource-class
Jndi Name	Specifies the JNDI name for the datasource	yes	jndi-name
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	yes	driver-name
User Name	Specify the username used when creating a new connection.	no	user-name
Password	Specify the password used when creating a new connection.	no	password
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool.	no	new-connection-sql
Url Delimiter	Specifies the delimiter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Java Context	Setting this to false will bind the DataSource into global JNDI;	no	use-java-context
Enabled	Specifies if the datasource should be enabled	no	enabled
Max Pool Size	The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. Existing value cannot be unset.	no	max-pool-size
Min Pool Size	The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. Existing value cannot be unset.	no	min-pool-size
Pool Prefill	Whether to attempt to prefill the connection pool. Changing this value require a server restart. Existing value cannot be unset.	no	pool-prefill
Pool Use Strict Min	Define if the min-pool-size should be considered a strictly. Existing value cannot be unset.	no	pool-use-strict-min
Interleaving	An element to enable interleaving for XA connection factories	no	interleaving
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded	no	pad-xid
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Wrap Xa Datasource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance	no	wrap-xa-datasource
Security Domain	Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute.	no	security-domain
Recovery Plugin Class Name	recovery plugin implementation provided for specific purpose (i.e vendor)	no	recovery-plugin-class-name
Reauth Plugin Class Name	re-authentication plugin implementation provided for specific purpose (i.e vendor)	no	reauth-plugin-class-name
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Share Prepared Statements	Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement	no	share-prepared-statements
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed	no	track-statements
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.	no	allocation-retry
Allocation Retry Wait Millis	he allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection.	no	allocation-retry-wait-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. Existing value cannot be unset.	no	blocking-timeout-wait-millis
Idle Timeout Minutes	The idle-timeout-minutes elements indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. Existing value cannot be unset.	no	idle-timeout-minutes
Query Timeout	Any configured query timeout in seconds The default is no timeout	no	query-timeout
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction.	no	set-tx-query-timeout
Transaction Isolation	Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels.	no	transaction-isolation
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.	no	check-valid-connection-sql
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred	no	exception-sorter-class-name
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present.	no	valid-connection-checker-class-name
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. Existing value cannot be unset.	no	background-validation-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. Existing value cannot be unset.	no	background-validation
Use Fast Fail	Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)	no	use-fast-fail
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation	no	validate-on-match
Xa Resource Timeout	Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds	no	xa-resource-timeout
Spy	whatever spy or not the jdbc connection	no	spy
Use Ccm	Enable the use of a cached connection manager	no	use-ccm
Recovery Username	username used to try connection recovery	no	recovery-username
Recovery Password	password used to try connection recovery	no	recovery-password
Recovery Security Domain	security-domain used to try connection recovery	no	recovery-security-domain
No Recovery	if true no recovery are tried for this connection pool	no	no-recovery

Note

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

Operations

Table 3.335. Metrics
Name	Description
Enable	Enables the data-source
Disable	Disables the data-source
Flush All Connection In Pool	Flushes the pool for all connections
Flush Idle Connection In Pool	Flushes the pool for idle connections
Test Connection In Pool	Tests if a connection can be obtained

Package Types

none

3.3.1.6. JBossAS7 - Logging Service

Overview

Table 3.336. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.6.1, “JBossAS7 - Async Handler Service”
Section 3.3.1.6.2, “JBossAS7 - Console Handler Service”
Section 3.3.1.6.3, “JBossAS7 - Custom Handler Service”
Section 3.3.1.6.4, “JBossAS7 - File Handler Service”
Section 3.3.1.6.5, “JBossAS7 - Logger Service”
Section 3.3.1.6.6, “JBossAS7 - Periodic Rotating File Handler Service”
Section 3.3.1.6.7, “JBossAS7 - Size Rotating File Handler Service”

Connection Properties

Table 3.337.
Name	Description	Required	Internal 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.338.
Name	Description	Required	Internal Name
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Handlers	The Handlers associated with this Logger.	yes	handlers

Note

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

Operations

none

Package Types

none

3.3.1.6.1. JBossAS7 - Async Handler Service

Overview

Table 3.339. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.340.
Name	Description	Required	Internal 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.341.
Name	Description	Required	Internal Name
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Overflow Action	Specify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK.	yes	overflow-action
Queue Length	The queue length to use before flushing writing	yes	queue-length
Subhandlers	The Handlers associated with this async handler.	no	subhandlers

Note

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

Operations

Table 3.342. Metrics
Name	Description
Assign Subhandler	Assign a subhandler to the ASYNC handler.
Disable	Disable a logging handler.
Enable	Enable a logging handler.
Unassign Subhandler	Unassign a subhandler from the ASYNC handler.

Package Types

none

3.3.1.6.2. JBossAS7 - Console Handler Service

Overview

Table 3.343. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.344.
Name	Description	Required	Internal 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.345.
Name	Description	Required	Internal Name
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Target	Defines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR. The default value is System.out.	no	target

Note

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

Operations

Table 3.346. Metrics
Name	Description
Disable	Disable a logging handler.
Enable	Enable a logging handler.

Package Types

none

3.3.1.6.3. JBossAS7 - Custom Handler Service

Overview

Table 3.347. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.348.
Name	Description	Required	Internal 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.349.
Name	Description	Required	Internal Name
Class	The logging handler class to be used.	yes	class
Encoding	The character encoding used by this Handler.	no	encoding
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Module	The module that the logging handler depends on.	yes	module
Properties		yes	properties

Note

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

Operations

Table 3.350. Metrics
Name	Description
Disable	Disable a logging handler.
Enable	Enable a logging handler.

Package Types

none

3.3.1.6.4. JBossAS7 - File Handler Service

Overview

Table 3.351. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.352.
Name	Description	Required	Internal 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.353.
Name	Description	Required	Internal Name
Append	Specify whether to append to the target file. The default value is true.	no	append
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
File	The file description consisting of the path and optional relative to path.	no	file
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level

Note

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

Operations

Table 3.354. Metrics
Name	Description
Disable	Disable a logging handler.
Enable	Enable a logging handler.

Package Types

none

3.3.1.6.5. JBossAS7 - Logger Service

Overview

Table 3.355. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.356.
Name	Description	Required	Internal 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.357.
Name	Description	Required	Internal Name
Handlers	The Handlers associated with this Logger.	no	handlers
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Use Parent Handlers	Specifies whether or not this logger should send its output to it's parent Logger. The default value is true.	no	use-parent-handlers

Note

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

Operations

Table 3.358. Metrics
Name	Description
Change Log Level	Change the logging level for a logger category.

Package Types

none

3.3.1.6.6. JBossAS7 - Periodic Rotating File Handler Service

Overview

Table 3.359. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.360.
Name	Description	Required	Internal 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.361.
Name	Description	Required	Internal Name
Append	Specify whether to append to the target file. The default value is true.	no	append
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
File	The file description consisting of the path and optional relative to path.	no	file
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Suffix	Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.	yes	suffix

Note

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

Operations

Table 3.362. Metrics
Name	Description
Disable	Disable a logging handler.
Enable	Enable a logging handler.

Package Types

none

3.3.1.6.7. JBossAS7 - Size Rotating File Handler Service

Overview

Table 3.363. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.364.
Name	Description	Required	Internal 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.365.
Name	Description	Required	Internal Name
Append	Specify whether to append to the target file. The default value is true.	no	append
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
File	The file description consisting of the path and optional relative to path.	no	file
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Max Backup Index	The maximum number of backups to keep. The default value is 1.	yes	max-backup-index
Rotate Size	The size at which to rotate the log file. The default value is 2m.	yes	rotate-size

Note

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

Operations

Table 3.366. Metrics
Name	Description
Disable	Disable a logging handler.
Enable	Enable a logging handler.

Package Types

none

3.3.1.7. JBossAS7 - Webservices Service

Overview

Table 3.367. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.7.1, “JBossAS7 - Endpoint Service”

Connection Properties

Table 3.368.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.369.
Name	Description	Required	Internal Name
Modify Wsdl Address	Whether the soap address can be modified.	no	modify-wsdl-address
Wsdl Host	The WSDL, that is a required deployment artifact for an endpoint, has a <soap:address> element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of <soap:address> is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of <soap:address> is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the <soap:address>	no	wsdl-host
Wsdl Port	The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.	no	wsdl-port
Wsdl Secure Port	The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.	no	wsdl-secure-port

Note

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

Operations

none

Package Types

none

3.3.1.7.1. JBossAS7 - Endpoint Service

Overview

Table 3.370. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.7.1.1, “JBossAS7 - Post Handler Chain Service”
Section 3.3.1.7.1.2, “JBossAS7 - Pre Handler Chain Service”
Section 3.3.1.7.1.3, “JBossAS7 - Property Service”

Connection Properties

Table 3.371.
Name	Description	Required	Internal 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.3.1.7.1.1. JBossAS7 - Post Handler Chain Service

Overview

Table 3.372. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.7.1.1.1, “JBossAS7 - Post Handler Service”

Connection Properties

Table 3.373.
Name	Description	Required	Internal 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.374.
Name	Description	Required	Internal Name
Protocol Bindings	Protocol binding	no	protocol-bindings

Note

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

Operations

none

Package Types

none

3.3.1.7.1.1.1. JBossAS7 - Post Handler Service

Overview

Table 3.375. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.376.
Name	Description	Required	Internal 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.377.
Name	Description	Required	Internal Name
Class	Handler class	yes	class

Note

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

Operations

none

Package Types

none

3.3.1.7.1.2. JBossAS7 - Pre Handler Chain Service

Overview

Table 3.378. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.7.1.2.1, “JBossAS7 - Pre Handler Service”

Connection Properties

Table 3.379.
Name	Description	Required	Internal 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.380.
Name	Description	Required	Internal Name
Protocol Bindings	Protocol binding	no	protocol-bindings

Note

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

Operations

none

Package Types

none

3.3.1.7.1.2.1. JBossAS7 - Pre Handler Service

Overview

Table 3.381. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.382.
Name	Description	Required	Internal 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.383.
Name	Description	Required	Internal Name
Class	Handler class	yes	class

Note

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

Operations

none

Package Types

none

3.3.1.7.1.3. JBossAS7 - Property Service

Overview

Table 3.384. Overview
Description:	A property
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.385.
Name	Description	Required	Internal 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.386.
Name	Description	Required	Internal Name
Value	The property value.	no	value

Note

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

Operations

none

Package Types

none

3.3.1.8. JBossAS7 - Naming Service

Overview

Table 3.387. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.8.1, “JBossAS7 - Binding Service”

Connection Properties

Table 3.388.
Name	Description	Required	Internal 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.389. Metrics
Name	Description
JNDIView	Peek at the JNDI tree

Package Types

none

3.3.1.8.1. JBossAS7 - Binding Service

Overview

Table 3.390. Overview
Description:	JNDI bindings for primitive types
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.391.
Name	Description	Required	Internal 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.392.
Name	Description	Required	Internal Name
Binding Type	The type of binding to create, may be simple, lookup or object-factory	yes	binding-type
Class	The object factory class name for object factory bindings	no	class
Lookup	The entry to lookup in JNDI for lookup bindings	no	lookup
Module	The module to load the object factory from for object factory bindings	no	module
Type	The type of the value to bind for simple bindings, this must be a primitive type	no	type
Value	The value to bind for simple bindings	no	value

Note

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

Operations

none

Package Types

none

3.3.1.9. JBossAS7 - Transactions Subsystem (Standalone) Service

Overview

Table 3.393. Overview
Description:	The transactions subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.9.1, “JBossAS7 - Log Store (Standalone) Service”

Connection Properties

Table 3.394.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.395. Metrics
Name	Type	Description	Internal Name
Number Of Nested Transactions	measurement	The total number of nested (sub) transactions created.	number-of-nested-transactions
Number Of Nested Transactions per Minute	measurement	The total number of nested (sub) transactions created.	number-of-nested-transactions
Number Of Timed Out Transactions	measurement	The number of transactions that have rolled back due to timeout.	number-of-timed-out-transactions
Number Of Timed Out Transactions per Minute	measurement	The number of transactions that have rolled back due to timeout.	number-of-timed-out-transactions
Number Of Committed Transactions	measurement	The number of committed transactions.	number-of-committed-transactions
Number Of Committed Transactions per Minute	measurement	The number of committed transactions.	number-of-committed-transactions
Number Of Transactions	measurement	The total number of transactions (top-level and nested) created	number-of-transactions
Number Of Transactions per Minute	measurement	The total number of transactions (top-level and nested) created	number-of-transactions
Number Of Heuristics	measurement	The number of transactions which have terminated with heuristic outcomes.	number-of-heuristics
Number Of Heuristics per Minute	measurement	The number of transactions which have terminated with heuristic outcomes.	number-of-heuristics
Number Of Aborted Transactions	measurement	The number of aborted (i.e. rolledback) transactions.	number-of-aborted-transactions
Number Of Aborted Transactions per Minute	measurement	The number of aborted (i.e. rolledback) transactions.	number-of-aborted-transactions
Number Of Inflight Transactions	measurement	The number of transactions that have begun but not yet terminated.	number-of-inflight-transactions
Number Of Inflight Transactions per Minute	measurement	The number of transactions that have begun but not yet terminated.	number-of-inflight-transactions
Number Of Application Rollbacks	measurement	The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.	number-of-application-rollbacks
Number Of Application Rollbacks per Minute	measurement	The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.	number-of-application-rollbacks
Number Of Resource Rollbacks	measurement	The number of transactions that rolled back due to resource (participant) failure.	number-of-resource-rollbacks
Number Of Resource Rollbacks per Minute	measurement	The number of transactions that rolled back due to resource (participant) failure.	number-of-resource-rollbacks

Note

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

Configuration Properties

Table 3.396.
Name	Description	Required	Internal Name
Relative To	References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the 'path' attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the 'path' attribute to be treated as an absolute path. The default value is jboss.server.data.dir.	no	relative-to
Process Id Uuid	Indicates whether the transaction manager should use a UUID based process id.	no	process-id-uuid
Socket Binding	Used to reference the correct socket binding to use for the recovery environment.	no	socket-binding
Jts	If true this enables the Java Transaction Service. The default value is false.	no	jts
Object Store Path	Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. The default value is tx-object-store.	no	object-store-path
Path	Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. The default value is var.	no	path
Process Id Socket Binding	The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.	no	process-id-socket-binding
Default Timeout	The default timeout. The default value is 300.	no	default-timeout
Process Id Socket Max Ports	The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'. The default value is 10.	no	process-id-socket-max-ports
Recovery Listener	Used to specify if the recovery system should listen on a network socket or not. The default value is false.	no	recovery-listener
Status Socket Binding	Used to reference the correct socket binding to use for the transaction status manager.	no	status-socket-binding
Node Identifier	Used to set the node identifier on the core environment. The default value is 1.	no	node-identifier
Enable Tsm Status	Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not. The default value is false.	no	enable-tsm-status
Object Store Relative To	References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the 'path' attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the 'path' attribute to be treated as an absolute path. The default value is jboss.server.data.dir.	no	object-store-relative-to
Enable Statistics	Whether statistics should be enabled. The default value is false.	no	enable-statistics

Note

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

Operations

none

Package Types

none

3.3.1.9.1. JBossAS7 - Log Store (Standalone) Service

Overview

Table 3.397. Overview
Description:	Representation of the transaction logging storage mechanism.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.9.1.1, “JBossAS7 - Transactions (Standalone) Service”

Connection Properties

Table 3.398.
Name	Description	Required	Internal 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.399.
Name	Description	Required	Internal Name
Type	Specifies the implementation type of the logging store.	no	type

Note

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

Operations

Table 3.400. Metrics
Name	Description
Probe	Scan for new transaction logs. This operation will creates a child for each pending transaction.

Package Types

none

3.3.1.9.1.1. JBossAS7 - Transactions (Standalone) Service

Overview

Table 3.401. Overview
Description:	The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.9.1.1.1, “JBossAS7 - Participants (Standalone) Service”

Connection Properties

Table 3.402.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.403.
Name	Description	Required	Internal Name
Age In Seconds	The time since this transaction was prepared or when the recovery system last tried to recover it.	no	age-in-seconds
Id	The id of this transaction.	no	id
Jmx Name	The JMX name of this transaction.	no	jmx-name
Type	The type name under which this record is stored.	no	type

Note

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

Operations

Table 3.404. Metrics
Name	Description
Delete	Remove this transaction log. WARNING after this operation the transaction manager will have no knowledge of the transaction and will therefore never be able to recover it. If you are sure that the transaction is complete then the operation is safe. The representation of the transaction log is removed from the model too.

Package Types

none

3.3.1.9.1.1.1. JBossAS7 - Participants (Standalone) Service

Overview

Table 3.405. Overview
Description:	The resources that did work in a transaction.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.406.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.407.
Name	Description	Required	Internal Name
Eis Product Name	The JCA enterprise information system's product name.	no	eis-product-name
Eis Product Version	The JCA enterprise information system's product version	no	eis-product-version
Jmx Name	The JMX name of this participant.	no	jmx-name
Jndi Name	JNDI name of this participant.	no	jndi-name
Status	Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).	no	status
Type	The type name under which this record is stored.	no	type

Note

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

Operations

Table 3.408. Metrics
Name	Description
Recover	If this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction.
Refresh	Refresh the management view of the attributes of this participant record by querying the transaction log. (Note that the read-resource operaton only reads the model, hence the need for this refresh operation).

Package Types

none

3.3.1.10. JBossAS7 - Network Interface Service

Overview

Table 3.409. Overview
Description:	A named network interface, along with required criteria for determining the IP address to associate with that interface
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.410.
Name	Description	Required	Internal 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.411.
Name	Description	Required	Internal Name
Any Address	Attribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic.	no	any-address
Any Ipv 4 Address	Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0).	no	any-ipv4-address
Any Ipv 6 Address	Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::).	no	any-ipv6-address
Link Local Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	link-local-address
Loopback	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	loopback
Loopback Address	Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	loopback-address
Multicast	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	multicast
Nic	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.	no	nic
Nic Match	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.	no	nic-match
Point To Point	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	point-to-point
Public Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	public-address
Site Local Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	site-local-address
Subnet Match	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in 'slash notation'; e.g. '192.168.0.0/16'. An 'undefined' value means this attribute is not relevant to the IP address selection.	no	subnet-match
Up	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	up
Virtual	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	virtual
Inet Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.	no	inet-address

Note

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

Operations

none

Package Types

none

3.3.1.11. JBossAS7 - SocketBindingGroup Service

Overview

Table 3.412. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.413.
Name	Description	Required	Internal 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.414.
Name	Description	Required	Internal Name
Bindings		yes	*
Bindings		yes	*1
Bindings		yes	*2
Default Interface	Default Interface for these bindings. See Network Interfaces for its definition	yes	default-interface
Port Offset	Offset from standard ports for this group. This is only available in standalone mode	no	port-offset

Note

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

Operations

none

Package Types

none

3.3.1.12. JBossAS7 - Deployment Service

Overview

Table 3.415. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.1, “JBossAS7 - Webservices Runtime Service”
Section 3.3.1.12.2, “JBossAS7 - Web Runtime Service”
Section 3.3.1.12.3, “JBossAS7 - Messaging Runtime Service”
Section 3.3.1.12.4, “JBossAS7 - Subdeployment Service”
Section 3.3.1.12.5, “JBossAS7 - JPA Runtime Service”
Section 3.3.1.12.6, “JBossAS7 - Datasources Runtime Service”
Section 3.3.1.12.7, “JBossAS7 - EJB3 Runtime Service”
Section 3.3.1.12.8, “JBossAS7 - Resource Adapters Runtime Service”

Connection Properties

Table 3.416.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.417. Metrics
Name	Type	Description	Internal Name
Status	trait	The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was manually stopped.	status

Note

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

Configuration Properties

Table 3.418.
Name	Description	Required	Internal Name
Content	List of pieces of content that comprise the deployment.	yes	content
Enabled	Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)	no	enabled
Name	Unique identifier of the deployment. Must be unique across all deployments.	no	name
Persistent	Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.	no	persistent
Runtime Name	Name by which the deployment should be known within a server runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same runtime-name (e.g. two versions of foo.war) both available in the deployment content repository, in which case the deployments would need to have distinct name; values but would have the same runtime-name.	no	runtime-name

Note

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

Operations

Table 3.419. Metrics
Name	Description
Enable
Disable
Restart

Package Types

Table 3.420. Package Types
Name	Category	Description
File	Deployable	Deployments on this server group

3.3.1.12.1. JBossAS7 - Webservices Runtime Service

Overview

Table 3.421. Overview
Description:	Runtime resources exposed by web service components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.1.1, “JBossAS7 - Endpoint Runtime Service”

Connection Properties

Table 3.422.
Name	Description	Required	Internal 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.3.1.12.1.1. JBossAS7 - Endpoint Runtime Service

Overview

Table 3.423. Overview
Description:	Webservice endpoint.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.424.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.425. Metrics
Name	Type	Description	Internal Name
Average Processing Time	measurement	Average endpoint processing time.	average-processing-time
Fault Count	measurement	Count of faults the endpoint generated.	fault-count
Max Processing Time	measurement	Maximal endpoint processing time.	max-processing-time
Min Processing Time	measurement	Minimal endpoint processing time.	min-processing-time
Request Count	measurement	Count of requests the endpoint processed.	request-count
Response Count	measurement	Count of responses the endpoint generated.	response-count
Total Processing Time	measurement	Total endpoint processing time.	total-processing-time

Note

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

Configuration Properties

Table 3.426.
Name	Description	Required	Internal Name
Class	Webservice endpoint class.	no	class
Context	Webservice endpoint context.	no	context
Name	Webservice endpoint name.	no	name
Type	Webservice endpoint type.	no	type
Wsdl Url	Webservice endpoint WSDL URL.	no	wsdl-url

Note

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

Operations

none

Package Types

none

3.3.1.12.2. JBossAS7 - Web Runtime Service

Overview

Table 3.427. Overview
Description:	Runtime resources exposed by web components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.428.
Name	Description	Required	Internal Name
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Path		yes	path

Note

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

Metrics

Table 3.429. Metrics
Name	Type	Description	Internal Name
Virtual Host	trait	the virtual host this webapp is deployed to	virtual-host
Context Root	trait	the context root of this webapp	context-root
Response Time	calltime	the minimum, maximum, and average response times for requests serviced by this webapp	responseTime
Currently Active Sessions	measurement	The number of sessions that are currently active	active-sessions
Duplicated Session Ids	measurement	The number of duplicated session identifiers	duplicated-session-ids
Expired Sessions	measurement	The number of expired sessions	expired-sessions
Expired Sessions per Minute	measurement	The number of expired sessions	expired-sessions
Maximum Active Sessions	measurement	The maximum number of sessions that have been active	max-active-sessions
Rejected Sessions	measurement	The number of sessions rejected	rejected-sessions
Rejected Sessions per Minute	measurement	The number of sessions rejected	rejected-sessions
Average Session Alive Time	measurement	The average alive time of sessions	session-avg-alive-time
Max Session Alive Time	measurement	The maximum alive time of sessions	session-max-alive-time
Created Sessions	measurement	The number of sessions created	sessions-created
Created Sessions per Minute	measurement	The number of sessions created	sessions-created

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.3. JBossAS7 - Messaging Runtime Service

Overview

Table 3.430. Overview
Description:	Runtime resources exposed by messaging resources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.3.1, “JBossAS7 - HornetQ Server Runtime Service”

Connection Properties

Table 3.431.
Name	Description	Required	Internal 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.3.1.12.3.1. JBossAS7 - HornetQ Server Runtime Service

Overview

Table 3.432. Overview
Description:	A HornetQ server instance.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.3.1.1, “JBossAS7 - JMS Queue Runtime Service”
Section 3.3.1.12.3.1.2, “JBossAS7 - JMS Topic Runtime Service”

Connection Properties

Table 3.433.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.434. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this server is started.	started
Version	trait	The server's version.	version

Note

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

Configuration Properties

Table 3.435.
Name	Description	Required	Internal Name
Allow Failback	Whether this server will automatically shutdown if the original live server comes back up. The default value is true.	no	allow-failback
Async Connection Execution Enabled	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true.	no	async-connection-execution-enabled
Backup	Whether this server is a backup server. The default value is false.	no	backup
Cluster Password	The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!.	no	cluster-password
Cluster User	The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	cluster-user
Clustered	Whether the server is clustered. The default value is false.	no	clustered
Connection Ttl Override	If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1.	no	connection-ttl-override
Create Bindings Dir	Whether the server should create the bindings directory on start up. The default value is true.	no	create-bindings-dir
Create Journal Dir	Whether the server should create the journal directory on start up. The default value is true.	no	create-journal-dir
Failback Delay	How long to wait before failback occurs on live server restart. The default value is 5000.	no	failback-delay
Failover On Shutdown	Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false.	no	failover-on-shutdown
Id Cache Size	The size of the cache for pre-creating message IDs. The default value is 2000.	no	id-cache-size
Jmx Domain	The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq.	no	jmx-domain
Jmx Management Enabled	Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false.	no	jmx-management-enabled
Journal Buffer Size	The size of the internal buffer on the journal.	no	journal-buffer-size
Journal Buffer Timeout	The timeout (in nanoseconds) used to flush internal buffers on the journal.	no	journal-buffer-timeout
Journal Compact Min Files	The minimal number of journal data files before we can start compacting. The default value is 10.	no	journal-compact-min-files
Journal Compact Percentage	The percentage of live data on which we consider compacting the journal. The default value is 30.	no	journal-compact-percentage
Journal File Size	The size (in bytes) of each journal file. The default value is 10485760.	no	journal-file-size
Journal Max Io	The maximum number of write requests that can be in the AIO queue at any one time.	no	journal-max-io
Journal Min Files	How many journal files to pre-create. The default value is 2.	no	journal-min-files
Journal Sync Non Transactional	Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true.	no	journal-sync-non-transactional
Journal Sync Transactional	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true.	no	journal-sync-transactional
Journal Type	The type of journal to use. The default value is ASYNCIO.	no	journal-type
Live Connector Ref	The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'.	no	live-connector-ref
Log Journal Write Rate	Whether to periodically log the journal's write rate and flush rate. The default value is false.	no	log-journal-write-rate
Management Address	Address to send management messages to. The default value is jms.queue.hornetq.management.	no	management-address
Management Notification Address	The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications.	no	management-notification-address
Memory Measure Interval	Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1.	no	memory-measure-interval:expr
Memory Warning Threshold	Percentage of available memory which if exceeded results in a warning log. The default value is 25.	no	memory-warning-threshold:expr
Message Counter Enabled	Whether message counters are enabled. The default value is false.	no	message-counter-enabled
Message Counter Max Day History	How many days to keep message counter history. The default value is 10.	no	message-counter-max-day-history
Message Counter Sample Period	The sample period (in ms) to use for message counters. The default value is 10000.	no	message-counter-sample-period
Message Expiry Scan Period	How often (in ms) to scan for expired messages. The default value is 30000.	no	message-expiry-scan-period
Message Expiry Thread Priority	The priority of the thread expiring messages. The default value is 3.	no	message-expiry-thread-priority
Page Max Concurrent Io	The maximum number of concurrent reads allowed on paging. The default value is 5.	no	page-max-concurrent-io
Perf Blast Pages	TODO. The default value is -1.	no	perf-blast-pages
Persist Delivery Count Before Delivery	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false.	no	persist-delivery-count-before-delivery
Persist Id Cache	Whether IDs are persisted to the journal. The default value is true.	no	persist-id-cache
Persistence Enabled	Whether the server will use the file based journal for persistence. The default value is true.	no	persistence-enabled
Remoting Interceptors	The list of interceptor classes used by this server.	no	remoting-interceptors:nullable
Run Sync Speed Test	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false.	no	run-sync-speed-test
Scheduled Thread Pool Max Size	The number of threads that the main scheduled thread pool has. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Security Domain	The security domain to use to verify user and role information. The default value is other.	no	security-domain
Security Enabled	Whether security is enabled. The default value is true.	no	security-enabled
Security Invalidation Interval	How long (in ms) to wait before invalidating the security cache. The default value is 10000.	no	security-invalidation-interval
Server Dump Interval	How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1.	no	server-dump-interval
Shared Store	Whether this server is using a shared store for failover. The default value is true.	no	shared-store
Thread Pool Max Size	The number of threads that the main thread pool has. -1 means no limit. The default value is 30.	no	thread-pool-max-size:expr
Transaction Timeout	How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000.	no	transaction-timeout
Transaction Timeout Scan Period	How often (in ms) to scan for timeout transactions. The default value is 1000.	no	transaction-timeout-scan-period
Wild Card Routing Enabled	Whether the server supports wild card routing. The default value is true.	no	wild-card-routing-enabled

Note

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

Operations

Table 3.436. Metrics
Name	Description
Close Connections for Address	Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction	Heuristically commits a prepared transaction.
Force Failover	Force the messaging server to stop and notify clients to failover.
Get Address Settings as JSON	Returns the address settings as a JSON string for an address match. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON	Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID	Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time	Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON	Lists all the consumers.
List Connection IDs	Lists the IDs of all the connections connected to this server.
List Connections as JSON	List all JMS connections.
List Consumers as JSON	Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions	Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions	Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML	List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON	List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML	List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON	List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions	List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
List Producers Info as JSON	For all sessions, lists information about message producers using JSON serialization.
List Remote Addresses	Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List Sessions	Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON	Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations	Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories	Reset all message counters history.
Reset All Message Counters	Reset all message counters.
Rollback Prepared Transaction	Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.

Package Types

none

3.3.1.12.3.1.1. JBossAS7 - JMS Queue Runtime Service

Overview

Table 3.437. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.438.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.439. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable	trait	Whether the queue is durable or not. The default value is true.	durable
Expiry Address	trait	The address to send expired messages to.	expiry-address
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Selector	trait	The queue selector.	selector
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

Table 3.440.
Name	Description	Required	Internal Name
Entries	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.441. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.1.12.3.1.2. JBossAS7 - JMS Topic Runtime Service

Overview

Table 3.442. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.443.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.444. Metrics
Name	Type	Description	Internal Name
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable Message Count	measurement	The number of messages for all durable subscribers for this topic.	durable-message-count
Durable Subscription Count	measurement	The number of durable subscribers for this topic.	durable-subscription-count
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Non Durable Message Count	measurement	The number of messages for all non-durable subscribers for this topic.	non-durable-message-count
Non Durable Subscription Count	measurement	The number of non-durable subscribers for this topic.	non-durable-subscription-count
Subscription Count	measurement	The number of (durable and non-durable) subscribers for this topic.	subscription-count
Temporary	trait	Whether the topic is temporary.	temporary
Topic Address	trait	The address the topic points to.	topic-address

Note

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

Configuration Properties

Table 3.445.
Name	Description	Required	Internal Name
JNDI Names	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.446. Metrics
Name	Description
Count Messages for Subscription	Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions	Drop all subscriptions from this topic.
Drop Durable Subscription	Drop a durable subscription
List All Subscriptions	List all subscriptions.
List All Subscriptions as JSON	List all subscriptions as a string in JSON format.
List Durable Subscriptions	List only the durable subscriptions.
List Durable Subscriptions as JSON	List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription	List all the messages for the given subscription.
List Messages for Subscription as JSON	List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions	List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON	List only the non-durable subscriptions, as a string in JSON format.
Remove Messages	Remove messages matching the given filter from the destination.

Package Types

none

3.3.1.12.4. JBossAS7 - Subdeployment Service

Overview

Table 3.447. Overview
Description:	Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.1, “JBossAS7 - Webservices Runtime Service”
Section 3.3.1.12.4.2, “JBossAS7 - Web Runtime Service”
Section 3.3.1.12.4.3, “JBossAS7 - Messaging Runtime Service”
Section 3.3.1.12.4.4, “JBossAS7 - JPA Runtime Service”
Section 3.3.1.12.4.5, “JBossAS7 - Datasources Runtime Service”
Section 3.3.1.12.4.6, “JBossAS7 - EJB3 Runtime Service”
Section 3.3.1.12.4.7, “JBossAS7 - Resource Adapters Runtime Service”

Connection Properties

Table 3.448.
Name	Description	Required	Internal 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.3.1.12.4.1. JBossAS7 - Webservices Runtime Service

Overview

Table 3.449. Overview
Description:	Runtime resources exposed by web service components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.1.1, “JBossAS7 - Endpoint Runtime Service”

Connection Properties

Table 3.450.
Name	Description	Required	Internal 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.3.1.12.4.1.1. JBossAS7 - Endpoint Runtime Service

Overview

Table 3.451. Overview
Description:	Webservice endpoint.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.452.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.453. Metrics
Name	Type	Description	Internal Name
Average Processing Time	measurement	Average endpoint processing time.	average-processing-time
Fault Count	measurement	Count of faults the endpoint generated.	fault-count
Max Processing Time	measurement	Maximal endpoint processing time.	max-processing-time
Min Processing Time	measurement	Minimal endpoint processing time.	min-processing-time
Request Count	measurement	Count of requests the endpoint processed.	request-count
Response Count	measurement	Count of responses the endpoint generated.	response-count
Total Processing Time	measurement	Total endpoint processing time.	total-processing-time

Note

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

Configuration Properties

Table 3.454.
Name	Description	Required	Internal Name
Class	Webservice endpoint class.	no	class
Context	Webservice endpoint context.	no	context
Name	Webservice endpoint name.	no	name
Type	Webservice endpoint type.	no	type
Wsdl Url	Webservice endpoint WSDL URL.	no	wsdl-url

Note

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

Operations

none

Package Types

none

3.3.1.12.4.2. JBossAS7 - Web Runtime Service

Overview

Table 3.455. Overview
Description:	Runtime resources exposed by web components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.456.
Name	Description	Required	Internal Name
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Path		yes	path

Note

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

Metrics

Table 3.457. Metrics
Name	Type	Description	Internal Name
Virtual Host	trait	the virtual host this webapp is deployed to	virtual-host
Context Root	trait	the context root of this webapp	context-root
Response Time	calltime	the minimum, maximum, and average response times for requests serviced by this webapp	responseTime
Currently Active Sessions	measurement	The number of sessions that are currently active	active-sessions
Duplicated Session Ids	measurement	The number of duplicated session identifiers	duplicated-session-ids
Expired Sessions	measurement	The number of expired sessions	expired-sessions
Expired Sessions per Minute	measurement	The number of expired sessions	expired-sessions
Maximum Active Sessions	measurement	The maximum number of sessions that have been active	max-active-sessions
Rejected Sessions	measurement	The number of sessions rejected	rejected-sessions
Rejected Sessions per Minute	measurement	The number of sessions rejected	rejected-sessions
Average Session Alive Time	measurement	The average alive time of sessions	session-avg-alive-time
Max Session Alive Time	measurement	The maximum alive time of sessions	session-max-alive-time
Created Sessions	measurement	The number of sessions created	sessions-created
Created Sessions per Minute	measurement	The number of sessions created	sessions-created

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.4.3. JBossAS7 - Messaging Runtime Service

Overview

Table 3.458. Overview
Description:	Runtime resources exposed by messaging resources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.3.1, “JBossAS7 - HornetQ Server Runtime Service”

Connection Properties

Table 3.459.
Name	Description	Required	Internal 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.3.1.12.4.3.1. JBossAS7 - HornetQ Server Runtime Service

Overview

Table 3.460. Overview
Description:	A HornetQ server instance.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.3.1.1, “JBossAS7 - JMS Queue Runtime Service”
Section 3.3.1.12.4.3.1.2, “JBossAS7 - JMS Topic Runtime Service”

Connection Properties

Table 3.461.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.462. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this server is started.	started
Version	trait	The server's version.	version

Note

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

Configuration Properties

Table 3.463.
Name	Description	Required	Internal Name
Allow Failback	Whether this server will automatically shutdown if the original live server comes back up. The default value is true.	no	allow-failback
Async Connection Execution Enabled	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true.	no	async-connection-execution-enabled
Backup	Whether this server is a backup server. The default value is false.	no	backup
Cluster Password	The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!.	no	cluster-password
Cluster User	The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	cluster-user
Clustered	Whether the server is clustered. The default value is false.	no	clustered
Connection Ttl Override	If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1.	no	connection-ttl-override
Create Bindings Dir	Whether the server should create the bindings directory on start up. The default value is true.	no	create-bindings-dir
Create Journal Dir	Whether the server should create the journal directory on start up. The default value is true.	no	create-journal-dir
Failback Delay	How long to wait before failback occurs on live server restart. The default value is 5000.	no	failback-delay
Failover On Shutdown	Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false.	no	failover-on-shutdown
Id Cache Size	The size of the cache for pre-creating message IDs. The default value is 2000.	no	id-cache-size
Jmx Domain	The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq.	no	jmx-domain
Jmx Management Enabled	Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false.	no	jmx-management-enabled
Journal Buffer Size	The size of the internal buffer on the journal.	no	journal-buffer-size
Journal Buffer Timeout	The timeout (in nanoseconds) used to flush internal buffers on the journal.	no	journal-buffer-timeout
Journal Compact Min Files	The minimal number of journal data files before we can start compacting. The default value is 10.	no	journal-compact-min-files
Journal Compact Percentage	The percentage of live data on which we consider compacting the journal. The default value is 30.	no	journal-compact-percentage
Journal File Size	The size (in bytes) of each journal file. The default value is 10485760.	no	journal-file-size
Journal Max Io	The maximum number of write requests that can be in the AIO queue at any one time.	no	journal-max-io
Journal Min Files	How many journal files to pre-create. The default value is 2.	no	journal-min-files
Journal Sync Non Transactional	Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true.	no	journal-sync-non-transactional
Journal Sync Transactional	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true.	no	journal-sync-transactional
Journal Type	The type of journal to use. The default value is ASYNCIO.	no	journal-type
Live Connector Ref	The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'.	no	live-connector-ref
Log Journal Write Rate	Whether to periodically log the journal's write rate and flush rate. The default value is false.	no	log-journal-write-rate
Management Address	Address to send management messages to. The default value is jms.queue.hornetq.management.	no	management-address
Management Notification Address	The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications.	no	management-notification-address
Memory Measure Interval	Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1.	no	memory-measure-interval:expr
Memory Warning Threshold	Percentage of available memory which if exceeded results in a warning log. The default value is 25.	no	memory-warning-threshold:expr
Message Counter Enabled	Whether message counters are enabled. The default value is false.	no	message-counter-enabled
Message Counter Max Day History	How many days to keep message counter history. The default value is 10.	no	message-counter-max-day-history
Message Counter Sample Period	The sample period (in ms) to use for message counters. The default value is 10000.	no	message-counter-sample-period
Message Expiry Scan Period	How often (in ms) to scan for expired messages. The default value is 30000.	no	message-expiry-scan-period
Message Expiry Thread Priority	The priority of the thread expiring messages. The default value is 3.	no	message-expiry-thread-priority
Page Max Concurrent Io	The maximum number of concurrent reads allowed on paging. The default value is 5.	no	page-max-concurrent-io
Perf Blast Pages	TODO. The default value is -1.	no	perf-blast-pages
Persist Delivery Count Before Delivery	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false.	no	persist-delivery-count-before-delivery
Persist Id Cache	Whether IDs are persisted to the journal. The default value is true.	no	persist-id-cache
Persistence Enabled	Whether the server will use the file based journal for persistence. The default value is true.	no	persistence-enabled
Remoting Interceptors	The list of interceptor classes used by this server.	no	remoting-interceptors:nullable
Run Sync Speed Test	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false.	no	run-sync-speed-test
Scheduled Thread Pool Max Size	The number of threads that the main scheduled thread pool has. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Security Domain	The security domain to use to verify user and role information. The default value is other.	no	security-domain
Security Enabled	Whether security is enabled. The default value is true.	no	security-enabled
Security Invalidation Interval	How long (in ms) to wait before invalidating the security cache. The default value is 10000.	no	security-invalidation-interval
Server Dump Interval	How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1.	no	server-dump-interval
Shared Store	Whether this server is using a shared store for failover. The default value is true.	no	shared-store
Thread Pool Max Size	The number of threads that the main thread pool has. -1 means no limit. The default value is 30.	no	thread-pool-max-size:expr
Transaction Timeout	How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000.	no	transaction-timeout
Transaction Timeout Scan Period	How often (in ms) to scan for timeout transactions. The default value is 1000.	no	transaction-timeout-scan-period
Wild Card Routing Enabled	Whether the server supports wild card routing. The default value is true.	no	wild-card-routing-enabled

Note

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

Operations

Table 3.464. Metrics
Name	Description
Close Connections for Address	Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction	Heuristically commits a prepared transaction.
Force Failover	Force the messaging server to stop and notify clients to failover.
Get Address Settings as JSON	Returns the address settings as a JSON string for an address match. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON	Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID	Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time	Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON	Lists all the consumers.
List Connection IDs	Lists the IDs of all the connections connected to this server.
List Connections as JSON	List all JMS connections.
List Consumers as JSON	Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions	Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions	Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML	List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON	List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML	List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON	List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions	List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
List Producers Info as JSON	For all sessions, lists information about message producers using JSON serialization.
List Remote Addresses	Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List Sessions	Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON	Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations	Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories	Reset all message counters history.
Reset All Message Counters	Reset all message counters.
Rollback Prepared Transaction	Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.

Package Types

none

3.3.1.12.4.3.1.1. JBossAS7 - JMS Queue Runtime Service

Overview

Table 3.465. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.466.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.467. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable	trait	Whether the queue is durable or not. The default value is true.	durable
Expiry Address	trait	The address to send expired messages to.	expiry-address
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Selector	trait	The queue selector.	selector
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

Table 3.468.
Name	Description	Required	Internal Name
Entries	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.469. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.1.12.4.3.1.2. JBossAS7 - JMS Topic Runtime Service

Overview

Table 3.470. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.471.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.472. Metrics
Name	Type	Description	Internal Name
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable Message Count	measurement	The number of messages for all durable subscribers for this topic.	durable-message-count
Durable Subscription Count	measurement	The number of durable subscribers for this topic.	durable-subscription-count
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Non Durable Message Count	measurement	The number of messages for all non-durable subscribers for this topic.	non-durable-message-count
Non Durable Subscription Count	measurement	The number of non-durable subscribers for this topic.	non-durable-subscription-count
Subscription Count	measurement	The number of (durable and non-durable) subscribers for this topic.	subscription-count
Temporary	trait	Whether the topic is temporary.	temporary
Topic Address	trait	The address the topic points to.	topic-address

Note

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

Configuration Properties

Table 3.473.
Name	Description	Required	Internal Name
JNDI Names	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.474. Metrics
Name	Description
Count Messages for Subscription	Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions	Drop all subscriptions from this topic.
Drop Durable Subscription	Drop a durable subscription
List All Subscriptions	List all subscriptions.
List All Subscriptions as JSON	List all subscriptions as a string in JSON format.
List Durable Subscriptions	List only the durable subscriptions.
List Durable Subscriptions as JSON	List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription	List all the messages for the given subscription.
List Messages for Subscription as JSON	List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions	List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON	List only the non-durable subscriptions, as a string in JSON format.
Remove Messages	Remove messages matching the given filter from the destination.

Package Types

none

3.3.1.12.4.4. JBossAS7 - JPA Runtime Service

Overview

Table 3.475. Overview
Description:	The configuration of the JPA subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.4.1, “JBossAS7 - Hibernate Persistence Unit Service”

Connection Properties

Table 3.476.
Name	Description	Required	Internal 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.3.1.12.4.4.1. JBossAS7 - Hibernate Persistence Unit Service

Overview

Table 3.477. Overview
Description:	Runtime information about JPA use in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.4.1.1, “JBossAS7 - Entity Cache Service”
Section 3.3.1.12.4.4.1.2, “JBossAS7 - Entity Service”
Section 3.3.1.12.4.4.1.3, “JBossAS7 - Collection Service”

Connection Properties

Table 3.478.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.479. Metrics
Name	Type	Description	Internal Name
Close Statement Count	measurement	Number of released prepared statements.	close-statement-count
Close Statement Count per Minute	measurement	Number of released prepared statements.	close-statement-count
Collection Fetch Count	measurement	Number of collections fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of collections fetched.	collection-fetch-count
Collection Load Count	measurement	Number of collections loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of collections loaded.	collection-load-count
Collection Recreated Count	measurement	Number of collections recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of collections recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of collections removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of collections removed.	collection-remove-count
Collection Update Count	measurement	Number of collections updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of collections updated.	collection-update-count
Completed Transaction Count	measurement	Number of completed transactions.	completed-transaction-count
Completed Transaction Count per Minute	measurement	Number of completed transactions.	completed-transaction-count
Connect Count	measurement	Get the number of connections asked for by the sessions.	connect-count
Connect Count per Minute	measurement	Get the number of connections asked for by the sessions.	connect-count
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Flush Count	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Flush Count per Minute	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Prepared Statement Count	measurement	Number of acquired prepared statements.	prepared-statement-count
Prepared Statement Count per Minute	measurement	Number of acquired prepared statements.	prepared-statement-count
Query Cache Hit Count	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Hit Count per Minute	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Miss Count	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Miss Count per Minute	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Put Count	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Cache Put Count per Minute	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Execution Count	measurement	Get number of executed queries.	query-execution-count
Query Execution Count per Minute	measurement	Get number of executed queries.	query-execution-count
Query Execution Max Time	measurement	Get the time in milliseconds of the slowest query.	query-execution-max-time
Query Execution Max Time Query String	trait	Get the query string for the slowest query.	query-execution-max-time-query-string
Second Level Cache Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Hit Count per Minute	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Miss Count per Minute	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Put Count	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Second Level Cache Put Count per Minute	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Session Close Count	measurement	Number of sessions closed.	session-close-count
Session Close Count per Minute	measurement	Number of sessions closed.	session-close-count
Session Open Count	measurement	Number of sessions opened.	session-open-count
Session Open Count per Minute	measurement	Number of sessions opened.	session-open-count
Successful Transaction Count	measurement	Number of successful transactions.	successful-transaction-count
Successful Transaction Count per Minute	measurement	Number of successful transactions.	successful-transaction-count

Note

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

Configuration Properties

Table 3.480.
Name	Description	Required	Internal Name
Enabled	Determine if statistics are enabled.	no	enabled

Note

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

Operations

Table 3.481. Metrics
Name	Description
Subsystem:clear	Clear statistics.
Subsystem:evict All	Evict all entities from second level cache.
Subsystem:summary	Log the statistics.
View Queries	View statistical information about queries executed by Hibernate

Package Types

none

3.3.1.12.4.4.1.1. JBossAS7 - Entity Cache Service

Overview

Table 3.482. Overview
Description:	Statistics for a Hibernate Second Level Cache region.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.483.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.484. Metrics
Name	Type	Description	Internal Name
Element Count In Memory	measurement	Number of cacheable entities/collections currently stored in memory.	element-count-in-memory
Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	hit-count
Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	miss-count
Put Count	measurement	Number of cacheable entities/collections put in the cache.	put-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.4.4.1.2. JBossAS7 - Entity Service

Overview

Table 3.485. Overview
Description:	Statistics for individual entities.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.486.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.487. Metrics
Name	Type	Description	Internal Name
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.4.4.1.3. JBossAS7 - Collection Service

Overview

Table 3.488. Overview
Description:	Statistics for individual collections.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.489.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.490. Metrics
Name	Type	Description	Internal Name
Collection Fetch Count	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Load Count	measurement	Number of times collection was loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of times collection was loaded.	collection-load-count
Collection Recreated Count	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of times collection was removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of times collection was removed.	collection-remove-count
Collection Update Count	measurement	Number of times collection was updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of times collection was updated.	collection-update-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.4.5. JBossAS7 - Datasources Runtime Service

Overview

Table 3.491. Overview
Description:	Runtime resources exposed by data sources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.5.1, “JBossAS7 - XA Datasource Runtime Service”
Section 3.3.1.12.4.5.2, “JBossAS7 - Datasource Runtime Service”

Connection Properties

Table 3.492.
Name	Description	Required	Internal 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.3.1.12.4.5.1. JBossAS7 - XA Datasource Runtime Service

Overview

Table 3.493. Overview
Description:	A JDBC XA data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.494.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.495. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.496.
Name	Description	Required	Internal Name
Properties		no	*2
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Interleaving	An element to enable interleaving for XA connections. The default value is false.	no	interleaving
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
No Recovery	Specifies if the connection pool should be excluded from recovery	no	no-recovery
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false.	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded. The default value is false.	no	pad-xid
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Recovery Password	The password used for recovery	no	recovery-password
Recovery Plugin Class Name	The fully qualified class name of the recovery plugin implementation	no	recovery-plugin-class-name
Recovery Plugin Properties	The properties for the recovery plugin	no	recovery-plugin-properties
Recovery Security Domain	The security domain used for recovery	no	recovery-security-domain
Recovery Username	The user name used for recovery	no	recovery-username
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match
Wrap Xa Resource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true.	no	wrap-xa-resource
Xa Datasource Class	The fully qualifed name of the javax.sql.XADataSource implementation	no	xa-datasource-class
Xa Resource Timeout	The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero	no	xa-resource-timeout

Note

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

Operations

Table 3.497. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.1.12.4.5.2. JBossAS7 - Datasource Runtime Service

Overview

Table 3.498. Overview
Description:	A JDBC data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.499.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.500. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.501.
Name	Description	Required	Internal Name
Connection Property		no	*1
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Connection Url	The JDBC driver connection URL	no	connection-url
Datasource Class	The fully qualifed name of the JDBC datasource class	no	datasource-class
Driver Class	The fully qualifed name of the JDBC driver class	no	driver-class
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match

Note

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

Operations

Table 3.502. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.1.12.4.6. JBossAS7 - EJB3 Runtime Service

Overview

Table 3.503. Overview
Description:	Runtime resources exposed by EJBs components included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.6.1, “JBossAS7 - Message Driven Bean Runtime Service”
Section 3.3.1.12.4.6.2, “JBossAS7 - Singleton Bean Runtime Service”
Section 3.3.1.12.4.6.3, “JBossAS7 - Stateless Session Bean Runtime Service”
Section 3.3.1.12.4.6.4, “JBossAS7 - Entity Bean Runtime Service”
Section 3.3.1.12.4.6.5, “JBossAS7 - Stateful Session Bean Runtime Service”

Connection Properties

Table 3.504.
Name	Description	Required	Internal 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.3.1.12.4.6.1. JBossAS7 - Message Driven Bean Runtime Service

Overview

Table 3.505. Overview
Description:	Bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.506.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.507. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.508.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.1.12.4.6.2. JBossAS7 - Singleton Bean Runtime Service

Overview

Table 3.509. Overview
Description:	Singleton bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.510.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.511. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.512.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.1.12.4.6.3. JBossAS7 - Stateless Session Bean Runtime Service

Overview

Table 3.513. Overview
Description:	Stateless session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.514.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.515. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.516.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.1.12.4.6.4. JBossAS7 - Entity Bean Runtime Service

Overview

Table 3.517. Overview
Description:	Entity bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.518.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.519. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.520.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.1.12.4.6.5. JBossAS7 - Stateful Session Bean Runtime Service

Overview

Table 3.521. Overview
Description:	Stateful session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.522.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.523. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.524.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.1.12.4.7. JBossAS7 - Resource Adapters Runtime Service

Overview

Table 3.525. Overview
Description:	Configuration of the resource adapters subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.4.7.1, “JBossAS7 - Connection Definition Runtime Service”

Connection Properties

Table 3.526.
Name	Description	Required	Internal 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.3.1.12.4.7.1. JBossAS7 - Connection Definition Runtime Service

Overview

Table 3.527. Overview
Description:	Specifies the connection definitions.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.528.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.529. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.5. JBossAS7 - JPA Runtime Service

Overview

Table 3.530. Overview
Description:	The configuration of the JPA subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.5.1, “JBossAS7 - Hibernate Persistence Unit Service”

Connection Properties

Table 3.531.
Name	Description	Required	Internal 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.3.1.12.5.1. JBossAS7 - Hibernate Persistence Unit Service

Overview

Table 3.532. Overview
Description:	Runtime information about JPA use in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.5.1.1, “JBossAS7 - Entity Cache Service”
Section 3.3.1.12.5.1.2, “JBossAS7 - Entity Service”
Section 3.3.1.12.5.1.3, “JBossAS7 - Collection Service”

Connection Properties

Table 3.533.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.534. Metrics
Name	Type	Description	Internal Name
Close Statement Count	measurement	Number of released prepared statements.	close-statement-count
Close Statement Count per Minute	measurement	Number of released prepared statements.	close-statement-count
Collection Fetch Count	measurement	Number of collections fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of collections fetched.	collection-fetch-count
Collection Load Count	measurement	Number of collections loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of collections loaded.	collection-load-count
Collection Recreated Count	measurement	Number of collections recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of collections recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of collections removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of collections removed.	collection-remove-count
Collection Update Count	measurement	Number of collections updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of collections updated.	collection-update-count
Completed Transaction Count	measurement	Number of completed transactions.	completed-transaction-count
Completed Transaction Count per Minute	measurement	Number of completed transactions.	completed-transaction-count
Connect Count	measurement	Get the number of connections asked for by the sessions.	connect-count
Connect Count per Minute	measurement	Get the number of connections asked for by the sessions.	connect-count
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Flush Count	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Flush Count per Minute	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Prepared Statement Count	measurement	Number of acquired prepared statements.	prepared-statement-count
Prepared Statement Count per Minute	measurement	Number of acquired prepared statements.	prepared-statement-count
Query Cache Hit Count	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Hit Count per Minute	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Miss Count	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Miss Count per Minute	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Put Count	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Cache Put Count per Minute	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Execution Count	measurement	Get number of executed queries.	query-execution-count
Query Execution Count per Minute	measurement	Get number of executed queries.	query-execution-count
Query Execution Max Time	measurement	Get the time in milliseconds of the slowest query.	query-execution-max-time
Query Execution Max Time Query String	trait	Get the query string for the slowest query.	query-execution-max-time-query-string
Second Level Cache Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Hit Count per Minute	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Miss Count per Minute	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Put Count	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Second Level Cache Put Count per Minute	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Session Close Count	measurement	Number of sessions closed.	session-close-count
Session Close Count per Minute	measurement	Number of sessions closed.	session-close-count
Session Open Count	measurement	Number of sessions opened.	session-open-count
Session Open Count per Minute	measurement	Number of sessions opened.	session-open-count
Successful Transaction Count	measurement	Number of successful transactions.	successful-transaction-count
Successful Transaction Count per Minute	measurement	Number of successful transactions.	successful-transaction-count

Note

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

Configuration Properties

Table 3.535.
Name	Description	Required	Internal Name
Enabled	Determine if statistics are enabled.	no	enabled

Note

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

Operations

Table 3.536. Metrics
Name	Description
Subsystem:clear	Clear statistics.
Subsystem:evict All	Evict all entities from second level cache.
Subsystem:summary	Log the statistics.
View Queries	View statistical information about queries executed by Hibernate

Package Types

none

3.3.1.12.5.1.1. JBossAS7 - Entity Cache Service

Overview

Table 3.537. Overview
Description:	Statistics for a Hibernate Second Level Cache region.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.538.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.539. Metrics
Name	Type	Description	Internal Name
Element Count In Memory	measurement	Number of cacheable entities/collections currently stored in memory.	element-count-in-memory
Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	hit-count
Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	miss-count
Put Count	measurement	Number of cacheable entities/collections put in the cache.	put-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.5.1.2. JBossAS7 - Entity Service

Overview

Table 3.540. Overview
Description:	Statistics for individual entities.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.541.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.542. Metrics
Name	Type	Description	Internal Name
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.5.1.3. JBossAS7 - Collection Service

Overview

Table 3.543. Overview
Description:	Statistics for individual collections.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.544.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.545. Metrics
Name	Type	Description	Internal Name
Collection Fetch Count	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Load Count	measurement	Number of times collection was loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of times collection was loaded.	collection-load-count
Collection Recreated Count	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of times collection was removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of times collection was removed.	collection-remove-count
Collection Update Count	measurement	Number of times collection was updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of times collection was updated.	collection-update-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.12.6. JBossAS7 - Datasources Runtime Service

Overview

Table 3.546. Overview
Description:	Runtime resources exposed by data sources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.6.1, “JBossAS7 - XA Datasource Runtime Service”
Section 3.3.1.12.6.2, “JBossAS7 - Datasource Runtime Service”

Connection Properties

Table 3.547.
Name	Description	Required	Internal 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.3.1.12.6.1. JBossAS7 - XA Datasource Runtime Service

Overview

Table 3.548. Overview
Description:	A JDBC XA data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.549.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.550. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.551.
Name	Description	Required	Internal Name
Properties		no	*2
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Interleaving	An element to enable interleaving for XA connections. The default value is false.	no	interleaving
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
No Recovery	Specifies if the connection pool should be excluded from recovery	no	no-recovery
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false.	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded. The default value is false.	no	pad-xid
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Recovery Password	The password used for recovery	no	recovery-password
Recovery Plugin Class Name	The fully qualified class name of the recovery plugin implementation	no	recovery-plugin-class-name
Recovery Plugin Properties	The properties for the recovery plugin	no	recovery-plugin-properties
Recovery Security Domain	The security domain used for recovery	no	recovery-security-domain
Recovery Username	The user name used for recovery	no	recovery-username
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match
Wrap Xa Resource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true.	no	wrap-xa-resource
Xa Datasource Class	The fully qualifed name of the javax.sql.XADataSource implementation	no	xa-datasource-class
Xa Resource Timeout	The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero	no	xa-resource-timeout

Note

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

Operations

Table 3.552. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.1.12.6.2. JBossAS7 - Datasource Runtime Service

Overview

Table 3.553. Overview
Description:	A JDBC data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.554.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.555. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.556.
Name	Description	Required	Internal Name
Connection Property		no	*1
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Connection Url	The JDBC driver connection URL	no	connection-url
Datasource Class	The fully qualifed name of the JDBC datasource class	no	datasource-class
Driver Class	The fully qualifed name of the JDBC driver class	no	driver-class
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match

Note

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

Operations

Table 3.557. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.1.12.7. JBossAS7 - EJB3 Runtime Service

Overview

Table 3.558. Overview
Description:	Runtime resources exposed by EJBs components included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.7.1, “JBossAS7 - Message Driven Bean Runtime Service”
Section 3.3.1.12.7.2, “JBossAS7 - Singleton Bean Runtime Service”
Section 3.3.1.12.7.3, “JBossAS7 - Stateless Session Bean Runtime Service”
Section 3.3.1.12.7.4, “JBossAS7 - Entity Bean Runtime Service”
Section 3.3.1.12.7.5, “JBossAS7 - Stateful Session Bean Runtime Service”

Connection Properties

Table 3.559.
Name	Description	Required	Internal 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.3.1.12.7.1. JBossAS7 - Message Driven Bean Runtime Service

Overview

Table 3.560. Overview
Description:	Bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.561.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.562. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.563.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.1.12.7.2. JBossAS7 - Singleton Bean Runtime Service

Overview

Table 3.564. Overview
Description:	Singleton bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.565.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.566. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.567.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.1.12.7.3. JBossAS7 - Stateless Session Bean Runtime Service

Overview

Table 3.568. Overview
Description:	Stateless session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.569.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.570. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.571.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.1.12.7.4. JBossAS7 - Entity Bean Runtime Service

Overview

Table 3.572. Overview
Description:	Entity bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.573.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.574. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.575.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.1.12.7.5. JBossAS7 - Stateful Session Bean Runtime Service

Overview

Table 3.576. Overview
Description:	Stateful session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.577.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.578. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.579.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.1.12.8. JBossAS7 - Resource Adapters Runtime Service

Overview

Table 3.580. Overview
Description:	Configuration of the resource adapters subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.12.8.1, “JBossAS7 - Connection Definition Runtime Service”

Connection Properties

Table 3.581.
Name	Description	Required	Internal 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.3.1.12.8.1. JBossAS7 - Connection Definition Runtime Service

Overview

Table 3.582. Overview
Description:	Specifies the connection definitions.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.583.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.584. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.1.13. JBossAS7 - DeploymentScanner Service

Overview

Table 3.585. Overview
Description:	Management of the deployment scanner
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.586.
Name	Description	Required	Internal 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.587.
Name	Description	Required	Internal Name
Scanners	List of scanners	yes	*

Note

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

Operations

none

Package Types

none

3.3.1.14. JBossAS7 - JacORB Service

Overview

Table 3.588. Overview
Description:	JacORB subsystem configuration
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.589.
Name	Description	Required	Internal 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.590.
Name	Description	Required	Internal Name
Add Component Via Interceptor	Indicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is on.	no	add-component-via-interceptor
Cache Poa Names	Indicates whether POA names should be cached (on) or not (off). The default value is off.	no	cache-poa-names
Cache Typecodes	Indicates whether typecodes should be cached (on) or not (off). The default value is off.	no	cache-typecodes
Chunk Custom Rmi Valuetypes	Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on.	no	chunk-custom-rmi-valuetypes
Client Requires	Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None.	no	client-requires
Client Supports	Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth.	no	client-supports
Client Timeout	The client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0.	no	client-timeout
Comet	Indicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off.	no	comet
Export Corbaloc	Indicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is on.	no	export-corbaloc
Giop Minor Version	The GIOP minor version to be used. The default value is 2.	no	giop-minor-version
Indirection Encoding Disable	Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off.	no	indirection-encoding-disable
Iona	Indicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off.	no	iona
Lax Boolean Encoding	Indicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off). The default value is off.	no	lax-boolean-encoding
Max Managed Buf Size	The log2 of maximum size managed by the internal buffer manager. The default value is 24.	no	max-managed-buf-size
Max Server Connections	The maximum number of connections accepted by the server. The default value is 2147483647.	no	max-server-connections
Max Threads	The maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job. The default value is 32.	no	max-threads
Monitoring	Indicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off.	no	monitoring
Name	The name of the running ORB. The default value is JBoss.	no	name
Outbuf Cache Timeout	The buffer cache timeout in milliseconds. The default value is -1.	no	outbuf-cache-timeout
Outbuf Size	The size of the network buffers for outgoing messages. The default value is 2048.	no	outbuf-size
Pool Size	The size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise. The default value is 5.	no	pool-size
Print Version	Indicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off.	no	print-version
Properties	A list of generic key/value properties.	no	properties
Queue Max	The maximum number of requests that can be queued. The default value is 100.	no	queue-max
Queue Min	The size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests. The default value is 10.	no	queue-min
Queue Wait	Indicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full. The default value is off.	no	queue-wait
Retries	The number of retries if connections cannot be promptly established. The default value is 5.	no	retries
Retry Interval	The interval in milliseconds between retries. The default value is 500.	no	retry-interval
Root Context	The naming service root context. The default value is JBoss/Naming/root.	no	root-context
Security	Indicates whether the security interceptors are to be installed (on) or not (off). The default value is off.	no	security
Security Domain	The name of the security domain that holds the key and trust stores that will be used to establish SSL connections.	no	security-domain
Server Requires	Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None.	no	server-requires
Server Supports	Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth.	no	server-supports
Server Timeout	The server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0.	no	server-timeout
Strict Check On Tc Creation	Indicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off). The default value is off.	no	strict-check-on-tc-creation
Sun	Indicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on.	no	sun
Support Ssl	Indicates whether SSL is to be supported (on) or not (off). The default value is off.	no	support-ssl
Transactions	Indicates 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 off.	no	transactions
Use Bom	Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off.	no	use-bom
Use Imr	Indicates whether the implementation repository should be used (on) or not (off). The default value is off.	no	use-imr

Note

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

Operations

none

Package Types

none

3.3.1.15. JBossAS7 - JDR Service

Overview

Table 3.591. Overview
Description:	JBoss Diagnostic Reporter (JDR) Subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.592.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 3.593. Metrics
Name	Description
Generate JDR Report	Request the generation of a JDR report.

Package Types

none

3.3.1.16. JBossAS7 - JCA Service

Overview

Table 3.594. Overview
Description:	The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.16.1, “JBossAS7 - BootstrapContext Service”
Section 3.3.1.16.2, “JBossAS7 - Workmanager Service”

Connection Properties

Table 3.595.
Name	Description	Required	Internal 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.596.
Name	Description	Required	Internal Name
Enabled	Specify whether bean validation is enabled. The default value is true.	no	enabled:1
Enabled	Specify whether archive validation is enabled. The default value is true.	no	enabled:2
Fail On Error	Should an archive validation error report fail the deployment. The default value is true.	no	fail-on-error
Fail On Warn	Should an archive validation warning report fail the deployment. The default value is false.	no	fail-on-warn
Debug	Enable/disable debug information logging. The default value is false.	no	debug
Error	Enable/disable error information logging. The default value is false.	no	error
Install	Enable/disable the cached connection manager valve and interceptor. The default value is false.	no	install

Note

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

Operations

none

Package Types

none

3.3.1.16.1. JBossAS7 - BootstrapContext Service

Overview

Table 3.597. Overview
Description:	Bootstrap context for resource adapters.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.598.
Name	Description	Required	Internal 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.599.
Name	Description	Required	Internal Name
Name	The name of the BootstrapContext	no	name
Workmanager	The WorkManager instance for the BootstrapContext	no	workmanager

Note

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

Operations

none

Package Types

none

3.3.1.16.2. JBossAS7 - Workmanager Service

Overview

Table 3.600. Overview
Description:	WorkManager for resource adapters.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.16.2.1, “JBossAS7 - Long Running Thread Pool Service”
Section 3.3.1.16.2.2, “JBossAS7 - Short Running Thread Pool Service”

Connection Properties

Table 3.601.
Name	Description	Required	Internal 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.602.
Name	Description	Required	Internal Name
Name	The name of the WorkManager	no	name

Note

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

Operations

none

Package Types

none

3.3.1.16.2.1. JBossAS7 - Long Running Thread Pool Service

Overview

Table 3.603. Overview
Description:	Long running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.604.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.605. Metrics
Name	Type	Description	Internal Name
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.	rejected-count

Note

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

Configuration Properties

Table 3.606.
Name	Description	Required	Internal Name
Allow Core Timeout	Whether core threads may time out. The default value is false.	no	allow-core-timeout
Core Threads	The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.	no	core-threads:expr
Handoff Executor	An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.	no	handoff-executor
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	yes	max-threads:expr
Name	The name of the thread pool.	no	name
Queue Length	The queue length.	yes	queue-length:expr
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory

Note

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

Operations

none

Package Types

none

3.3.1.16.2.2. JBossAS7 - Short Running Thread Pool Service

Overview

Table 3.607. Overview
Description:	Short running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.608.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.609. Metrics
Name	Type	Description	Internal Name
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.	rejected-count

Note

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

Configuration Properties

Table 3.610.
Name	Description	Required	Internal Name
Allow Core Timeout	Whether core threads may time out. The default value is false.	no	allow-core-timeout
Core Threads	The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.	no	core-threads:expr
Handoff Executor	An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.	no	handoff-executor
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	yes	max-threads:expr
Name	The name of the thread pool.	no	name
Queue Length	The queue length.	yes	queue-length:expr
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory

Note

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

Operations

none

Package Types

none

3.3.1.17. JBossAS7 - JAXR Service

Overview

Table 3.611. Overview
Description:	The configuration of the JAXR subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.17.1, “JBossAS7 - Property (JAXR) Service”

Connection Properties

Table 3.612.
Name	Description	Required	Internal 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.613.
Name	Description	Required	Internal Name
Class	The JAXR ConnectionFactory implementation class	no	class
Jndi Name	The JNDI name under which the JAXR ConnectionFactory is bound	no	jndi-name

Note

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

Operations

none

Package Types

none

3.3.1.17.1. JBossAS7 - Property (JAXR) Service

Overview

Table 3.614. Overview
Description:	A JAXR property. The identity of the resource defines the property name.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.615.
Name	Description	Required	Internal 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.616.
Name	Description	Required	Internal Name
Value	The JAXR property value.	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.18. JBossAS7 - JPA Service

Overview

Table 3.617. Overview
Description:	The configuration of the JPA subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.618.
Name	Description	Required	Internal 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.619.
Name	Description	Required	Internal Name
Default Datasource	The name of the default global datasource.	no	default-datasource

Note

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

Operations

none

Package Types

none

3.3.1.19. JBossAS7 - CMP Service

Overview

Table 3.620. Overview
Description:	The configuration of the cmp subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.19.1, “JBossAS7 - HiloKeygenerator Service”

Connection Properties

Table 3.621.
Name	Description	Required	Internal 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.3.1.19.1. JBossAS7 - HiloKeygenerator Service

Overview

Table 3.622. Overview
Description:	HiLo based key generators.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.623.
Name	Description	Required	Internal 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.624.
Name	Description	Required	Internal Name
Block Size	The block size	no	block-size
Create Table	Boolean to determine whether to create create the tables	no	create-table
Create Table Ddl	The DDL used to create the table	no	create-table-ddl
Data Source	The datasource used for sequence generation	yes	data-source
Drop Table	Boolean to determine whether to create drop the tables	no	drop-table
Id Column	The ID column name	yes	id-column
Select Hi Ddl	The DDL used to select the hi value	no	select-hi-ddl
Sequence Column	The sequence column name	yes	sequence-column
Sequence Name	The name of the sequence	yes	sequence-name
Table Name	The table name	yes	table-name

Note

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

Operations

none

Package Types

none

3.3.1.20. JBossAS7 - EE Service

Overview

Table 3.625. Overview
Description:	The configuration of the EE subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.626.
Name	Description	Required	Internal 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.627.
Name	Description	Required	Internal Name
Ear Subdeployments Isolated	Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear. The default value is false.	no	ear-subdeployments-isolated
Global Modules	A list of modules that should be made available to all deployments.	no	global-modules

Note

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

Operations

none

Package Types

none

3.3.1.21. JBossAS7 - Security Service

Overview

Table 3.628. Overview
Description:	The configuration of the security subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1, “JBossAS7 - Security Domain Service”
Section 3.3.1.21.2, “JBossAS7 - Vault Service”

Connection Properties

Table 3.629.
Name	Description	Required	Internal 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.630.
Name	Description	Required	Internal Name
Deep Copy Subject Mode	Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads. The default value is false.	no	deep-copy-subject-mode

Note

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

Operations

none

Package Types

none

3.3.1.21.1. JBossAS7 - Security Domain Service

Overview

Table 3.631. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.1, “JBossAS7 - ACL Service”
Section 3.3.1.21.1.2, “JBossAS7 - Audit Service”
Section 3.3.1.21.1.3, “JBossAS7 - Authentication (Classic) Service”
Section 3.3.1.21.1.4, “JBossAS7 - Authentication (Jaspi) Service”
Section 3.3.1.21.1.5, “JBossAS7 - Authorization Service”
Section 3.3.1.21.1.6, “JBossAS7 - Identity Trust Service”
Section 3.3.1.21.1.7, “JBossAS7 - JSSE Service”
Section 3.3.1.21.1.8, “JBossAS7 - Mapping Service”

Connection Properties

Table 3.632.
Name	Description	Required	Internal 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.633.
Name	Description	Required	Internal Name
Cache Type	Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache.	no	cache-type

Note

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

Operations

Table 3.634. Metrics
Name	Description
Flush Cache	Remove entries stored in the authentication cache for this security domain. A single entry can be flushed by using the principal argument with the username as the value. If no argument is passed to the operation, all entries are flushed.
List Cached Principals	Lists the principals stored in the authentication cache for this security domain.

Package Types

none

3.3.1.21.1.1. JBossAS7 - ACL Service

Overview

Table 3.635. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.1.1, “JBossAS7 - Acl Modules Service”

Connection Properties

Table 3.636.
Name	Description	Required	Internal 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.637.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.1.1. JBossAS7 - Acl Modules Service

Overview

Table 3.638. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.1.1.1, “JBossAS7 - Module Options (Acl) Service”

Connection Properties

Table 3.639.
Name	Description	Required	Internal 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.640.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.1.1.1. JBossAS7 - Module Options (Acl) Service

Overview

Table 3.641. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.642.
Name	Description	Required	Internal 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.643.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.1.2. JBossAS7 - Audit Service

Overview

Table 3.644. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.2.1, “JBossAS7 - Provider Modules Service”

Connection Properties

Table 3.645.
Name	Description	Required	Internal 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.646.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code

Note

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

Operations

none

Package Types

none

3.3.1.21.1.2.1. JBossAS7 - Provider Modules Service

Overview

Table 3.647. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.2.1.1, “JBossAS7 - Module Options (Provider Modules) Service”

Connection Properties

Table 3.648.
Name	Description	Required	Internal 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.649.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code

Note

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

Operations

none

Package Types

none

3.3.1.21.1.2.1.1. JBossAS7 - Module Options (Provider Modules) Service

Overview

Table 3.650. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.651.
Name	Description	Required	Internal 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.652.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.1.3. JBossAS7 - Authentication (Classic) Service

Overview

Table 3.653. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.3.1, “JBossAS7 - Login Modules (Classic) Service”

Connection Properties

Table 3.654.
Name	Description	Required	Internal 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.655.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.3.1. JBossAS7 - Login Modules (Classic) Service

Overview

Table 3.656. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.3.1.1, “JBossAS7 - Module Options (Classic) Service”

Connection Properties

Table 3.657.
Name	Description	Required	Internal 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.658.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.3.1.1. JBossAS7 - Module Options (Classic) Service

Overview

Table 3.659. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.660.
Name	Description	Required	Internal 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.661.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.1.4. JBossAS7 - Authentication (Jaspi) Service

Overview

Table 3.662. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.4.1, “JBossAS7 - Login Module Stack Service”

Connection Properties

Table 3.663.
Name	Description	Required	Internal 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.664.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.4.1. JBossAS7 - Login Module Stack Service

Overview

Table 3.665. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.4.1.1, “JBossAS7 - Module Options (Login Module Stack) Service”

Connection Properties

Table 3.666.
Name	Description	Required	Internal 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.667.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.4.1.1. JBossAS7 - Module Options (Login Module Stack) Service

Overview

Table 3.668. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.669.
Name	Description	Required	Internal 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.670.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.1.5. JBossAS7 - Authorization Service

Overview

Table 3.671. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.5.1, “JBossAS7 - Authorization Modules Service”

Connection Properties

Table 3.672.
Name	Description	Required	Internal 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.673.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.5.1. JBossAS7 - Authorization Modules Service

Overview

Table 3.674. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.5.1.1, “JBossAS7 - Module Options (Authorization) Service”

Connection Properties

Table 3.675.
Name	Description	Required	Internal 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.676.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.5.1.1. JBossAS7 - Module Options (Authorization) Service

Overview

Table 3.677. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.678.
Name	Description	Required	Internal 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.679.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.1.6. JBossAS7 - Identity Trust Service

Overview

Table 3.680. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.6.1, “JBossAS7 - Identity Trust Modules Service”

Connection Properties

Table 3.681.
Name	Description	Required	Internal 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.682.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.6.1. JBossAS7 - Identity Trust Modules Service

Overview

Table 3.683. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.6.1.1, “JBossAS7 - Module Options (Identity Trust) Service”

Connection Properties

Table 3.684.
Name	Description	Required	Internal 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.685.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.1.21.1.6.1.1. JBossAS7 - Module Options (Identity Trust) Service

Overview

Table 3.686. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.687.
Name	Description	Required	Internal 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.688.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.1.7. JBossAS7 - JSSE Service

Overview

Table 3.689. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.690.
Name	Description	Required	Internal 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.691.
Name	Description	Required	Internal Name
Cipher Suites	Comma separated list of cipher suites to enable on SSLSockets.	no	cipher-suites
Client Alias	Preferred alias to use when the KeyManager chooses the client alias.	no	client-alias
Client Auth	Boolean attribute to indicate if client's certificates should also be authenticated on the server side.	no	client-auth
Key Manager	JSEE Key Manager factory	no	key-manager
Keystore	Configures a JSSE key store	no	keystore
Protocols	Comma separated list of protocols to enable on SSLSockets.	no	protocols
Server Alias	Preferred alias to use when the KeyManager chooses the server alias.	no	server-alias
Service Auth Token	Token to retrieve PrivateKeys from the KeyStore.	no	service-auth-token
Trust Manager	JSEE Trust Manager factory	no	trust-manager
Truststore	Configures a JSSE trust store	no	truststore

Note

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

Operations

none

Package Types

none

3.3.1.21.1.8. JBossAS7 - Mapping Service

Overview

Table 3.692. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.8.1, “JBossAS7 - Mapping Modules Service”

Connection Properties

Table 3.693.
Name	Description	Required	Internal 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.694.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Type	Type of mapping this module performs. Allowed values are principal, role, attribute or credential..	yes	type

Note

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

Operations

none

Package Types

none

3.3.1.21.1.8.1. JBossAS7 - Mapping Modules Service

Overview

Table 3.695. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.21.1.8.1.1, “JBossAS7 - Module Options (Mapping) Service”

Connection Properties

Table 3.696.
Name	Description	Required	Internal 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.697.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Type	Type of mapping this module performs. Allowed values are principal, role, attribute or credential..	yes	type

Note

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

Operations

none

Package Types

none

3.3.1.21.1.8.1.1. JBossAS7 - Module Options (Mapping) Service

Overview

Table 3.698. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.699.
Name	Description	Required	Internal 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.700.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.1.21.2. JBossAS7 - Vault Service

Overview

Table 3.701. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.702.
Name	Description	Required	Internal 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.703.
Name	Description	Required	Internal Name
Code	Fully Qualified Name of the Security Vault Implementation.	no	code

Note

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

Operations

none

Package Types

none

3.3.1.22. JBossAS7 - Threads Service

Overview

Table 3.704. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.22.1, “JBossAS7 - ThreadFactory Service”
Section 3.3.1.22.2, “JBossAS7 - ThreadPool Service”

Connection Properties

Table 3.705.
Name	Description	Required	Internal 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.3.1.22.1. JBossAS7 - ThreadFactory Service

Overview

Table 3.706. Overview
Description:	A thread factory (implementing java.util.concurrent.ThreadFactory).
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.707.
Name	Description	Required	Internal 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.708.
Name	Description	Required	Internal Name
Group Name	Specifies the name of a thread group to create for this thread factory.	no	group-name
Name	The name of the created thread factory.	no	name
Priority	May be used to specify the thread priority of created threads. The default value is -1.	no	priority:expr
Thread Name Pattern	The template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID.	no	thread-name-pattern

Note

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

Operations

none

Package Types

none

3.3.1.22.2. JBossAS7 - ThreadPool Service

Overview

Table 3.709. Overview
Description:	A thread pool executor
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.710.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.711. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The approximate number of threads that are actively executing tasks.	active-count
Completed Task Count	measurement	The approximate total number of tasks that have completed execution.	completed-task-count
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been rejected.	rejected-count
Task Count	measurement	The approximate total number of tasks that have ever been scheduled for execution.	task-count

Note

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

Configuration Properties

Table 3.712.
Name	Description	Required	Internal Name
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	yes	max-threads:expr
Name	The name of the thread pool.	no	name
Queue Length	The queue length. Required only for Bounded and Blocking Bounded Thread Pools.	no	queue-length:expr
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory
Allow Core Timeout	Whether core threads may time out. The default value is false.	no	allow-core-timeout
Core Threads	The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.	no	core-threads:expr
Handoff Executor	An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.	no	handoff-executor
Thread Pool Type	Thread pool type	yes	__type

Note

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

Operations

none

Package Types

none

3.3.1.23. JBossAS7 - EJB3 Service

Overview

Table 3.713. Overview
Description:	The configuration of the ejb3 subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.23.1, “JBossAS7 - EJB3 Thread Pool Service”
Section 3.3.1.23.2, “JBossAS7 - File Passivation Store Service”
Section 3.3.1.23.3, “JBossAS7 - Strict Max Bean Instance Pool Service”
Section 3.3.1.23.4, “JBossAS7 - SFSB Cache Service”
Section 3.3.1.23.5, “JBossAS7 - Cluster Passivation Store Service”
Section 3.3.1.23.6, “JBossAS7 - Async Service”
Section 3.3.1.23.7, “JBossAS7 - IIOP Service”
Section 3.3.1.23.8, “JBossAS7 - Remote Service”
Section 3.3.1.23.9, “JBossAS7 - Timer Service”

Connection Properties

Table 3.714.
Name	Description	Required	Internal 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.715.
Name	Description	Required	Internal Name
Default Clustered Sfsb Cache	Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level	no	default-clustered-sfsb-cache
Default Entity Bean Instance Pool	Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level	no	default-entity-bean-instance-pool
Default Entity Bean Optimistic Locking	If set to true entity beans will use optimistic locking by default	no	default-entity-bean-optimistic-locking
Default Mdb Instance Pool	Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level	no	default-mdb-instance-pool
Default Resource Adapter Name	Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is hornetq-ra.	no	default-resource-adapter-name
Default Sfsb Cache	Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level	no	default-sfsb-cache
Default Singleton Bean Access Timeout	The default access timeout for singleton beans. The default value is 5000.	no	default-singleton-bean-access-timeout:expr
Default Slsb Instance Pool	Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level	no	default-slsb-instance-pool
Default Stateful Bean Access Timeout	The default access timeout for stateful beans. The default value is 5000.	no	default-stateful-bean-access-timeout:expr
In Vm Remote Interface Invocation Pass By Value	If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value. The default value is true.	no	in-vm-remote-interface-invocation-pass-by-value
Enable Statistics	If set to true, enable the collection of invocation statistics.	no	enable-statistics

Note

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

Operations

none

Package Types

none

3.3.1.23.1. JBossAS7 - EJB3 Thread Pool Service

Overview

Table 3.716. Overview
Description:	A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.717.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.718. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The approximate number of threads that are actively executing tasks.	active-count
Completed Task Count	measurement	The approximate total number of tasks that have completed execution.	completed-task-count
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been rejected.	rejected-count
Task Count	measurement	The approximate total number of tasks that have ever been scheduled for execution.	task-count

Note

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

Configuration Properties

Table 3.719.
Name	Description	Required	Internal Name
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	no	max-threads:expr
Name	The name of the thread pool.	no	name
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory

Note

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

Operations

none

Package Types

none

3.3.1.23.2. JBossAS7 - File Passivation Store Service

Overview

Table 3.720. Overview
Description:	A file system based passivation store.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.721.
Name	Description	Required	Internal 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.722.
Name	Description	Required	Internal Name
Groups Path		no	groups-path
Idle Timeout	The timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300.	no	idle-timeout:expr
Idle Timeout Unit	The unit of idle-timeout. The default value is SECONDS.	no	idle-timeout-unit
Max Size	The maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000.	no	max-size:expr
Relative To		no	relative-to
Sessions Path		no	sessions-path
Subdirectory count		no	subdirectory-count:expr

Note

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

Operations

none

Package Types

none

3.3.1.23.3. JBossAS7 - Strict Max Bean Instance Pool Service

Overview

Table 3.723. Overview
Description:	A bean instance pool with a strict upper limit
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.724.
Name	Description	Required	Internal 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.725.
Name	Description	Required	Internal Name
Max Pool Size	The maximum number of bean instances that the pool can hold at a given point in time. The default value is 20.	no	max-pool-size:expr
Timeout	The maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5.	no	timeout:expr
Timeout Unit	The instance acquisition timeout unit. The default value is MINUTES.	no	timeout-unit

Note

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

Operations

none

Package Types

none

3.3.1.23.4. JBossAS7 - SFSB Cache Service

Overview

Table 3.726. Overview
Description:	A SFSB cache.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.727.
Name	Description	Required	Internal 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.728.
Name	Description	Required	Internal Name
Aliases	The aliases by which this cache may also be referenced	yes	aliases
Passivation Store	The passivation store used by this cache	no	passivation-store

Note

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

Operations

none

Package Types

none

3.3.1.23.5. JBossAS7 - Cluster Passivation Store Service

Overview

Table 3.729. Overview
Description:	A clustered passivation store.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.730.
Name	Description	Required	Internal 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.731.
Name	Description	Required	Internal Name
Bean Cache	The name of the cache used to store bean instances.	no	bean-cache
Cache Container	The name of the cache container used for the bean and client-mappings caches. The default value is ejb.	no	cache-container
Client Mappings Cache	The name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings. The default value is remote-connector-client-mappings.	no	client-mappings-cache
Idle Timeout	The timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300.	no	idle-timeout:expr
Idle Timeout Unit	The unit of idle-timeout. The default value is SECONDS.	no	idle-timeout-unit
Max Size	The maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000.	no	max-size:expr
Passivate Events On Replicate	Indicates whether replication should trigger passivation events on the bean. The default value is true.	no	passivate-events-on-replicate

Note

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

Operations

none

Package Types

none

3.3.1.23.6. JBossAS7 - Async Service

Overview

Table 3.732. Overview
Description:	The EJB3 Asynchronous Invocation Service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.733.
Name	Description	Required	Internal 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.734.
Name	Description	Required	Internal Name
Thread Pool Name	The name of the thread pool which handles asynchronous invocations	no	thread-pool-name

Note

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

Operations

none

Package Types

none

3.3.1.23.7. JBossAS7 - IIOP Service

Overview

Table 3.735. Overview
Description:	The IIOP service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.736.
Name	Description	Required	Internal 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.737.
Name	Description	Required	Internal Name
Enable By Default	If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor	no	enable-by-default
Use Qualified Name	If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb)	no	use-qualified-name

Note

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

Operations

none

Package Types

none

3.3.1.23.8. JBossAS7 - Remote Service

Overview

Table 3.738. Overview
Description:	The EJB3 remote service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.23.8.1, “JBossAS7 - Channel Creation Options Service”

Connection Properties

Table 3.739.
Name	Description	Required	Internal 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.740.
Name	Description	Required	Internal Name
Connector Ref	The name of the connector on which the EJB3 remoting channel is registered	no	connector-ref
Thread Pool Name	The name of the thread pool that handles remote invocations	no	thread-pool-name

Note

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

Operations

none

Package Types

none

3.3.1.23.8.1. JBossAS7 - Channel Creation Options Service

Overview

Table 3.741. Overview
Description:	The options that will be used during the EJB remote channel creation
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.742.
Name	Description	Required	Internal 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.743.
Name	Description	Required	Internal Name
Type	The type of the channel creation option	no	type
Value	The value for the EJB remote channel creation option	no	value

Note

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

Operations

none

Package Types

none

3.3.1.23.9. JBossAS7 - Timer Service

Overview

Table 3.744. Overview
Description:	The EJB timer service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.745.
Name	Description	Required	Internal 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.746.
Name	Description	Required	Internal Name
Path	The directory to store persistent timer information in	no	path
Relative To	The relative path that is used to resolve the timer data store location	no	relative-to
Thread Pool Name	The name of the thread pool used to run timer service invocations	no	thread-pool-name

Note

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

Operations

none

Package Types

none

3.3.1.24. JBossAS7 - JMX Service

Overview

Table 3.747. Overview
Description:	The configuration of the JMX subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.24.1, “JBossAS7 - Remoting Connector Service”

Connection Properties

Table 3.748.
Name	Description	Required	Internal 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.749.
Name	Description	Required	Internal Name
Show Model	Set to 'true' to include MBeans for the model controller resources	no	show-model

Note

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

Operations

none

Package Types

none

3.3.1.24.1. JBossAS7 - Remoting Connector Service

Overview

Table 3.750. Overview
Description:	The configuration of a resource adapter.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.751.
Name	Description	Required	Internal 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.752.
Name	Description	Required	Internal Name
Use Management Endpoint	If true the connector will use the management endpoint, otherwise it will use the remoting subsystem one. The default value is true.	no	use-management-endpoint

Note

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

Operations

none

Package Types

none

3.3.1.25. JBossAS7 - Resource Adapters Service

Overview

Table 3.753. Overview
Description:	Configuration of the resource adapters subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.25.1, “JBossAS7 - Resource Adapter Service”

Connection Properties

Table 3.754.
Name	Description	Required	Internal 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.3.1.25.1. JBossAS7 - Resource Adapter Service

Overview

Table 3.755. Overview
Description:	The configuration of a resource adapter.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.25.1.1, “JBossAS7 - Admin Objects Service”
Section 3.3.1.25.1.2, “JBossAS7 - Connection Definitions Service”
Section 3.3.1.25.1.3, “JBossAS7 - Config Properties Service”

Connection Properties

Table 3.756.
Name	Description	Required	Internal 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.757.
Name	Description	Required	Internal Name
Archive	Specifies the resource adapter archive	yes	archive
Beanvalidationgroups	Specifies the bean validation groups that should be used	no	beanvalidationgroups
Bootstrapcontext	Specifies the unique name of the bootstrap context that should be used	no	bootstrapcontext
Transaction Support	Specifies the transaction support level of the resource adapter	yes	transaction-support

Note

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

Operations

none

Package Types

none

3.3.1.25.1.1. JBossAS7 - Admin Objects Service

Overview

Table 3.758. Overview
Description:	Specifies the administration objects.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.759.
Name	Description	Required	Internal 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.760.
Name	Description	Required	Internal Name
Class Name	Specifies the fully qualified class name of a managed connection factory or admin object	yes	class-name
Enabled	Specifies if the resource adapter should be enabled. The default value is true.	no	enabled
Jndi Name	Specifies the JNDI name for the connection factory or admin object	no	jndi-name
Use Java Context	Setting this to false will bind the object into global JNDI. The default value is true.	no	use-java-context

Note

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

Operations

none

Package Types

none

3.3.1.25.1.2. JBossAS7 - Connection Definitions Service

Overview

Table 3.761. Overview
Description:	Specifies the connection definitions.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.25.1.2.1, “JBossAS7 - Config Properties Service”

Connection Properties

Table 3.762.
Name	Description	Required	Internal 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.763.
Name	Description	Required	Internal Name
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry:expr
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis:expr
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart	no	background-validation-millis:expr
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis:expr
Class Name	Specifies the fully qualified class name of a managed connection factory or admin object	yes	class-name
Enabled	Specifies if the resource adapter should be enabled. The default value is true.	no	enabled
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart.	no	idle-timeout-minutes:expr
Interleaving	An element to enable interleaving for XA connections. The default value is false.	no	interleaving
Jndi Name	Specifies the JNDI name for the connection factory or admin object	no	jndi-name
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size:expr
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size:expr
No Recovery	Specifies if the connection pool should be excluded from recovery	no	no-recovery
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false.	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded. The default value is false.	no	pad-xid
Pool Prefill	Should the pool be prefilled. Changing this value requires a server restart. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Recovery Password	The password used for recovery	no	recovery-password
Recovery Plugin Class Name	The fully qualified class name of the recovery plugin implementation	no	recovery-plugin-class-name
Recovery Plugin Properties	The properties for the recovery plugin	no	recovery-plugin-properties
Recovery Security Domain	The security domain used for recovery	no	recovery-security-domain
Recovery Username	The user name used for recovery	no	recovery-username
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Security Application	Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool	no	security-application
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Security Domain and Application	Indicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool	no	security-domain-and-application
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the object into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock:expr
Wrap Xa Resource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true.	no	wrap-xa-resource
XA Resource Timeout	The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero	no	xa-resource-timeout:expr

Note

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

Operations

Table 3.764. Metrics
Name	Description
Flush All Connections in Pool	Flushes all connections in the pool
Flush Idle Connections in Pool	Flushes all idle connections in the pool
Test Connection in Pool	Test if a connection can be obtained

Package Types

none

3.3.1.25.1.2.1. JBossAS7 - Config Properties Service

Overview

Table 3.765. Overview
Description:	Custom defined config properties.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.766.
Name	Description	Required	Internal 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.767.
Name	Description	Required	Internal Name
Value	Custom defined config property value	no	value

Note

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

Operations

none

Package Types

none

3.3.1.25.1.3. JBossAS7 - Config Properties Service

Overview

Table 3.768. Overview
Description:	Custom defined config properties.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.769.
Name	Description	Required	Internal 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.770.
Name	Description	Required	Internal Name
Value	Custom defined config property value	no	value

Note

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

Operations

none

Package Types

none

3.3.1.26. JBossAS7 - Infinispan Service

Overview

Table 3.771. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.26.1, “JBossAS7 - Cache Container Service”

Connection Properties

Table 3.772.
Name	Description	Required	Internal 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.3.1.26.1. JBossAS7 - Cache Container Service

Overview

Table 3.773. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.26.1.1, “JBossAS7 - Cache Service”
Section 3.3.1.26.1.2, “JBossAS7 - Distributed Cache Service”
Section 3.3.1.26.1.3, “JBossAS7 - Local Cache Service”
Section 3.3.1.26.1.4, “JBossAS7 - Transport Service”

Connection Properties

Table 3.774.
Name	Description	Required	Internal 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.775.
Name	Description	Required	Internal Name
Default Cache	The default infinispan cache	no	default-cache
Aliases	The list of aliases for this cache container	no	aliases
Jndi Name	The jndi name to which to bind this cache container	no	jndi-name
Start	The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Listener Executor	The executor used for the replication queue	no	listener-executor
Eviction Executor	The scheduled executor used for eviction	no	eviction-executor
Module	The module whose class loader should be used when building this cache container's configuration. The default value is org.jboss.as.clustering.infinispan.	no	module
Replication Queue Executor	The executor used for asynchronous cache operations	no	replication-queue-executor

Note

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

Operations

none

Package Types

none

3.3.1.26.1.1. JBossAS7 - Cache Service

Overview

Table 3.776. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.777.
Name	Description	Required	Internal 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.778.
Name	Description	Required	Internal Name
Start	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Batching	If enabled, the invocation batching API will be made available for this cache.	no	batching
Indexing	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.	no	indexing
Jndi Name	The jndi-name to which to bind this cache instance.	no	jndi-name
Mode	Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.	yes	mode
Queue Size	In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.	no	queue-size
Queue Flush Interval	In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.	no	queue-flush-interval
Remote Timeout	In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.	no	remote-timeout
Async Marshalling	If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false.	no	async-marshalling
Module	The module whose class loader should be used when building this cache's configuration.	no	module
Type of cache	Type of cache	yes	__type

Note

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

Operations

none

Package Types

none

3.3.1.26.1.2. JBossAS7 - Distributed Cache Service

Overview

Table 3.779. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.780.
Name	Description	Required	Internal 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.781.
Name	Description	Required	Internal Name
Start	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Batching	If enabled, the invocation batching API will be made available for this cache.	no	batching
Indexing	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.	no	indexing
Jndi Name	The jndi-name to which to bind this cache instance.	no	jndi-name
Mode	Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.	yes	mode
Queue Size	In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.	no	queue-size
Queue Flush Interval	In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.	no	queue-flush-interval
Remote Timeout	In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.	no	remote-timeout
Async Marshalling	If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false.	no	async-marshalling
L 1 Lifespan	Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored. The default value is 600000.	no	l1-lifespan
Module	The module whose class loader should be used when building this cache's configuration.	no	module
Owners	Number of cluster-wide replicas for each cache entry. The default value is 2.	no	owners
Virtual Nodes	Controls the number of virtual nodes per 'real' node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used. The default value is 1.	no	virtual-nodes

Note

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

Operations

none

Package Types

none

3.3.1.26.1.3. JBossAS7 - Local Cache Service

Overview

Table 3.782. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.783.
Name	Description	Required	Internal 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.784.
Name	Description	Required	Internal Name
Start	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Batching	If enabled, the invocation batching API will be made available for this cache.	no	batching
Indexing	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.	no	indexing
Jndi Name	The jndi-name to which to bind this cache instance.	no	jndi-name
Module	The module whose class loader should be used when building this cache's configuration.	no	module

Note

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

Operations

none

Package Types

none

3.3.1.26.1.4. JBossAS7 - Transport Service

Overview

Table 3.785. Overview
Description:	The description of the transport used by this cache container
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.786.
Name	Description	Required	Internal 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.787.
Name	Description	Required	Internal Name
Cluster	The name of the group communication cluster	no	cluster
Executor	The executor to use for the transport	no	executor
Lock Timeout	The timeout for locks for the transport. The default value is 240000.	no	lock-timeout
Stack	The jgroups stack to use for the transport	no	stack

Note

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

Operations

none

Package Types

none

3.3.1.27. JBossAS7 - JGroups Service

Overview

Table 3.788. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.789.
Name	Description	Required	Internal 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.790.
Name	Description	Required	Internal Name
Default Stack	Default stack to use	yes	default-stack

Note

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

Operations

none

Package Types

none

3.3.1.28. JBossAS7 - Remoting Service

Overview

Table 3.791. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.792.
Name	Description	Required	Internal 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.793.
Name	Description	Required	Internal Name
Worker Read Threads	The number of read threads to create for the remoting worker. The default value is 1.	no	worker-read-threads
Worker Task Core Threads	The number of core threads for the remoting worker task thread pool. The default value is 4.	no	worker-task-core-threads
Worker Task Keepalive	The number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60.	no	worker-task-keepalive
Worker Task Limit	The maximum number of remoting worker tasks to allow before rejecting. The default value is 16384.	no	worker-task-limit
Worker Task Max Threads	The maximum number of threads for the remoting worker task thread pool. The default value is 16.	no	worker-task-max-threads
Worker Write Threads	The number of write threads to create for the remoting worker. The default value is 1.	no	worker-write-threads

Note

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

Operations

none

Package Types

none

3.3.1.29. JBossAS7 - Osgi Service

Overview

Table 3.794. Overview
Description:	The OSGi subsystem configuration.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.29.1, “JBossAS7 - Capability Service”
Section 3.3.1.29.2, “JBossAS7 - Bundle Service”
Section 3.3.1.29.3, “JBossAS7 - Property Service”

Connection Properties

Table 3.795.
Name	Description	Required	Internal 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.796.
Name	Description	Required	Internal Name
Activation	Activation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY.	no	activation
Startlevel	The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly.	no	startlevel

Note

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

Operations

Table 3.797. Metrics
Name	Description
Activate	Activate the OSGi subsystem.

Package Types

none

3.3.1.29.1. JBossAS7 - Capability Service

Overview

Table 3.798. Overview
Description:	A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.799.
Name	Description	Required	Internal 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.800.
Name	Description	Required	Internal Name
Startlevel	The startlevel for the capability. Can only be specified for OSGi bundles.	no	startlevel

Note

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

Operations

none

Package Types

none

3.3.1.29.2. JBossAS7 - Bundle Service

Overview

Table 3.801. Overview
Description:	Runtime bundle information.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.802.
Name	Description	Required	Internal 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.803.
Name	Description	Required	Internal Name
Id	The bundle ID.	no	id
Startlevel	The bundle's start level.	no	startlevel
Symbolic Name	The bundle symbolic name.	no	symbolic-name
Version	The bundle version.	no	version

Note

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

Operations

Table 3.804. Metrics
Name	Description
Start	Starts the bundle.
Stop	Stops the bundle.

Package Types

none

3.3.1.29.3. JBossAS7 - Property Service

Overview

Table 3.805. Overview
Description:	A property
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.806.
Name	Description	Required	Internal 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.807.
Name	Description	Required	Internal Name
Value	The property value.	no	value

Note

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

Operations

none

Package Types

none

3.3.1.30. JBossAS7 - Mail Service

Overview

Table 3.808. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.30.1, “JBossAS7 - Mail Session Service”

Connection Properties

Table 3.809.
Name	Description	Required	Internal 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.3.1.30.1. JBossAS7 - Mail Session Service

Overview

Table 3.810. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.30.1.1, “JBossAS7 - SMTP Mail Server Service”
Section 3.3.1.30.1.2, “JBossAS7 - IMAP Mail Server Service”
Section 3.3.1.30.1.3, “JBossAS7 - POP3 Mail Server Service”

Connection Properties

Table 3.811.
Name	Description	Required	Internal 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.812.
Name	Description	Required	Internal Name
Debug	Enables javamail debugging. The default value is false.	no	debug
From	From address that is used as default from, if not set when sending	no	from
Jndi Name	JNDI name to where mail session should be bound	no	jndi-name

Note

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

Operations

none

Package Types

none

3.3.1.30.1.1. JBossAS7 - SMTP Mail Server Service

Overview

Table 3.813. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.814.
Name	Description	Required	Internal 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.815.
Name	Description	Required	Internal Name
Outbound Socket Binding Ref	Outbound Socket binding to SMTP server	yes	outbound-socket-binding-ref
Password	Password to authenticate on server	no	password
Ssl	Does server requires SSL?. The default value is false.	no	ssl
Username	Username to authenticate on server	no	username

Note

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

Operations

none

Package Types

none

3.3.1.30.1.2. JBossAS7 - IMAP Mail Server Service

Overview

Table 3.816. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.817.
Name	Description	Required	Internal 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.818.
Name	Description	Required	Internal Name
Outbound Socket Binding Ref	Outbound Socket binding to IMAP server	yes	outbound-socket-binding-ref
Password	Password to authenticate on server	no	password
Ssl	Does server requires SSL?. The default value is false.	no	ssl
Username	Username to authenticate on server	no	username

Note

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

Operations

none

Package Types

none

3.3.1.30.1.3. JBossAS7 - POP3 Mail Server Service

Overview

Table 3.819. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.820.
Name	Description	Required	Internal 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.821.
Name	Description	Required	Internal Name
Outbound Socket Binding Ref	Outbound Socket binding to POP3 server	yes	outbound-socket-binding-ref
Password	Password to authenticate on server	no	password
Ssl	Does server requires SSL?. The default value is false.	no	ssl
Username	Username to authenticate on server	no	username

Note

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

Operations

none

Package Types

none

3.3.1.31. JBossAS7 - Messaging Service

Overview

Table 3.822. Overview
Description:	The messaging subsystems
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1, “JBossAS7 - HornetQ Service”

Connection Properties

Table 3.823.
Name	Description	Required	Internal 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.3.1.31.1. JBossAS7 - HornetQ Service

Overview

Table 3.824. Overview
Description:	The HornetQ based messaging subsystem
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.1, “JBossAS7 - JMS Queue Service”
Section 3.3.1.31.1.2, “JBossAS7 - JMS Topic Service”
Section 3.3.1.31.1.3, “JBossAS7 - Connection Factory Service”
Section 3.3.1.31.1.4, “JBossAS7 - Pooled Connection Factory Service”
Section 3.3.1.31.1.5, “JBossAS7 - Security Setting Service”
Section 3.3.1.31.1.6, “JBossAS7 - Address Setting Service”
Section 3.3.1.31.1.7, “JBossAS7 - Grouping Handler Service”
Section 3.3.1.31.1.8, “JBossAS7 - Acceptor Service”
Section 3.3.1.31.1.9, “JBossAS7 - Connector (HornetQ) Service”
Section 3.3.1.31.1.10, “JBossAS7 - In VM Acceptor Service”
Section 3.3.1.31.1.11, “JBossAS7 - In VM Connector Service”
Section 3.3.1.31.1.12, “JBossAS7 - Remote Acceptor Service”
Section 3.3.1.31.1.13, “JBossAS7 - Remote Connector Service”
Section 3.3.1.31.1.14, “JBossAS7 - Divert Service”
Section 3.3.1.31.1.15, “JBossAS7 - Queue Service”
Section 3.3.1.31.1.16, “JBossAS7 - Core Address Service”
Section 3.3.1.31.1.17, “JBossAS7 - Cluster Connection Service”
Section 3.3.1.31.1.18, “JBossAS7 - Broadcast Group Service”
Section 3.3.1.31.1.19, “JBossAS7 - Path Service”
Section 3.3.1.31.1.20, “JBossAS7 - Bridge Service”
Section 3.3.1.31.1.21, “JBossAS7 - Discovery Group Service”
Section 3.3.1.31.1.22, “JBossAS7 - Connector Service”
Section 3.3.1.31.1.23, “JBossAS7 - Runtime Queue Service”

Connection Properties

Table 3.825.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.826. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this server is started.	started
Version	trait	The server's version.	version

Note

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

Configuration Properties

Table 3.827.
Name	Description	Required	Internal Name
Allow Failback	Whether this server will automatically shutdown if the original live server comes back up. The default value is true.	no	allow-failback
Async Connection Execution Enabled	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true.	no	async-connection-execution-enabled
Backup	Whether this server is a backup server. The default value is false.	no	backup
Cluster Password	The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!.	no	cluster-password
Cluster User	The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	cluster-user
Clustered	Whether the server is clustered. The default value is false.	no	clustered
Connection Ttl Override	If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1.	no	connection-ttl-override
Create Bindings Dir	Whether the server should create the bindings directory on start up. The default value is true.	no	create-bindings-dir
Create Journal Dir	Whether the server should create the journal directory on start up. The default value is true.	no	create-journal-dir
Failback Delay	How long to wait before failback occurs on live server restart. The default value is 5000.	no	failback-delay
Failover On Shutdown	Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false.	no	failover-on-shutdown
Id Cache Size	The size of the cache for pre-creating message IDs. The default value is 2000.	no	id-cache-size
Jmx Domain	The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq.	no	jmx-domain
Jmx Management Enabled	Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false.	no	jmx-management-enabled
Journal Buffer Size	The size of the internal buffer on the journal.	no	journal-buffer-size
Journal Buffer Timeout	The timeout (in nanoseconds) used to flush internal buffers on the journal.	no	journal-buffer-timeout
Journal Compact Min Files	The minimal number of journal data files before we can start compacting. The default value is 10.	no	journal-compact-min-files
Journal Compact Percentage	The percentage of live data on which we consider compacting the journal. The default value is 30.	no	journal-compact-percentage
Journal File Size	The size (in bytes) of each journal file. The default value is 10485760.	no	journal-file-size
Journal Max Io	The maximum number of write requests that can be in the AIO queue at any one time.	no	journal-max-io
Journal Min Files	How many journal files to pre-create. The default value is 2.	no	journal-min-files
Journal Sync Non Transactional	Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true.	no	journal-sync-non-transactional
Journal Sync Transactional	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true.	no	journal-sync-transactional
Journal Type	The type of journal to use. The default value is ASYNCIO.	no	journal-type
Live Connector Ref	The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'.	no	live-connector-ref
Log Journal Write Rate	Whether to periodically log the journal's write rate and flush rate. The default value is false.	no	log-journal-write-rate
Management Address	Address to send management messages to. The default value is jms.queue.hornetq.management.	no	management-address
Management Notification Address	The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications.	no	management-notification-address
Memory Measure Interval	Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1.	no	memory-measure-interval:expr
Memory Warning Threshold	Percentage of available memory which if exceeded results in a warning log. The default value is 25.	no	memory-warning-threshold:expr
Message Counter Enabled	Whether message counters are enabled. The default value is false.	no	message-counter-enabled
Message Counter Max Day History	How many days to keep message counter history. The default value is 10.	no	message-counter-max-day-history
Message Counter Sample Period	The sample period (in ms) to use for message counters. The default value is 10000.	no	message-counter-sample-period
Message Expiry Scan Period	How often (in ms) to scan for expired messages. The default value is 30000.	no	message-expiry-scan-period
Message Expiry Thread Priority	The priority of the thread expiring messages. The default value is 3.	no	message-expiry-thread-priority
Page Max Concurrent Io	The maximum number of concurrent reads allowed on paging. The default value is 5.	no	page-max-concurrent-io
Perf Blast Pages	TODO. The default value is -1.	no	perf-blast-pages
Persist Delivery Count Before Delivery	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false.	no	persist-delivery-count-before-delivery
Persist Id Cache	Whether IDs are persisted to the journal. The default value is true.	no	persist-id-cache
Persistence Enabled	Whether the server will use the file based journal for persistence. The default value is true.	no	persistence-enabled
Remoting Interceptors	The list of interceptor classes used by this server.	no	remoting-interceptors:nullable
Run Sync Speed Test	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false.	no	run-sync-speed-test
Scheduled Thread Pool Max Size	The number of threads that the main scheduled thread pool has. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Security Domain	The security domain to use to verify user and role information. The default value is other.	no	security-domain
Security Enabled	Whether security is enabled. The default value is true.	no	security-enabled
Security Invalidation Interval	How long (in ms) to wait before invalidating the security cache. The default value is 10000.	no	security-invalidation-interval
Server Dump Interval	How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1.	no	server-dump-interval
Shared Store	Whether this server is using a shared store for failover. The default value is true.	no	shared-store
Thread Pool Max Size	The number of threads that the main thread pool has. -1 means no limit. The default value is 30.	no	thread-pool-max-size:expr
Transaction Timeout	How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000.	no	transaction-timeout
Transaction Timeout Scan Period	How often (in ms) to scan for timeout transactions. The default value is 1000.	no	transaction-timeout-scan-period
Wild Card Routing Enabled	Whether the server supports wild card routing. The default value is true.	no	wild-card-routing-enabled

Note

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

Operations

Table 3.828. Metrics
Name	Description
Close Connections for Address	Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction	Heuristically commits a prepared transaction.
Force Failover	Force the messaging server to stop and notify clients to failover.
Get Address Settings as JSON	Returns the address settings as a JSON string for an address match. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON	Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID	Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time	Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON	Lists all the consumers.
List Connection IDs	Lists the IDs of all the connections connected to this server.
List Connections as JSON	List all JMS connections.
List Consumers as JSON	Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions	Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions	Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML	List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON	List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML	List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON	List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions	List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
List Producers Info as JSON	For all sessions, lists information about message producers using JSON serialization.
List Remote Addresses	Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List Sessions	Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON	Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations	Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories	Reset all message counters history.
Reset All Message Counters	Reset all message counters.
Rollback Prepared Transaction	Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.

Package Types

none

3.3.1.31.1.1. JBossAS7 - JMS Queue Service

Overview

Table 3.829. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.830.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.831. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Expiry Address	trait	The address to send expired messages to.	expiry-address
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Temporary	trait	Whether the queue is temporary.	temporary
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address

Note

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

Configuration Properties

Table 3.832.
Name	Description	Required	Internal Name
Durable	Whether the queue is durable or not. The default value is true.	no	durable
Entries	The jndi names the queue will be bound to.	yes	entries
Selector	The queue selector.	no	selector

Note

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

Operations

Table 3.833. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.1.31.1.2. JBossAS7 - JMS Topic Service

Overview

Table 3.834. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.835.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.836. Metrics
Name	Type	Description	Internal Name
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable Message Count	measurement	The number of messages for all durable subscribers for this topic.	durable-message-count
Durable Subscription Count	measurement	The number of durable subscribers for this topic.	durable-subscription-count
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Non Durable Message Count	measurement	The number of messages for all non-durable subscribers for this topic.	non-durable-message-count
Non Durable Subscription Count	measurement	The number of non-durable subscribers for this topic.	non-durable-subscription-count
Subscription Count	measurement	The number of (durable and non-durable) subscribers for this topic.	subscription-count
Temporary	trait	Whether the topic is temporary.	temporary
Topic Address	trait	The address the topic points to.	topic-address

Note

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

Configuration Properties

Table 3.837.
Name	Description	Required	Internal Name
JNDI Names	The jndi names the queue will be bound to.	yes	entries

Note

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

Operations

Table 3.838. Metrics
Name	Description
Count Messages for Subscription	Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions	Drop all subscriptions from this topic.
Drop Durable Subscription	Drop a durable subscription
List All Subscriptions	List all subscriptions.
List All Subscriptions as JSON	List all subscriptions as a string in JSON format.
List Durable Subscriptions	List only the durable subscriptions.
List Durable Subscriptions as JSON	List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription	List all the messages for the given subscription.
List Messages for Subscription as JSON	List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions	List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON	List only the non-durable subscriptions, as a string in JSON format.
Remove Messages	Remove messages matching the given filter from the destination.

Package Types

none

3.3.1.31.1.3. JBossAS7 - Connection Factory Service

Overview

Table 3.839. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.840.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.841.
Name	Description	Required	Internal Name
Connector	Defines the connector to be used. This is mutually exclusive with discovery-group-name	no	connector:collapsed
JNDI Names	The jndi names the connection factory should be bound to.	yes	entries
Auto Group	Whether or not message grouping is automatically used. The default value is false.	no	auto-group
Block On Acknowledge	True to set block on acknowledge. The default value is false.	no	block-on-acknowledge
Block On Durable Send	True to set block on durable send. The default value is true.	no	block-on-durable-send
Block On Non Durable Send	True to set block on non durable send. The default value is false.	no	block-on-non-durable-send
Cache Large Message Client	True to cache large messages. The default value is false.	no	cache-large-message-client
Call Timeout	The call time out. The default value is 30000.	no	call-timeout
Client Failure Check Period	The client failure check period. The default value is 30000.	no	client-failure-check-period
Client Id	The client id.	no	client-id
Compress Large Messages	Whether large messages should be compressed. The default value is false.	no	compress-large-messages
Confirmation Window Size	The confirmation window size. The default value is -1.	no	confirmation-window-size
Connection Load Balancing Policy Class Name	Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy.	no	connection-load-balancing-policy-class-name
Connection Ttl	The connection ttl. The default value is 60000.	no	connection-ttl
Consumer Max Rate	The consumer max rate. The default value is -1.	no	consumer-max-rate
Consumer Window Size	The consumer window size. The default value is 1048576.	no	consumer-window-size
Discovery Group Name	The discovery group name.	no	discovery-group-name
Discovery Initial Wait Timeout	The discovery initial wait time out.	no	discovery-initial-wait-timeout
Dups Ok Batch Size	The dups ok batch size. The default value is 1048576.	no	dups-ok-batch-size
Factory Type	The type of connection factory.	no	factory-type
Failover On Initial Connection	True to fail over on initial connection. The default value is false.	no	failover-on-initial-connection
Failover On Server Shutdown	True to fail over on server shutdown.	no	failover-on-server-shutdown
Group Id	The group id.	no	group-id
Ha	Whether the connection factory supports High Availability. The default value is false.	yes	ha
Initial Message Packet Size	The initial size of messages created through this factory.	yes	initial-message-packet-size
Max Retry Interval	The max retry interval. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The min large message size. The default value is 102400.	no	min-large-message-size
Pre Acknowledge	True to pre-acknowledge. The default value is false.	no	pre-acknowledge
Producer Max Rate	The producer max rate. The default value is -1.	no	producer-max-rate
Producer Window Size	The producer window size. The default value is 65536.	no	producer-window-size
Reconnect Attempts	The reconnect attempts. The default value is 0.	no	reconnect-attempts
Retry Interval	The retry interval. The default value is 2000.	no	retry-interval
Retry Interval Multiplier	The retry interval multiplier. The default value is 1.0.	no	retry-interval-multiplier
Scheduled Thread Pool Max Size	The scheduled thread pool max size. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Thread Pool Max Size	The thread pool max size. The default value is 30.	no	thread-pool-max-size:expr
Transaction Batch Size	The transaction batch size. The default value is 1048576.	no	transaction-batch-size
Use Global Pools	True to use global pools. The default value is true.	no	use-global-pools

Note

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

Operations

none

Package Types

none

3.3.1.31.1.4. JBossAS7 - Pooled Connection Factory Service

Overview

Table 3.842. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.843.
Name	Description	Required	Internal 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.844.
Name	Description	Required	Internal Name
Connector	Defines the connectors. These are stored in a map by connector name, with the backup connectors stored as the value, or an undefined value if there is no backup connector.	no	connector:collapsed
JNDI Names	The jndi names the connection factory should be bound to.	yes	entries
Auto Group	The autogroup. The default value is false.	no	auto-group
Block On Acknowledge	True to set block on acknowledge. The default value is false.	no	block-on-acknowledge
Block On Durable Send	True to set block on durable send. The default value is true.	no	block-on-durable-send
Block On Non Durable Send	True to set block on non durable send. The default value is false.	no	block-on-non-durable-send
Cache Large Message Client	True to cache large messages. The default value is false.	no	cache-large-message-client
Call Timeout	The call time out. The default value is 30000.	no	call-timeout
Client Failure Check Period	The client failure check period. The default value is 30000.	no	client-failure-check-period
Client Id	The client id.	no	client-id
Confirmation Window Size	The confirmation window size. The default value is -1.	no	confirmation-window-size
Connection Load Balancing Policy Class Name	Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy.	no	connection-load-balancing-policy-class-name
Connection Ttl	The connection ttl. The default value is 60000.	no	connection-ttl
Consumer Max Rate	The consumer max rate. The default value is -1.	no	consumer-max-rate
Consumer Window Size	The consumer window size. The default value is 1048576.	no	consumer-window-size
Discovery Group Name	The discovery group name.	no	discovery-group-name
Discovery Initial Wait Timeout	The discovery initial wait time out.	no	discovery-initial-wait-timeout
Dups Ok Batch Size	The dups ok batch size. The default value is 1048576.	no	dups-ok-batch-size
Failover On Initial Connection	True to fail over on initial connection. The default value is false.	no	failover-on-initial-connection
Failover On Server Shutdown	True to fail over on server shutdown.	no	failover-on-server-shutdown
Group Id	The group id.	no	group-id
Ha	Whether the connection factory supports High Availability. The default value is false.	no	ha
Jndi Params	The JNDI params to use for locating the destination for incoming connections.	no	jndi-params
Max Pool Size	The maximum size for the pool. The default value is -1.	no	max-pool-size:expr
Max Retry Interval	The max retry interval. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The min large message size. The default value is 102400.	no	min-large-message-size
Min Pool Size	The minimum size for the pool. The default value is -1.	no	min-pool-size:expr
Password	The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.	no	password
Pre Acknowledge	True to pre-acknowledge. The default value is false.	no	pre-acknowledge
Producer Max Rate	The producer max rate. The default value is -1.	no	producer-max-rate
Producer Window Size	The producer window size. The default value is 65536.	no	producer-window-size
Reconnect Attempts	The reconnect attempts. The default value is 0.	no	reconnect-attempts
Retry Interval	The retry interval. The default value is 2000.	no	retry-interval
Retry Interval Multiplier	The retry interval multiplier. The default value is 1.0.	no	retry-interval-multiplier
Scheduled Thread Pool Max Size	The scheduled thread pool max size. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Setup Attempts	The number of times to set up an MDB endpoint	no	setup-attempts
Setup Interval	The interval between attempts at setting up an MDB endpoint.	no	setup-interval
Thread Pool Max Size	The thread pool max size. The default value is 30.	no	thread-pool-max-size:expr
Transaction	TODO. The default value is transaction.	no	transaction
Transaction Batch Size	The transaction batch size. The default value is 1048576.	no	transaction-batch-size
Use Global Pools	True to use global pools. The default value is true.	no	use-global-pools
Use Jndi	Use JNDI to locate the destination for incoming connections	no	use-jndi
Use Local Tx	Use a local transaction for incoming sessions	no	use-local-tx
User	The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.	no	user

Note

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

Operations

none

Package Types

none

3.3.1.31.1.5. JBossAS7 - Security Setting Service

Overview

Table 3.845. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.5.1, “JBossAS7 - Role Service”

Connection Properties

Table 3.846.
Name	Description	Required	Internal 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.3.1.31.1.5.1. JBossAS7 - Role Service

Overview

Table 3.847. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.848.
Name	Description	Required	Internal 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.849.
Name	Description	Required	Internal Name
Consume	his permission allows the user to consume a message from a queue bound to matching addresses. The default value is false.	yes	consume
Create Durable Queue	This permission allows the user to create a durable queue. The default value is false.	yes	create-durable-queue
Create Non Durable Queue	This permission allows the user to create a temporary queue. The default value is false.	yes	create-non-durable-queue
Delete Durable Queue	This permission allows the user to delete a durable queue. The default value is false.	yes	delete-durable-queue
Delete Non Durable Queue	This permission allows the user to delete a temporary queue. The default value is false.	yes	delete-non-durable-queue
Manage	This permission allows the user to invoke management operations by sending management messages to the management address. The default value is false.	yes	manage
Send	This permission allows the user to send a message to matching addresses. The default value is false.	yes	send

Note

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

Operations

none

Package Types

none

3.3.1.31.1.6. JBossAS7 - Address Setting Service

Overview

Table 3.850. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.851.
Name	Description	Required	Internal 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.852.
Name	Description	Required	Internal Name
Address Full Policy	Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK). The default value is PAGE.	no	address-full-policy
Dead Letter Address	The dead letter address	no	dead-letter-address
Expiry Address	Defines where to send a message that has expired.	no	expiry-address
Last Value Queue	Defines whether a queue only uses last values or not. The default value is false.	no	last-value-queue
Max Delivery Attempts	Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address. The default value is 10.	no	max-delivery-attempts
Max Size Bytes	The max bytes size. The default value is -1.	no	max-size-bytes
Message Counter History Day Limit	Day limit for the message counter history. The default value is 0.	no	message-counter-history-day-limit
Page Max Cache Size	The number of page files to keep in memory to optimize IO during paging navigation. The default value is 5.	no	page-max-cache-size
Page Size Bytes	The paging size. The default value is 10485760.	no	page-size-bytes
Redelivery Delay	Defines how long to wait before attempting redelivery of a cancelled message. The default value is 0.	no	redelivery-delay
Redistribution Delay	Defines how long to wait when the last consumer is closed on a queue before redistributing any messages. The default value is -1.	no	redistribution-delay
Send To Dla On No Route	If this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists. The default value is false.	no	send-to-dla-on-no-route

Note

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

Operations

none

Package Types

none

3.3.1.31.1.7. JBossAS7 - Grouping Handler Service

Overview

Table 3.853. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.854.
Name	Description	Required	Internal 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.855.
Name	Description	Required	Internal Name
Grouping Handler Address	A reference to a cluster connection and the address it uses.	yes	grouping-handler-address
Timeout	How long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept. The default value is 5000.	no	timeout
Type	Whether the handler is the single 'Local' handler for the cluster, which makes handling decisions, or a 'Remote' handler which converses with the local handler.	no	type

Note

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

Operations

none

Package Types

none

3.3.1.31.1.8. JBossAS7 - Acceptor Service

Overview

Table 3.856. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.8.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.857.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.858. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this acceptor is started.	started

Note

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

Configuration Properties

Table 3.859.
Name	Description	Required	Internal Name
Factory Class	The factory class.	yes	factory-class
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

Table 3.860. Metrics
Name	Description
Start	Starts the acceptor.
Stop	Stops the acceptor.

Package Types

none

3.3.1.31.1.8.1. JBossAS7 - Param Service

Overview

Table 3.861. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.862.
Name	Description	Required	Internal 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.863.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.9. JBossAS7 - Connector (HornetQ) Service

Overview

Table 3.864. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.9.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.865.
Name	Description	Required	Internal 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.866.
Name	Description	Required	Internal Name
Factory Class	The factory class.	yes	factory-class
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

none

Package Types

none

3.3.1.31.1.9.1. JBossAS7 - Param Service

Overview

Table 3.867. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.868.
Name	Description	Required	Internal 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.869.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.10. JBossAS7 - In VM Acceptor Service

Overview

Table 3.870. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.10.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.871.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.872. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether it's stopped or started.	started

Note

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

Configuration Properties

Table 3.873.
Name	Description	Required	Internal Name
Server Id	The server id.	yes	server-id

Note

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

Operations

Table 3.874. Metrics
Name	Description
Start	Starts the acceptor.
Stop	Stops the acceptor.

Package Types

none

3.3.1.31.1.10.1. JBossAS7 - Param Service

Overview

Table 3.875. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.876.
Name	Description	Required	Internal 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.877.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.11. JBossAS7 - In VM Connector Service

Overview

Table 3.878. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.11.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.879.
Name	Description	Required	Internal 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.880.
Name	Description	Required	Internal Name
Server Id	The server id.	yes	server-id

Note

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

Operations

none

Package Types

none

3.3.1.31.1.11.1. JBossAS7 - Param Service

Overview

Table 3.881. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.882.
Name	Description	Required	Internal 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.883.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.12. JBossAS7 - Remote Acceptor Service

Overview

Table 3.884. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.12.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.885.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.886. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this acceptor is started.	started

Note

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

Configuration Properties

Table 3.887.
Name	Description	Required	Internal Name
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

Table 3.888. Metrics
Name	Description
Start	Starts the acceptor.
Stop	Stops the acceptor.

Package Types

none

3.3.1.31.1.12.1. JBossAS7 - Param Service

Overview

Table 3.889. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.890.
Name	Description	Required	Internal 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.891.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.13. JBossAS7 - Remote Connector Service

Overview

Table 3.892. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.13.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.893.
Name	Description	Required	Internal 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.894.
Name	Description	Required	Internal Name
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

none

Package Types

none

3.3.1.31.1.13.1. JBossAS7 - Param Service

Overview

Table 3.895. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.896.
Name	Description	Required	Internal 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.897.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.14. JBossAS7 - Divert Service

Overview

Table 3.898. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.899.
Name	Description	Required	Internal 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.900.
Name	Description	Required	Internal Name
Divert Address	Address to divert from	yes	divert-address
Exclusive	Whether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all. The default value is false.	no	exclusive
Filter	An optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.	no	filter
Forwarding Address	Address to divert to	yes	forwarding-address
Routing Name	Routing name of the divert	no	routing-name
Transformer Class Name	The name of a class used to transform the message's body or properties before it is diverted.	no	transformer-class-name

Note

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

Operations

none

Package Types

none

3.3.1.31.1.15. JBossAS7 - Queue Service

Overview

Table 3.901. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.902.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.903. Metrics
Name	Type	Description	Internal Name
Id	trait	The id of the queue.	id
Paused	trait	Whether the queue is paused.	paused
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

Table 3.904.
Name	Description	Required	Internal Name
Durable	Defines whether the queue is durable. The default value is true.	no	durable
Filter	A queue message filter definition. An undefined or empty filter will match all messages.	no	filter
Queue Address	The queue address defines what address is used for routing messages.	yes	queue-address

Note

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

Operations

Table 3.905. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
List Scheduled Messages	List the messages scheduled for delivery.
List Scheduled Messages as JSON	List the messages scheduled for delivery as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.1.31.1.16. JBossAS7 - Core Address Service

Overview

Table 3.906. Overview
Description:	A runtime-only resource representing a HornetQ address. Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.907.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.908.
Name	Description	Required	Internal Name
Binding Names	The names of all bindings (both queues and diverts) bound to this address.	yes	binding-names
Number Of Bytes Per Page	The number of bytes used by each page for this address.	yes	number-of-bytes-per-page
Number Of Pages	The number of pages used by this address.	yes	number-of-pages
Queue Names	The names of the queues associated with the address.	yes	queue-names
Roles	A list of the security roles (name and permissions) associated with the address.	yes	roles

Note

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

Operations

none

Package Types

none

3.3.1.31.1.17. JBossAS7 - Cluster Connection Service

Overview

Table 3.909. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.910.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.911. Metrics
Name	Type	Description	Internal Name
Node Id	trait	The node ID used by this cluster connection.	node-id
Started	trait	Whether the cluster connection is started.	started

Note

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

Configuration Properties

Table 3.912.
Name	Description	Required	Internal Name
Call Timeout	The timeout (in ms) for remote calls made by the cluster connection. The default value is 30000.	no	call-timeout
Check Period	The period (in milliseconds) between client failure check. The default value is 30000.	no	check-period
Cluster Connection Address	Each cluster connection only applies to messages sent to an address that starts with this value.	yes	cluster-connection-address
Confirmation Window Size	The confirmation-window-size to use for the connection used to forward messages to a target node. The default value is 1048576.	no	confirmation-window-size
Connection Ttl	The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat). The default value is 60000.	no	connection-ttl
Connector Ref	The confirmation-window-size to use for the connection used to forward messages to a target node.	yes	connector-ref
Discovery Group Name	The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.	no	discovery-group-name
Forward When No Consumers	Whether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then HornetQ will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message. The default value is false.	no	forward-when-no-consumers
Max Hops	The maximum number of times a message can be forwarded. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ servers as intermediates in a chain. The default value is 1.	no	max-hops
Max Retry Interval	The maximum interval of time used to retry connections. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400.	no	min-large-message-size
Reconnect Attempts	The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1.	no	reconnect-attempts
Retry Interval	The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 500.	no	retry-interval
Retry Interval Multiplier	A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0.	no	retry-interval-multiplier
Static Connectors	The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.	no	static-connectors:nullable
Use Duplicate Detection	Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true.	no	use-duplicate-detection

Note

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

Operations

Table 3.913. Metrics
Name	Description
Get Nodes	Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.
Start	Starts the cluster connection.
Stop	Stops the cluster connection.

Package Types

none

3.3.1.31.1.18. JBossAS7 - Broadcast Group Service

Overview

Table 3.914. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.915.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.916. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether the broadcast group is started.	started

Note

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

Configuration Properties

Table 3.917.
Name	Description	Required	Internal Name
Broadcast Period	The period in milliseconds between consecutive broadcasts. The default value is 2000.	no	broadcast-period
Connectors	Specifies the names of connectors that will be broadcast.	no	connectors
Socket Binding	The broadcast group socket binding.	yes	socket-binding

Note

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

Operations

Table 3.918. Metrics
Name	Description
Get Connector Pairs as JSON	Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.
Start	Starts the broadcast group.
Stop	Stops the broadcast group.

Package Types

none

3.3.1.31.1.19. JBossAS7 - Path Service

Overview

Table 3.919. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.920.
Name	Description	Required	Internal 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.921.
Name	Description	Required	Internal Name
Path	The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.	yes	path
Relative To	The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The 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	relative-to
Path Type	Path Type	yes	__name

Note

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

Operations

none

Package Types

none

3.3.1.31.1.20. JBossAS7 - Bridge Service

Overview

Table 3.922. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.923.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.924. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether the bridge is started.	started

Note

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

Configuration Properties

Table 3.925.
Name	Description	Required	Internal Name
Check Period	The period (in milliseconds) between client failure check. The default value is 30000.	no	check-period
Confirmation Window Size	The confirmation-window-size to use for the connection used to forward messages to the target node. The default value is 1048576.	no	confirmation-window-size
Connection Ttl	The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat). The default value is 60000.	no	connection-ttl
Discovery Group Name	The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.	no	discovery-group-name
Failover On Server Shutdown	Whether the bridge will attempt to failover onto a backup server (if specified) when the target server is cleanly shutdown rather than crashed.	no	failover-on-server-shutdown
Filter	An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.	no	filter
Forwarding Address	The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.	no	forwarding-address
Ha	Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover. The default value is false.	no	ha
Max Retry Interval	The maximum interval of time used to retry connections. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400.	no	min-large-message-size
Password	The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used. The default value is CHANGE ME!!.	no	password
Queue Name	The unique name of the local queue that the bridge consumes from.	yes	queue-name
Reconnect Attempts	The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1.	no	reconnect-attempts
Retry Interval	The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 2000.	no	retry-interval
Retry Interval Multiplier	A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0.	no	retry-interval-multiplier
Static Connectors	A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.	no	static-connectors:nullable
Transformer Class Name	The name of a user-defined class which implements the org.hornetq.core.server.cluster.Transformer interface.	no	transformer-class-name
Use Duplicate Detection	Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true.	no	use-duplicate-detection
User	The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	user

Note

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

Operations

Table 3.926. Metrics
Name	Description
Start	Starts the bridge.
Stop	Stops the bridge.

Package Types

none

3.3.1.31.1.21. JBossAS7 - Discovery Group Service

Overview

Table 3.927. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.928.
Name	Description	Required	Internal 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.929.
Name	Description	Required	Internal Name
Initial Wait Timeout	Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster. The default value is 10000.	no	initial-wait-timeout
Refresh Timeout	Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list. The default value is 10000.	no	refresh-timeout
Socket Binding	The discovery group socket binding.	yes	socket-binding

Note

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

Operations

none

Package Types

none

3.3.1.31.1.22. JBossAS7 - Connector Service

Overview

Table 3.930. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.1.31.1.22.1, “JBossAS7 - Param Service”

Connection Properties

Table 3.931.
Name	Description	Required	Internal 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.932.
Name	Description	Required	Internal Name
Factory Class	Class name of the factory class that can instantiate the connector service.	yes	factory-class

Note

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

Operations

none

Package Types

none

3.3.1.31.1.22.1. JBossAS7 - Param Service

Overview

Table 3.933. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.934.
Name	Description	Required	Internal 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.935.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.1.31.1.23. JBossAS7 - Runtime Queue Service

Overview

Table 3.936. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.937.
Name	Description	Required	Internal 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.938. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send the queue's dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable	trait	Defines whether the queue is durable.	durable
Expiry Address	trait	The address to send the queue's expired messages to.	expiry-address
Filter	trait	A queue message filter definition. An undefined or empty filter will match all messages.	filter
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

none

Operations

Table 3.939. Metrics
Name	Description
List Scheduled Messages as JSON	List the messages scheduled for delivery as a string in JSON format.
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Count Messages	Returns the number of the messages in the queue matching the given filter.
List Consumers as JSON	Lists consumers.
Change Messages Priority	Change the priority of the messages corresponding to the given filter.
Pause	Pause the queue.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
Expire Messages	Expire the messages matching the given filter.
List Messages	List all messages in the queue that match the filter
Send message To Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Reset Message Counters	Reset the message counters.
Move Message	Move the message corresponding to the given message-id to another queue
Expire Message	Expire the message corresponding to the given message-id.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
Remove Messages	Remove messages matching the given filter from the destination.
Move Messages	Move the messages corresponding to the given filter to another queue.
List Message Counter as HTML	List the message counter history.
List Scheduled Messages	List the messages scheduled for delivery.
Resume	Resume the queue.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.
Remove Message	Remove the message corresponding to the given message-id.
Change Message Priority	Change the priority of the message corresponding to the given message-id.

Package Types

none

3.3.2. JBossAS7 - Host Controller Server

Overview

Table 3.940. Overview
Description:	Domain controller (delegate) for this host
Singleton:	no
Plugin:	JBossAS7

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 domain.sh on UNIX or domain.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/domain.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. "--host-config=host-master.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 JBossAS7 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

Section 3.3.2.1, “JBossAS7 - ServerGroup Service”
Section 3.3.2.2, “JBossAS7 - Host Service”
Section 3.3.2.3, “JBossAS7 - DomainDeployment Service”
Section 3.3.2.4, “JBossAS7 - Managed Server”
Section 3.3.2.5, “JBossAS7 - Profile Service”
Section 3.3.2.6, “JBossAS7 - Network Interface Service”
Section 3.3.2.7, “JBossAS7 - SocketBindingGroup Service”

Autodiscovery Process Scans

Table 3.941. Metrics
Name	Query
HostController	process\|basename\|match=^java.,arg\|org.jboss.as.host-controller\|match=.

Connection Properties

Table 3.942.
Name	Description	Required	Internal Name
Start Script Path	The 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 Prefix	A 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 Variables	The 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. JAVA_OPTS=-Xms512M -Xmx1024M). 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 Arguments	The 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
Native Host	Native management API host	yes	nativeHost
Native Port	Native management API port	yes	nativePort
Native Local Authentication	Specifies 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 Strategy	Defines 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 Verification	Defines 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
Truststore	Path to a truststore file. If undefined, the JVM default truststore is used.	no	truststore
Truststore Type	Truststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats.	no	truststoreType
Truststore Password	Password protecting the truststore file.	no	truststorePassword
Client Certificate Authentication		yes	clientcertAuthentication
Keystore	Path to a keystore file. Required when Client Certificate Authentication is on.	no	keystore
Keystore Type	Keystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats.	no	keystoreType
Keystore Password	Password protecting the keystore file.	no	keystorePassword
Key Password	Password protecting the secret key in the keystore file.	no	keyPassword
Hostname	Host name of the domain API	yes	hostname
Port	Port of the domain API	yes	port
Secure	Encrypted transport indicator	yes	secure
User	Management user for a secured Host controller	no	user
Password	Password for the management user	no	password
Management Connection Timeout	Maximum 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 Directory	Root directory of the server installation	no	homeDir
Base Directory	Base directory for server content	no	baseDir
Configuration Directory	Base configuration directory	no	configDir
Log Directory	the directory where log files will be written for this host controller	no	logDir
Domain Host	Host name within the AS7 domain (Deprecated, use 'name' trait)	no	domainHost
Product Type	Server product type (e.g. AS or EAP)	no	productType
Supports Patching	Whether this EAP server supports patching. This should be automatically deduced by the agent. It is highly recommended to leave this with the discovered value. However, you will need to manually update this value if you manually upgrade your server from a version that does not support patching to a version that does.	yes	supportsPatching

Note

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

Metrics

Table 3.943. Metrics
Name	Type	Description	Internal Name
Number of management requests	measurement	Number of requests sent to the controller	_internal:mgmtRequests
Number of management requests per Minute	measurement	Number of requests sent to the controller	_internal:mgmtRequests
Time used for management requests	measurement	Total time for requests	_internal:requestTime
Time used for management requests per Minute	measurement	Total time for requests	_internal:requestTime
Maximum request time	measurement	Max time for a request since last metric get	_internal:maxTime
Server Code Name	trait	Server Code Name	_skm:release-codename
Server Version	trait	Server Version	_skm:release-version
Product Name	trait	Product Name	_skm:product-name
Product Version	trait	Product Version	_skm:product-version
Start time of the server	trait	Start time of the server	startTime
Domain Config File	trait	The name of the domain configuration file this host controller is using	domain-config-file
Host Config File	trait	The name of the host configuration file this host controller is using	host-config-file
Domain Host Name	trait	The name of the host in domain this host controller is using	domain-host-name
Domain Name	trait	The name of the managed domain this Host Controller belongs to.	domain-name
Temporary Directory	trait	The temporary directory (usually 'domain/tmp'). May serve as deployment directory for handover bundles'	domain-temp-dir
Active Patches	trait	The 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.944.
Name	Description	Required	Internal Name
Properties		no	*2
Path	The 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	*
Domain Name	Name of the managed domain. This value is same for all HostControllers in domain, but only DomainController resource is allowed to update it.	yes	name

Note

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

Operations

Table 3.945. Metrics
Name	Description
Start this host controller	Start this Host/Domain Controller with all its enabled managed servers
Shut down this host controller	Stop this Host/Domain Controller with all its managed servers
Restart this host controller	Restart this Host/Domain Controller with all its running managed servers
Install a management user	Installs a user in the server for management
Execute CLI commands	Executes command via jboss-cli
Execute CLI script	Executes script via jboss-cli
Setup CLI	Setup 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.3.2.1. JBossAS7 - ServerGroup Service

Overview

Table 3.946. Overview
Description:	A server group on this domain
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.1.1, “JBossAS7 - JVM Definition Service”

Connection Properties

Table 3.947.
Name	Description	Required	Internal 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.948.
Name	Description	Required	Internal Name
Properties		no	*2
Profile	The profile name	yes	profile
Socket Binding Group		yes	socket-binding-group
Socket Binding Port Offset	The default offset to be added to the port values given by the socket binding group.	no	socket-binding-port-offset

Note

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

Operations

Table 3.949. Metrics
Name	Description
Start Servers	Starts all configured servers belonging to the server group in the domain that are not currently running.
Restart Servers	Restarts all servers belonging to the server group currently running in the domain.
Stop Servers	Stops all servers belonging to the server group currently running in the domain.

Package Types

none

3.3.2.1.1. JBossAS7 - JVM Definition Service

Overview

Table 3.950. Overview
Description:	A JVM definition that can override host and server group level definitions with the same name
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.951.
Name	Description	Required	Internal 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.952.
Name	Description	Required	Internal Name
Base Definition	The definition from host level to use/override	yes	baseDefinition
Agent Lib	The JVM agent lib.	no	agent-lib
Agent Path	The JVM agent path.	no	agent-path
Env Classpath Ignored	Ignore the environment classpath.	no	env-classpath-ignored
Environment Variables	The JVM environment variables.	no	environment-variables
Heap Size	The initial heap size allocated by the JVM.	no	heap-size
Java Agent	The java agent.	no	java-agent
Java Home	The java home	no	java-home
Jvm Options	The JVM options. Those can not be changed after initial creation of the definition.	no	jvm-options
Max Heap Size	The maximum heap size that can be allocated by the JVM.	no	max-heap-size
Max Permgen Size	The maximum size of the permanent generation.	no	max-permgen-size
Permgen Size	The initial permanent generation size.	no	permgen-size
Stack Size	The JVM stack size settings.	no	stack-size
Type	The JVM type can be either SUN or IBM	no	type

Note

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

Operations

none

Package Types

none

3.3.2.2. JBossAS7 - Host Service

Overview

Table 3.953. Overview
Description:	A host involved in this domain
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.2.1, “JBossAS7 - JVM Service”
Section 3.3.2.2.2, “JBossAS7 - JVM Definition (Host) Service”
Section 3.3.2.2.3, “JBossAS7 - Network Interface Service”

Connection Properties

Table 3.954.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.955. Metrics
Name	Type	Description	Internal Name
Host state	trait	Detailed host state	host-state
Start time of the server	trait	Start time of the server	startTime

Note

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

Configuration Properties

Table 3.956.
Name	Description	Required	Internal Name
Properties		no	*2
Path	The 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

Note

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

Operations

none

Package Types

none

3.3.2.2.1. JBossAS7 - JVM Service

Overview

Table 3.957. Overview
Description:	Information about the underlying JVM
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.2.1.1, “JBossAS7 - Operating System Service”
Section 3.3.2.2.1.2, “JBossAS7 - Memory Service”
Section 3.3.2.2.1.3, “JBossAS7 - Runtime Service”
Section 3.3.2.2.1.4, “JBossAS7 - Threading Service”
Section 3.3.2.2.1.5, “JBossAS7 - Garbage Collector Service”
Section 3.3.2.2.1.6, “JBossAS7 - Memory Pool Service”

Connection Properties

Table 3.958.
Name	Description	Required	Internal 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.3.2.2.1.1. JBossAS7 - Operating System Service

Overview

Table 3.959. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.960.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.961. Metrics
Name	Type	Description	Internal Name
Available Processors	measurement	The number of processors available to the Java virtual machine.	available-processors
System Load Average	measurement	The 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.3.2.2.1.2. JBossAS7 - Memory Service

Overview

Table 3.962. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.963.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.964. Metrics
Name	Type	Description	Internal Name
Object Pending Finalization Count	measurement	The approximate number of objects for which finalization is pending.	object-pending-finalization-count
Initial heap usage	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	heap-memory-usage:init
Used heap	measurement	The amount of used memory in bytes.	heap-memory-usage:used
Committed heap	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	heap-memory-usage:committed
Maximum heap usage	measurement	The maximum amount of memory in bytes that can be used for memory management.	heap-memory-usage:max
Initial non-heap usage	measurement	The 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 memory	measurement	The amount of used memory in bytes.	non-heap-memory-usage:used
Committed non-heap memory	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	non-heap-memory-usage:committed
Maximum non-heap usage	measurement	The 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.965. Metrics
Name	Description
Trigger GC	Runs the garbage collector.

Package Types

none

3.3.2.2.1.3. JBossAS7 - Runtime Service

Overview

Table 3.966. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.967.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.968. Metrics
Name	Type	Description	Internal Name
Uptime	measurement	The 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.3.2.2.1.4. JBossAS7 - Threading Service

Overview

Table 3.969. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.970.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.971. Metrics
Name	Type	Description	Internal Name
Thread Count	measurement	The current number of live threads including both daemon and non-daemon threads.	thread-count
Peak Thread Count	measurement	The peak live thread count since the Java virtual machine started or peak was reset.	peak-thread-count
Total Started Thread Count	measurement	The total number of threads created and also started since the Java virtual machine started.	total-started-thread-count
Daemon Thread Count	measurement	The current number of live daemon threads.	daemon-thread-count
Current Thread Cpu Time	measurement	The 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 Time	measurement	The 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.972.
Name	Description	Required	Internal Name
Thread Contention Monitoring Enabled	Whether thread contention monitoring is enabled.	no	thread-contention-monitoring-enabled
Thread Cpu Time Enabled	Whether thread CPU time measurement is enabled.	no	thread-cpu-time-enabled
Thread Contention Monitoring Supported	Whether the Java virtual machine supports thread contention monitoring.	no	thread-contention-monitoring-supported
Thread Cpu Time Supported	Whether the Java virtual machine implementation supports CPU time measurement for any thread.	no	thread-cpu-time-supported
Current Thread Cpu Time Supported	Whether the Java virtual machine supports CPU time measurement for the current thread.	no	current-thread-cpu-time-supported
Object Monitor Usage Supported	Whether the Java virtual machine supports monitoring of object monitor usage.	no	object-monitor-usage-supported
Synchronizer Usage Supported	Whether 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.973. Metrics
Name	Description
Dump All Threads	Returns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked Threads	Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked Threads	Finds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu Time	Returns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread Info	Returns 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 Infos	Returns the thread info for each thread whose ID is in the input list.
Get Thread User Time	Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread Count	Resets the peak thread count to the current number of live threads.
Get All thread ids	Get 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.3.2.2.1.5. JBossAS7 - Garbage Collector Service

Overview

Table 3.974. Overview
Description:	Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.2.1.5.1, “JBossAS7 - Garbage Collector Resource Service”

Connection Properties

Table 3.975.
Name	Description	Required	Internal 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.3.2.2.1.5.1. JBossAS7 - Garbage Collector Resource Service

Overview

Table 3.976. Overview
Description:	The management interface for one of the garbage collectors in the Java virtual machine.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.977.
Name	Description	Required	Internal 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.978. Metrics
Name	Type	Description	Internal Name
Collection Count	measurement	The total number of collections that have occurred.	collection-count
Collection Count per Minute	measurement	The total number of collections that have occurred.	collection-count
Collection Time	measurement	The approximate accumulated collection elapsed time in milliseconds.	collection-time
Collection Time per Minute	measurement	The approximate accumulated collection elapsed time in milliseconds.	collection-time
Name	trait	The name representing this garbage collector	name
Valid	trait	Whether 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.979.
Name	Description	Required	Internal Name
Memory Pool Names	The 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.3.2.2.1.6. JBossAS7 - Memory Pool Service

Overview

Table 3.980. Overview
Description:	Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.2.1.6.1, “JBossAS7 - Memory Pool Resource Service”

Connection Properties

Table 3.981.
Name	Description	Required	Internal 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.3.2.2.1.6.1. JBossAS7 - Memory Pool Resource Service

Overview

Table 3.982. 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:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.983.
Name	Description	Required	Internal 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.984. Metrics
Name	Type	Description	Internal Name
Collection Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	collection-usage:init
Collection Usage - Used	measurement	The amount of used memory in bytes.	collection-usage:used
Collection Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	collection-usage:committed
Collection Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	collection-usage:max
Collection Usage Threshold Count	measurement	The 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 Exceeded	trait	Whether 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 Supported	trait	Whether this memory pool supports a collection usage threshold.	collection-usage-threshold-supported
Name	trait	The name representing this memory pool.	name
Peak Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	peak-usage:init
Peak Usage - Used	measurement	The amount of used memory in bytes.	peak-usage:used
Peak Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	peak-usage:committed
Peak Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	peak-usage:max
Type	trait	The type of this memory pool.	type
Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	usage:init
Usage - Used	measurement	The amount of used memory in bytes.	usage:used
Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	usage:committed
Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	usage:max
Usage Threshold Count	measurement	The 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 Exceeded	trait	Whether 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 Supported	trait	Whether this memory pool supports usage threshold.	usage-threshold-supported
Valid	trait	Whether 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.985.
Name	Description	Required	Internal Name
Collection Usage Threshold	The 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 Names	The names of the memory managers that manage this memory pool.	yes	memory-manager-names
Usage Threshold	The 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.986. Metrics
Name	Description
Reset Peak Usage	Resets the peak memory usage statistic of this memory pool to the current memory usage.

Package Types

none

3.3.2.2.2. JBossAS7 - JVM Definition (Host) Service

Overview

Table 3.987. Overview
Description:	A JVM Definition on Host level, that can serve as templates for server groups and managed servers
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.988.
Name	Description	Required	Internal 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.989.
Name	Description	Required	Internal Name
Agent Lib	The JVM agent lib.	no	agent-lib
Agent Path	The JVM agent path.	no	agent-path
Env Classpath Ignored	Ignore the environment classpath.	no	env-classpath-ignored
Environment Variables	The JVM environment variables.	no	environment-variables
Heap Size	The initial heap size allocated by the JVM.	no	heap-size
Java Agent	The java agent.	no	java-agent
Java Home	The java home	no	java-home
Jvm Options	The JVM options. Those can not be changed after initial creation of the definition.	no	jvm-options
Max Heap Size	The maximum heap size that can be allocated by the JVM.	no	max-heap-size
Max Permgen Size	The maximum size of the permanent generation.	no	max-permgen-size
Permgen Size	The initial permanent generation size.	no	permgen-size
Stack Size	The JVM stack size settings.	no	stack-size
Type	The JVM type can be either SUN or IBM	no	type

Note

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

Operations

none

Package Types

none

3.3.2.2.3. JBossAS7 - Network Interface Service

Overview

Table 3.990. Overview
Description:	A named network interface, along with required criteria for determining the IP address to associate with that interface
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.991.
Name	Description	Required	Internal 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.992.
Name	Description	Required	Internal Name
Any Address	Attribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic.	no	any-address
Any Ipv 4 Address	Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0).	no	any-ipv4-address
Any Ipv 6 Address	Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::).	no	any-ipv6-address
Link Local Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	link-local-address
Loopback	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	loopback
Loopback Address	Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	loopback-address
Multicast	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.	no	multicast
Nic	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.	no	nic
Nic Match	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.	no	nic-match
Point To Point	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	point-to-point
Public Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	public-address
Site Local Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	site-local-address
Subnet Match	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in 'slash notation'; e.g. '192.168.0.0/16'. An 'undefined' value means this attribute is not relevant to the IP address selection.	no	subnet-match
Up	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	up
Virtual	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection	no	virtual
Inet Address	Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.	no	inet-address

Note

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

Operations

none

Package Types

none

3.3.2.3. JBossAS7 - DomainDeployment Service

Overview

Table 3.993. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.994.
Name	Description	Required	Internal 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.995.
Name	Required	Internal Name
Name	yes	name
Runtime Name	yes	runtime-name
Content	yes	content
Assigned to	yes	*1

Note

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

Operations

Table 3.996. Metrics
Name	Description
Assign to Server-Group	Deprecated: Use server-group property found in resource configuration instead
Restart in Server-Group	Restarts this deployment in one or all assigned server group(s)

Package Types

Table 3.997. Package Types
Name	Category	Description
File	Deployable	Deployments on this domain

3.3.2.4. JBossAS7 - Managed Server

Overview

Table 3.998. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1, “JBossAS7 - ManagedServerDeployment Service”
Section 3.3.2.4.2, “JBossAS7 - Naming (Managed Server) Service”
Section 3.3.2.4.3, “JBossAS7 - Webservices (Managed Server) Service”
Section 3.3.2.4.4, “JBossAS7 - JacORB (Managed Server) Service”
Section 3.3.2.4.5, “JBossAS7 - JAXR (Managed Server) Service”
Section 3.3.2.4.6, “JBossAS7 - JPA (Managed Server) Service”
Section 3.3.2.4.7, “JBossAS7 - EE (Managed Server) Service”
Section 3.3.2.4.8, “JBossAS7 - Infinispan (Managed Server) Service”
Section 3.3.2.4.9, “JBossAS7 - JGroups (Managed Server) Service”
Section 3.3.2.4.10, “JBossAS7 - Remoting (Managed Server) Service”
Section 3.3.2.4.11, “JBossAS7 - Mail (Managed Server) Service”
Section 3.3.2.4.12, “JBossAS7 - JBossWeb (Managed Server) Service”
Section 3.3.2.4.13, “JBossAS7 - JCA (Managed Server) Service”
Section 3.3.2.4.14, “JBossAS7 - Osgi (Managed Server) Service”
Section 3.3.2.4.15, “JBossAS7 - JMX (Managed Server) Service”
Section 3.3.2.4.16, “JBossAS7 - Resource Adapters (Managed Server) Service”
Section 3.3.2.4.17, “JBossAS7 - CMP (Managed Server) Service”
Section 3.3.2.4.18, “JBossAS7 - EJB3 (Managed Server) Service”
Section 3.3.2.4.19, “JBossAS7 - Threads (Managed Server) Service”
Section 3.3.2.4.20, “JBossAS7 - Security (Managed Server) Service”
Section 3.3.2.4.21, “JBossAS7 - Messaging (Managed Server) Service”
Section 3.3.2.4.22, “JBossAS7 - Logging (Managed Server) Service”
Section 3.3.2.4.23, “JBossAS7 - JVM Service”
Section 3.3.2.4.24, “JBossAS7 - Datasources (Managed) Service”
Section 3.3.2.4.25, “JBossAS7 - JVM Definition Service”
Section 3.3.2.4.26, “JBossAS7 - Transactions Subsystem (Managed) Service”
Section 3.3.2.4.27, “JBossAS7 - JDR Service”

Autodiscovery Process Scans

none

Connection Properties

Table 3.999.
Name	Description	Required	Internal Name
Log Event Sources		yes	logEventSources
Path		yes	path

Note

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

Metrics

Table 3.1000. Metrics
Name	Type	Description	Internal Name
Server Code Name	trait	Server Code Name	_skm:release-codename
Server Version	trait	Server Version	_skm:release-version
Product Name	trait	Product Name	_skm:product-name
Product Version	trait	Product Version	_skm:product-version
Server state	trait	Detailed server state	status
Start time of the server	trait	Start time of the server	startTime
JGroups Multicast Address	trait	the host and port used by JGroups for multicast	multicastAddress

Note

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

Configuration Properties

Table 3.1001.
Name	Description	Required	Internal Name
Properties		no	*2
Name of the host to put the server on		yes	hostname
Server Group	Server Group this instance belongs to.	yes	group
Socket binding group	Socket bindings to use	yes	socket-binding-group
Port Offset	Offset to the base ports	yes	socket-binding-port-offset
Autostart	Whether or not this server should be started when the Host Controller starts.	yes	auto-start

Note

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

Operations

Table 3.1002. Metrics
Name	Description
Start	Start this server instance.
Stop	Stop this server instance.
Restart	Restart this server instance.

Package Types

none

3.3.2.4.1. JBossAS7 - ManagedServerDeployment Service

Overview

Table 3.1003. Overview
Description:	Deployed package on a managed server. Go to corresponding DomainDeployment to manipulate it
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.1, “JBossAS7 - Webservices Runtime Service”
Section 3.3.2.4.1.2, “JBossAS7 - Web Runtime Service”
Section 3.3.2.4.1.3, “JBossAS7 - Messaging Runtime Service”
Section 3.3.2.4.1.4, “JBossAS7 - Subdeployment Service”
Section 3.3.2.4.1.5, “JBossAS7 - JPA Runtime Service”
Section 3.3.2.4.1.6, “JBossAS7 - Datasources Runtime Service”
Section 3.3.2.4.1.7, “JBossAS7 - EJB3 Runtime Service”
Section 3.3.2.4.1.8, “JBossAS7 - Resource Adapters Runtime Service”

Connection Properties

Table 3.1004.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

Table 3.1005. Metrics
Name	Type	Description	Internal Name
Status	trait	The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was manually stopped.	status

Note

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

Configuration Properties

Table 3.1006.
Name	Required	Internal Name
Name	yes	name
Runtime Name	yes	runtime-name
Content	yes	content

Note

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

Operations

none

Package Types

none

3.3.2.4.1.1. JBossAS7 - Webservices Runtime Service

Overview

Table 3.1007. Overview
Description:	Runtime resources exposed by web service components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.1.1, “JBossAS7 - Endpoint Runtime Service”

Connection Properties

Table 3.1008.
Name	Description	Required	Internal 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.3.2.4.1.1.1. JBossAS7 - Endpoint Runtime Service

Overview

Table 3.1009. Overview
Description:	Webservice endpoint.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1010.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1011. Metrics
Name	Type	Description	Internal Name
Average Processing Time	measurement	Average endpoint processing time.	average-processing-time
Fault Count	measurement	Count of faults the endpoint generated.	fault-count
Max Processing Time	measurement	Maximal endpoint processing time.	max-processing-time
Min Processing Time	measurement	Minimal endpoint processing time.	min-processing-time
Request Count	measurement	Count of requests the endpoint processed.	request-count
Response Count	measurement	Count of responses the endpoint generated.	response-count
Total Processing Time	measurement	Total endpoint processing time.	total-processing-time

Note

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

Configuration Properties

Table 3.1012.
Name	Description	Required	Internal Name
Class	Webservice endpoint class.	no	class
Context	Webservice endpoint context.	no	context
Name	Webservice endpoint name.	no	name
Type	Webservice endpoint type.	no	type
Wsdl Url	Webservice endpoint WSDL URL.	no	wsdl-url

Note

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

Operations

none

Package Types

none

3.3.2.4.1.2. JBossAS7 - Web Runtime Service

Overview

Table 3.1013. Overview
Description:	Runtime resources exposed by web components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1014.
Name	Description	Required	Internal Name
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Path		yes	path

Note

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

Metrics

Table 3.1015. Metrics
Name	Type	Description	Internal Name
Virtual Host	trait	the virtual host this webapp is deployed to	virtual-host
Context Root	trait	the context root of this webapp	context-root
Response Time	calltime	the minimum, maximum, and average response times for requests serviced by this webapp	responseTime
Currently Active Sessions	measurement	The number of sessions that are currently active	active-sessions
Duplicated Session Ids	measurement	The number of duplicated session identifiers	duplicated-session-ids
Expired Sessions	measurement	The number of expired sessions	expired-sessions
Expired Sessions per Minute	measurement	The number of expired sessions	expired-sessions
Maximum Active Sessions	measurement	The maximum number of sessions that have been active	max-active-sessions
Rejected Sessions	measurement	The number of sessions rejected	rejected-sessions
Rejected Sessions per Minute	measurement	The number of sessions rejected	rejected-sessions
Average Session Alive Time	measurement	The average alive time of sessions	session-avg-alive-time
Max Session Alive Time	measurement	The maximum alive time of sessions	session-max-alive-time
Created Sessions	measurement	The number of sessions created	sessions-created
Created Sessions per Minute	measurement	The number of sessions created	sessions-created

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.3. JBossAS7 - Messaging Runtime Service

Overview

Table 3.1016. Overview
Description:	Runtime resources exposed by messaging resources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.3.1, “JBossAS7 - HornetQ Server Runtime Service”

Connection Properties

Table 3.1017.
Name	Description	Required	Internal 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.3.2.4.1.3.1. JBossAS7 - HornetQ Server Runtime Service

Overview

Table 3.1018. Overview
Description:	A HornetQ server instance.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.3.1.1, “JBossAS7 - JMS Queue Runtime Service”
Section 3.3.2.4.1.3.1.2, “JBossAS7 - JMS Topic Runtime Service”

Connection Properties

Table 3.1019.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1020. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this server is started.	started
Version	trait	The server's version.	version

Note

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

Configuration Properties

Table 3.1021.
Name	Description	Required	Internal Name
Allow Failback	Whether this server will automatically shutdown if the original live server comes back up. The default value is true.	no	allow-failback
Async Connection Execution Enabled	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true.	no	async-connection-execution-enabled
Backup	Whether this server is a backup server. The default value is false.	no	backup
Cluster Password	The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!.	no	cluster-password
Cluster User	The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	cluster-user
Clustered	Whether the server is clustered. The default value is false.	no	clustered
Connection Ttl Override	If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1.	no	connection-ttl-override
Create Bindings Dir	Whether the server should create the bindings directory on start up. The default value is true.	no	create-bindings-dir
Create Journal Dir	Whether the server should create the journal directory on start up. The default value is true.	no	create-journal-dir
Failback Delay	How long to wait before failback occurs on live server restart. The default value is 5000.	no	failback-delay
Failover On Shutdown	Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false.	no	failover-on-shutdown
Id Cache Size	The size of the cache for pre-creating message IDs. The default value is 2000.	no	id-cache-size
Jmx Domain	The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq.	no	jmx-domain
Jmx Management Enabled	Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false.	no	jmx-management-enabled
Journal Buffer Size	The size of the internal buffer on the journal.	no	journal-buffer-size
Journal Buffer Timeout	The timeout (in nanoseconds) used to flush internal buffers on the journal.	no	journal-buffer-timeout
Journal Compact Min Files	The minimal number of journal data files before we can start compacting. The default value is 10.	no	journal-compact-min-files
Journal Compact Percentage	The percentage of live data on which we consider compacting the journal. The default value is 30.	no	journal-compact-percentage
Journal File Size	The size (in bytes) of each journal file. The default value is 10485760.	no	journal-file-size
Journal Max Io	The maximum number of write requests that can be in the AIO queue at any one time.	no	journal-max-io
Journal Min Files	How many journal files to pre-create. The default value is 2.	no	journal-min-files
Journal Sync Non Transactional	Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true.	no	journal-sync-non-transactional
Journal Sync Transactional	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true.	no	journal-sync-transactional
Journal Type	The type of journal to use. The default value is ASYNCIO.	no	journal-type
Live Connector Ref	The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'.	no	live-connector-ref
Log Journal Write Rate	Whether to periodically log the journal's write rate and flush rate. The default value is false.	no	log-journal-write-rate
Management Address	Address to send management messages to. The default value is jms.queue.hornetq.management.	no	management-address
Management Notification Address	The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications.	no	management-notification-address
Memory Measure Interval	Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1.	no	memory-measure-interval:expr
Memory Warning Threshold	Percentage of available memory which if exceeded results in a warning log. The default value is 25.	no	memory-warning-threshold:expr
Message Counter Enabled	Whether message counters are enabled. The default value is false.	no	message-counter-enabled
Message Counter Max Day History	How many days to keep message counter history. The default value is 10.	no	message-counter-max-day-history
Message Counter Sample Period	The sample period (in ms) to use for message counters. The default value is 10000.	no	message-counter-sample-period
Message Expiry Scan Period	How often (in ms) to scan for expired messages. The default value is 30000.	no	message-expiry-scan-period
Message Expiry Thread Priority	The priority of the thread expiring messages. The default value is 3.	no	message-expiry-thread-priority
Page Max Concurrent Io	The maximum number of concurrent reads allowed on paging. The default value is 5.	no	page-max-concurrent-io
Perf Blast Pages	TODO. The default value is -1.	no	perf-blast-pages
Persist Delivery Count Before Delivery	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false.	no	persist-delivery-count-before-delivery
Persist Id Cache	Whether IDs are persisted to the journal. The default value is true.	no	persist-id-cache
Persistence Enabled	Whether the server will use the file based journal for persistence. The default value is true.	no	persistence-enabled
Remoting Interceptors	The list of interceptor classes used by this server.	no	remoting-interceptors:nullable
Run Sync Speed Test	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false.	no	run-sync-speed-test
Scheduled Thread Pool Max Size	The number of threads that the main scheduled thread pool has. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Security Domain	The security domain to use to verify user and role information. The default value is other.	no	security-domain
Security Enabled	Whether security is enabled. The default value is true.	no	security-enabled
Security Invalidation Interval	How long (in ms) to wait before invalidating the security cache. The default value is 10000.	no	security-invalidation-interval
Server Dump Interval	How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1.	no	server-dump-interval
Shared Store	Whether this server is using a shared store for failover. The default value is true.	no	shared-store
Thread Pool Max Size	The number of threads that the main thread pool has. -1 means no limit. The default value is 30.	no	thread-pool-max-size:expr
Transaction Timeout	How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000.	no	transaction-timeout
Transaction Timeout Scan Period	How often (in ms) to scan for timeout transactions. The default value is 1000.	no	transaction-timeout-scan-period
Wild Card Routing Enabled	Whether the server supports wild card routing. The default value is true.	no	wild-card-routing-enabled

Note

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

Operations

Table 3.1022. Metrics
Name	Description
Close Connections for Address	Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction	Heuristically commits a prepared transaction.
Force Failover	Force the messaging server to stop and notify clients to failover.
Get Address Settings as JSON	Returns the address settings as a JSON string for an address match. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON	Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID	Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time	Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON	Lists all the consumers.
List Connection IDs	Lists the IDs of all the connections connected to this server.
List Connections as JSON	List all JMS connections.
List Consumers as JSON	Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions	Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions	Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML	List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON	List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML	List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON	List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions	List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
List Producers Info as JSON	For all sessions, lists information about message producers using JSON serialization.
List Remote Addresses	Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List Sessions	Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON	Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations	Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories	Reset all message counters history.
Reset All Message Counters	Reset all message counters.
Rollback Prepared Transaction	Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.

Package Types

none

3.3.2.4.1.3.1.1. JBossAS7 - JMS Queue Runtime Service

Overview

Table 3.1023. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1024.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1025. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable	trait	Whether the queue is durable or not. The default value is true.	durable
Expiry Address	trait	The address to send expired messages to.	expiry-address
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Selector	trait	The queue selector.	selector
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

Table 3.1026.
Name	Description	Required	Internal Name
Entries	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.1027. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.2.4.1.3.1.2. JBossAS7 - JMS Topic Runtime Service

Overview

Table 3.1028. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1029.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1030. Metrics
Name	Type	Description	Internal Name
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable Message Count	measurement	The number of messages for all durable subscribers for this topic.	durable-message-count
Durable Subscription Count	measurement	The number of durable subscribers for this topic.	durable-subscription-count
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Non Durable Message Count	measurement	The number of messages for all non-durable subscribers for this topic.	non-durable-message-count
Non Durable Subscription Count	measurement	The number of non-durable subscribers for this topic.	non-durable-subscription-count
Subscription Count	measurement	The number of (durable and non-durable) subscribers for this topic.	subscription-count
Temporary	trait	Whether the topic is temporary.	temporary
Topic Address	trait	The address the topic points to.	topic-address

Note

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

Configuration Properties

Table 3.1031.
Name	Description	Required	Internal Name
JNDI Names	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.1032. Metrics
Name	Description
Count Messages for Subscription	Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions	Drop all subscriptions from this topic.
Drop Durable Subscription	Drop a durable subscription
List All Subscriptions	List all subscriptions.
List All Subscriptions as JSON	List all subscriptions as a string in JSON format.
List Durable Subscriptions	List only the durable subscriptions.
List Durable Subscriptions as JSON	List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription	List all the messages for the given subscription.
List Messages for Subscription as JSON	List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions	List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON	List only the non-durable subscriptions, as a string in JSON format.
Remove Messages	Remove messages matching the given filter from the destination.

Package Types

none

3.3.2.4.1.4. JBossAS7 - Subdeployment Service

Overview

Table 3.1033. Overview
Description:	Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.1, “JBossAS7 - Webservices Runtime Service”
Section 3.3.2.4.1.4.2, “JBossAS7 - Web Runtime Service”
Section 3.3.2.4.1.4.3, “JBossAS7 - Messaging Runtime Service”
Section 3.3.2.4.1.4.4, “JBossAS7 - JPA Runtime Service”
Section 3.3.2.4.1.4.5, “JBossAS7 - Datasources Runtime Service”
Section 3.3.2.4.1.4.6, “JBossAS7 - EJB3 Runtime Service”
Section 3.3.2.4.1.4.7, “JBossAS7 - Resource Adapters Runtime Service”

Connection Properties

Table 3.1034.
Name	Description	Required	Internal 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.3.2.4.1.4.1. JBossAS7 - Webservices Runtime Service

Overview

Table 3.1035. Overview
Description:	Runtime resources exposed by web service components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.1.1, “JBossAS7 - Endpoint Runtime Service”

Connection Properties

Table 3.1036.
Name	Description	Required	Internal 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.3.2.4.1.4.1.1. JBossAS7 - Endpoint Runtime Service

Overview

Table 3.1037. Overview
Description:	Webservice endpoint.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1038.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1039. Metrics
Name	Type	Description	Internal Name
Average Processing Time	measurement	Average endpoint processing time.	average-processing-time
Fault Count	measurement	Count of faults the endpoint generated.	fault-count
Max Processing Time	measurement	Maximal endpoint processing time.	max-processing-time
Min Processing Time	measurement	Minimal endpoint processing time.	min-processing-time
Request Count	measurement	Count of requests the endpoint processed.	request-count
Response Count	measurement	Count of responses the endpoint generated.	response-count
Total Processing Time	measurement	Total endpoint processing time.	total-processing-time

Note

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

Configuration Properties

Table 3.1040.
Name	Description	Required	Internal Name
Class	Webservice endpoint class.	no	class
Context	Webservice endpoint context.	no	context
Name	Webservice endpoint name.	no	name
Type	Webservice endpoint type.	no	type
Wsdl Url	Webservice endpoint WSDL URL.	no	wsdl-url

Note

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

Operations

none

Package Types

none

3.3.2.4.1.4.2. JBossAS7 - Web Runtime Service

Overview

Table 3.1041. Overview
Description:	Runtime resources exposed by web components in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1042.
Name	Description	Required	Internal Name
Response Time Log File	the full path to the log file containing response-time stats for this webapp	no	responseTimeLogFile
Response Time Url Excludes	a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection	no	responseTimeUrlExcludes
Response Time Url Transforms	a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. \|^/dept/finance/.\|/dept/finance/\|)	no	responseTimeUrlTransforms
Path		yes	path

Note

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

Metrics

Table 3.1043. Metrics
Name	Type	Description	Internal Name
Virtual Host	trait	the virtual host this webapp is deployed to	virtual-host
Context Root	trait	the context root of this webapp	context-root
Response Time	calltime	the minimum, maximum, and average response times for requests serviced by this webapp	responseTime
Currently Active Sessions	measurement	The number of sessions that are currently active	active-sessions
Duplicated Session Ids	measurement	The number of duplicated session identifiers	duplicated-session-ids
Expired Sessions	measurement	The number of expired sessions	expired-sessions
Expired Sessions per Minute	measurement	The number of expired sessions	expired-sessions
Maximum Active Sessions	measurement	The maximum number of sessions that have been active	max-active-sessions
Rejected Sessions	measurement	The number of sessions rejected	rejected-sessions
Rejected Sessions per Minute	measurement	The number of sessions rejected	rejected-sessions
Average Session Alive Time	measurement	The average alive time of sessions	session-avg-alive-time
Max Session Alive Time	measurement	The maximum alive time of sessions	session-max-alive-time
Created Sessions	measurement	The number of sessions created	sessions-created
Created Sessions per Minute	measurement	The number of sessions created	sessions-created

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.4.3. JBossAS7 - Messaging Runtime Service

Overview

Table 3.1044. Overview
Description:	Runtime resources exposed by messaging resources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.3.1, “JBossAS7 - HornetQ Server Runtime Service”

Connection Properties

Table 3.1045.
Name	Description	Required	Internal 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.3.2.4.1.4.3.1. JBossAS7 - HornetQ Server Runtime Service

Overview

Table 3.1046. Overview
Description:	A HornetQ server instance.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.3.1.1, “JBossAS7 - JMS Queue Runtime Service”
Section 3.3.2.4.1.4.3.1.2, “JBossAS7 - JMS Topic Runtime Service”

Connection Properties

Table 3.1047.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1048. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this server is started.	started
Version	trait	The server's version.	version

Note

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

Configuration Properties

Table 3.1049.
Name	Description	Required	Internal Name
Allow Failback	Whether this server will automatically shutdown if the original live server comes back up. The default value is true.	no	allow-failback
Async Connection Execution Enabled	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true.	no	async-connection-execution-enabled
Backup	Whether this server is a backup server. The default value is false.	no	backup
Cluster Password	The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!.	no	cluster-password
Cluster User	The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	cluster-user
Clustered	Whether the server is clustered. The default value is false.	no	clustered
Connection Ttl Override	If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1.	no	connection-ttl-override
Create Bindings Dir	Whether the server should create the bindings directory on start up. The default value is true.	no	create-bindings-dir
Create Journal Dir	Whether the server should create the journal directory on start up. The default value is true.	no	create-journal-dir
Failback Delay	How long to wait before failback occurs on live server restart. The default value is 5000.	no	failback-delay
Failover On Shutdown	Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false.	no	failover-on-shutdown
Id Cache Size	The size of the cache for pre-creating message IDs. The default value is 2000.	no	id-cache-size
Jmx Domain	The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq.	no	jmx-domain
Jmx Management Enabled	Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false.	no	jmx-management-enabled
Journal Buffer Size	The size of the internal buffer on the journal.	no	journal-buffer-size
Journal Buffer Timeout	The timeout (in nanoseconds) used to flush internal buffers on the journal.	no	journal-buffer-timeout
Journal Compact Min Files	The minimal number of journal data files before we can start compacting. The default value is 10.	no	journal-compact-min-files
Journal Compact Percentage	The percentage of live data on which we consider compacting the journal. The default value is 30.	no	journal-compact-percentage
Journal File Size	The size (in bytes) of each journal file. The default value is 10485760.	no	journal-file-size
Journal Max Io	The maximum number of write requests that can be in the AIO queue at any one time.	no	journal-max-io
Journal Min Files	How many journal files to pre-create. The default value is 2.	no	journal-min-files
Journal Sync Non Transactional	Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true.	no	journal-sync-non-transactional
Journal Sync Transactional	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true.	no	journal-sync-transactional
Journal Type	The type of journal to use. The default value is ASYNCIO.	no	journal-type
Live Connector Ref	The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'.	no	live-connector-ref
Log Journal Write Rate	Whether to periodically log the journal's write rate and flush rate. The default value is false.	no	log-journal-write-rate
Management Address	Address to send management messages to. The default value is jms.queue.hornetq.management.	no	management-address
Management Notification Address	The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications.	no	management-notification-address
Memory Measure Interval	Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1.	no	memory-measure-interval:expr
Memory Warning Threshold	Percentage of available memory which if exceeded results in a warning log. The default value is 25.	no	memory-warning-threshold:expr
Message Counter Enabled	Whether message counters are enabled. The default value is false.	no	message-counter-enabled
Message Counter Max Day History	How many days to keep message counter history. The default value is 10.	no	message-counter-max-day-history
Message Counter Sample Period	The sample period (in ms) to use for message counters. The default value is 10000.	no	message-counter-sample-period
Message Expiry Scan Period	How often (in ms) to scan for expired messages. The default value is 30000.	no	message-expiry-scan-period
Message Expiry Thread Priority	The priority of the thread expiring messages. The default value is 3.	no	message-expiry-thread-priority
Page Max Concurrent Io	The maximum number of concurrent reads allowed on paging. The default value is 5.	no	page-max-concurrent-io
Perf Blast Pages	TODO. The default value is -1.	no	perf-blast-pages
Persist Delivery Count Before Delivery	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false.	no	persist-delivery-count-before-delivery
Persist Id Cache	Whether IDs are persisted to the journal. The default value is true.	no	persist-id-cache
Persistence Enabled	Whether the server will use the file based journal for persistence. The default value is true.	no	persistence-enabled
Remoting Interceptors	The list of interceptor classes used by this server.	no	remoting-interceptors:nullable
Run Sync Speed Test	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false.	no	run-sync-speed-test
Scheduled Thread Pool Max Size	The number of threads that the main scheduled thread pool has. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Security Domain	The security domain to use to verify user and role information. The default value is other.	no	security-domain
Security Enabled	Whether security is enabled. The default value is true.	no	security-enabled
Security Invalidation Interval	How long (in ms) to wait before invalidating the security cache. The default value is 10000.	no	security-invalidation-interval
Server Dump Interval	How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1.	no	server-dump-interval
Shared Store	Whether this server is using a shared store for failover. The default value is true.	no	shared-store
Thread Pool Max Size	The number of threads that the main thread pool has. -1 means no limit. The default value is 30.	no	thread-pool-max-size:expr
Transaction Timeout	How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000.	no	transaction-timeout
Transaction Timeout Scan Period	How often (in ms) to scan for timeout transactions. The default value is 1000.	no	transaction-timeout-scan-period
Wild Card Routing Enabled	Whether the server supports wild card routing. The default value is true.	no	wild-card-routing-enabled

Note

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

Operations

Table 3.1050. Metrics
Name	Description
Close Connections for Address	Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction	Heuristically commits a prepared transaction.
Force Failover	Force the messaging server to stop and notify clients to failover.
Get Address Settings as JSON	Returns the address settings as a JSON string for an address match. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON	Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID	Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time	Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON	Lists all the consumers.
List Connection IDs	Lists the IDs of all the connections connected to this server.
List Connections as JSON	List all JMS connections.
List Consumers as JSON	Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions	Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions	Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML	List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON	List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML	List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON	List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions	List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
List Producers Info as JSON	For all sessions, lists information about message producers using JSON serialization.
List Remote Addresses	Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List Sessions	Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON	Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations	Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories	Reset all message counters history.
Reset All Message Counters	Reset all message counters.
Rollback Prepared Transaction	Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.

Package Types

none

3.3.2.4.1.4.3.1.1. JBossAS7 - JMS Queue Runtime Service

Overview

Table 3.1051. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1052.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1053. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable	trait	Whether the queue is durable or not. The default value is true.	durable
Expiry Address	trait	The address to send expired messages to.	expiry-address
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Selector	trait	The queue selector.	selector
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

Table 3.1054.
Name	Description	Required	Internal Name
Entries	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.1055. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.2.4.1.4.3.1.2. JBossAS7 - JMS Topic Runtime Service

Overview

Table 3.1056. Overview
Description:	Defines a JMS queue.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1057.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1058. Metrics
Name	Type	Description	Internal Name
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable Message Count	measurement	The number of messages for all durable subscribers for this topic.	durable-message-count
Durable Subscription Count	measurement	The number of durable subscribers for this topic.	durable-subscription-count
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Non Durable Message Count	measurement	The number of messages for all non-durable subscribers for this topic.	non-durable-message-count
Non Durable Subscription Count	measurement	The number of non-durable subscribers for this topic.	non-durable-subscription-count
Subscription Count	measurement	The number of (durable and non-durable) subscribers for this topic.	subscription-count
Temporary	trait	Whether the topic is temporary.	temporary
Topic Address	trait	The address the topic points to.	topic-address

Note

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

Configuration Properties

Table 3.1059.
Name	Description	Required	Internal Name
JNDI Names	The jndi names the queue will be bound to.	no	entries

Note

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

Operations

Table 3.1060. Metrics
Name	Description
Count Messages for Subscription	Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions	Drop all subscriptions from this topic.
Drop Durable Subscription	Drop a durable subscription
List All Subscriptions	List all subscriptions.
List All Subscriptions as JSON	List all subscriptions as a string in JSON format.
List Durable Subscriptions	List only the durable subscriptions.
List Durable Subscriptions as JSON	List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription	List all the messages for the given subscription.
List Messages for Subscription as JSON	List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions	List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON	List only the non-durable subscriptions, as a string in JSON format.
Remove Messages	Remove messages matching the given filter from the destination.

Package Types

none

3.3.2.4.1.4.4. JBossAS7 - JPA Runtime Service

Overview

Table 3.1061. Overview
Description:	The configuration of the JPA subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.4.1, “JBossAS7 - Hibernate Persistence Unit Service”

Connection Properties

Table 3.1062.
Name	Description	Required	Internal 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.3.2.4.1.4.4.1. JBossAS7 - Hibernate Persistence Unit Service

Overview

Table 3.1063. Overview
Description:	Runtime information about JPA use in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.4.1.1, “JBossAS7 - Entity Cache Service”
Section 3.3.2.4.1.4.4.1.2, “JBossAS7 - Entity Service”
Section 3.3.2.4.1.4.4.1.3, “JBossAS7 - Collection Service”

Connection Properties

Table 3.1064.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1065. Metrics
Name	Type	Description	Internal Name
Close Statement Count	measurement	Number of released prepared statements.	close-statement-count
Close Statement Count per Minute	measurement	Number of released prepared statements.	close-statement-count
Collection Fetch Count	measurement	Number of collections fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of collections fetched.	collection-fetch-count
Collection Load Count	measurement	Number of collections loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of collections loaded.	collection-load-count
Collection Recreated Count	measurement	Number of collections recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of collections recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of collections removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of collections removed.	collection-remove-count
Collection Update Count	measurement	Number of collections updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of collections updated.	collection-update-count
Completed Transaction Count	measurement	Number of completed transactions.	completed-transaction-count
Completed Transaction Count per Minute	measurement	Number of completed transactions.	completed-transaction-count
Connect Count	measurement	Get the number of connections asked for by the sessions.	connect-count
Connect Count per Minute	measurement	Get the number of connections asked for by the sessions.	connect-count
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Flush Count	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Flush Count per Minute	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Prepared Statement Count	measurement	Number of acquired prepared statements.	prepared-statement-count
Prepared Statement Count per Minute	measurement	Number of acquired prepared statements.	prepared-statement-count
Query Cache Hit Count	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Hit Count per Minute	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Miss Count	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Miss Count per Minute	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Put Count	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Cache Put Count per Minute	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Execution Count	measurement	Get number of executed queries.	query-execution-count
Query Execution Count per Minute	measurement	Get number of executed queries.	query-execution-count
Query Execution Max Time	measurement	Get the time in milliseconds of the slowest query.	query-execution-max-time
Query Execution Max Time Query String	trait	Get the query string for the slowest query.	query-execution-max-time-query-string
Second Level Cache Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Hit Count per Minute	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Miss Count per Minute	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Put Count	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Second Level Cache Put Count per Minute	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Session Close Count	measurement	Number of sessions closed.	session-close-count
Session Close Count per Minute	measurement	Number of sessions closed.	session-close-count
Session Open Count	measurement	Number of sessions opened.	session-open-count
Session Open Count per Minute	measurement	Number of sessions opened.	session-open-count
Successful Transaction Count	measurement	Number of successful transactions.	successful-transaction-count
Successful Transaction Count per Minute	measurement	Number of successful transactions.	successful-transaction-count

Note

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

Configuration Properties

Table 3.1066.
Name	Description	Required	Internal Name
Enabled	Determine if statistics are enabled.	no	enabled

Note

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

Operations

Table 3.1067. Metrics
Name	Description
Subsystem:clear	Clear statistics.
Subsystem:evict All	Evict all entities from second level cache.
Subsystem:summary	Log the statistics.
View Queries	View statistical information about queries executed by Hibernate

Package Types

none

3.3.2.4.1.4.4.1.1. JBossAS7 - Entity Cache Service

Overview

Table 3.1068. Overview
Description:	Statistics for a Hibernate Second Level Cache region.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1069.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1070. Metrics
Name	Type	Description	Internal Name
Element Count In Memory	measurement	Number of cacheable entities/collections currently stored in memory.	element-count-in-memory
Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	hit-count
Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	miss-count
Put Count	measurement	Number of cacheable entities/collections put in the cache.	put-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.4.4.1.2. JBossAS7 - Entity Service

Overview

Table 3.1071. Overview
Description:	Statistics for individual entities.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1072.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1073. Metrics
Name	Type	Description	Internal Name
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.4.4.1.3. JBossAS7 - Collection Service

Overview

Table 3.1074. Overview
Description:	Statistics for individual collections.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1075.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1076. Metrics
Name	Type	Description	Internal Name
Collection Fetch Count	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Load Count	measurement	Number of times collection was loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of times collection was loaded.	collection-load-count
Collection Recreated Count	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of times collection was removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of times collection was removed.	collection-remove-count
Collection Update Count	measurement	Number of times collection was updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of times collection was updated.	collection-update-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.4.5. JBossAS7 - Datasources Runtime Service

Overview

Table 3.1077. Overview
Description:	Runtime resources exposed by data sources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.5.1, “JBossAS7 - XA Datasource Runtime Service”
Section 3.3.2.4.1.4.5.2, “JBossAS7 - Datasource Runtime Service”

Connection Properties

Table 3.1078.
Name	Description	Required	Internal 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.3.2.4.1.4.5.1. JBossAS7 - XA Datasource Runtime Service

Overview

Table 3.1079. Overview
Description:	A JDBC XA data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1080.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1081. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.1082.
Name	Description	Required	Internal Name
Properties		no	*2
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Interleaving	An element to enable interleaving for XA connections. The default value is false.	no	interleaving
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
No Recovery	Specifies if the connection pool should be excluded from recovery	no	no-recovery
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false.	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded. The default value is false.	no	pad-xid
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Recovery Password	The password used for recovery	no	recovery-password
Recovery Plugin Class Name	The fully qualified class name of the recovery plugin implementation	no	recovery-plugin-class-name
Recovery Plugin Properties	The properties for the recovery plugin	no	recovery-plugin-properties
Recovery Security Domain	The security domain used for recovery	no	recovery-security-domain
Recovery Username	The user name used for recovery	no	recovery-username
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match
Wrap Xa Resource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true.	no	wrap-xa-resource
Xa Datasource Class	The fully qualifed name of the javax.sql.XADataSource implementation	no	xa-datasource-class
Xa Resource Timeout	The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero	no	xa-resource-timeout

Note

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

Operations

Table 3.1083. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.2.4.1.4.5.2. JBossAS7 - Datasource Runtime Service

Overview

Table 3.1084. Overview
Description:	A JDBC data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1085.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1086. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.1087.
Name	Description	Required	Internal Name
Connection Property		no	*1
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Connection Url	The JDBC driver connection URL	no	connection-url
Datasource Class	The fully qualifed name of the JDBC datasource class	no	datasource-class
Driver Class	The fully qualifed name of the JDBC driver class	no	driver-class
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match

Note

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

Operations

Table 3.1088. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.2.4.1.4.6. JBossAS7 - EJB3 Runtime Service

Overview

Table 3.1089. Overview
Description:	Runtime resources exposed by EJBs components included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.6.1, “JBossAS7 - Message Driven Bean Runtime Service”
Section 3.3.2.4.1.4.6.2, “JBossAS7 - Singleton Bean Runtime Service”
Section 3.3.2.4.1.4.6.3, “JBossAS7 - Stateless Session Bean Runtime Service”
Section 3.3.2.4.1.4.6.4, “JBossAS7 - Entity Bean Runtime Service”
Section 3.3.2.4.1.4.6.5, “JBossAS7 - Stateful Session Bean Runtime Service”

Connection Properties

Table 3.1090.
Name	Description	Required	Internal 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.3.2.4.1.4.6.1. JBossAS7 - Message Driven Bean Runtime Service

Overview

Table 3.1091. Overview
Description:	Bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1092.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1093. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1094.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.2.4.1.4.6.2. JBossAS7 - Singleton Bean Runtime Service

Overview

Table 3.1095. Overview
Description:	Singleton bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1096.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1097. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1098.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.2.4.1.4.6.3. JBossAS7 - Stateless Session Bean Runtime Service

Overview

Table 3.1099. Overview
Description:	Stateless session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1100.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1101. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1102.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.2.4.1.4.6.4. JBossAS7 - Entity Bean Runtime Service

Overview

Table 3.1103. Overview
Description:	Entity bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1104.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1105. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1106.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.2.4.1.4.6.5. JBossAS7 - Stateful Session Bean Runtime Service

Overview

Table 3.1107. Overview
Description:	Stateful session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1108.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1109. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1110.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.2.4.1.4.7. JBossAS7 - Resource Adapters Runtime Service

Overview

Table 3.1111. Overview
Description:	Configuration of the resource adapters subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.4.7.1, “JBossAS7 - Connection Definition Runtime Service”

Connection Properties

Table 3.1112.
Name	Description	Required	Internal 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.3.2.4.1.4.7.1. JBossAS7 - Connection Definition Runtime Service

Overview

Table 3.1113. Overview
Description:	Specifies the connection definitions.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1114.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1115. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.5. JBossAS7 - JPA Runtime Service

Overview

Table 3.1116. Overview
Description:	The configuration of the JPA subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.5.1, “JBossAS7 - Hibernate Persistence Unit Service”

Connection Properties

Table 3.1117.
Name	Description	Required	Internal 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.3.2.4.1.5.1. JBossAS7 - Hibernate Persistence Unit Service

Overview

Table 3.1118. Overview
Description:	Runtime information about JPA use in the deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.5.1.1, “JBossAS7 - Entity Cache Service”
Section 3.3.2.4.1.5.1.2, “JBossAS7 - Entity Service”
Section 3.3.2.4.1.5.1.3, “JBossAS7 - Collection Service”

Connection Properties

Table 3.1119.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1120. Metrics
Name	Type	Description	Internal Name
Close Statement Count	measurement	Number of released prepared statements.	close-statement-count
Close Statement Count per Minute	measurement	Number of released prepared statements.	close-statement-count
Collection Fetch Count	measurement	Number of collections fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of collections fetched.	collection-fetch-count
Collection Load Count	measurement	Number of collections loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of collections loaded.	collection-load-count
Collection Recreated Count	measurement	Number of collections recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of collections recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of collections removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of collections removed.	collection-remove-count
Collection Update Count	measurement	Number of collections updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of collections updated.	collection-update-count
Completed Transaction Count	measurement	Number of completed transactions.	completed-transaction-count
Completed Transaction Count per Minute	measurement	Number of completed transactions.	completed-transaction-count
Connect Count	measurement	Get the number of connections asked for by the sessions.	connect-count
Connect Count per Minute	measurement	Get the number of connections asked for by the sessions.	connect-count
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Flush Count	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Flush Count per Minute	measurement	Get the number of flushes executed by sessions (either implicit or explicit).	flush-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Prepared Statement Count	measurement	Number of acquired prepared statements.	prepared-statement-count
Prepared Statement Count per Minute	measurement	Number of acquired prepared statements.	prepared-statement-count
Query Cache Hit Count	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Hit Count per Minute	measurement	Get the number of cached queries successfully retrieved from cache.	query-cache-hit-count
Query Cache Miss Count	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Miss Count per Minute	measurement	Get the number of cached queries not found in cache.	query-cache-miss-count
Query Cache Put Count	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Cache Put Count per Minute	measurement	Get the number of cacheable queries put in cache.	query-cache-put-count
Query Execution Count	measurement	Get number of executed queries.	query-execution-count
Query Execution Count per Minute	measurement	Get number of executed queries.	query-execution-count
Query Execution Max Time	measurement	Get the time in milliseconds of the slowest query.	query-execution-max-time
Query Execution Max Time Query String	trait	Get the query string for the slowest query.	query-execution-max-time-query-string
Second Level Cache Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Hit Count per Minute	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	second-level-cache-hit-count
Second Level Cache Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Miss Count per Minute	measurement	Number of cacheable entities/collections not found in the cache and loaded.	second-level-cache-miss-count
Second Level Cache Put Count	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Second Level Cache Put Count per Minute	measurement	Number of cacheable entities/collections put in the cache.	second-level-cache-put-count
Session Close Count	measurement	Number of sessions closed.	session-close-count
Session Close Count per Minute	measurement	Number of sessions closed.	session-close-count
Session Open Count	measurement	Number of sessions opened.	session-open-count
Session Open Count per Minute	measurement	Number of sessions opened.	session-open-count
Successful Transaction Count	measurement	Number of successful transactions.	successful-transaction-count
Successful Transaction Count per Minute	measurement	Number of successful transactions.	successful-transaction-count

Note

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

Configuration Properties

Table 3.1121.
Name	Description	Required	Internal Name
Enabled	Determine if statistics are enabled.	no	enabled

Note

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

Operations

Table 3.1122. Metrics
Name	Description
Subsystem:clear	Clear statistics.
Subsystem:evict All	Evict all entities from second level cache.
Subsystem:summary	Log the statistics.
View Queries	View statistical information about queries executed by Hibernate

Package Types

none

3.3.2.4.1.5.1.1. JBossAS7 - Entity Cache Service

Overview

Table 3.1123. Overview
Description:	Statistics for a Hibernate Second Level Cache region.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1124.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1125. Metrics
Name	Type	Description	Internal Name
Element Count In Memory	measurement	Number of cacheable entities/collections currently stored in memory.	element-count-in-memory
Hit Count	measurement	Number of cacheable entities/collections successfully retrieved from the cache.	hit-count
Miss Count	measurement	Number of cacheable entities/collections not found in the cache and loaded.	miss-count
Put Count	measurement	Number of cacheable entities/collections put in the cache.	put-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.5.1.2. JBossAS7 - Entity Service

Overview

Table 3.1126. Overview
Description:	Statistics for individual entities.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1127.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1128. Metrics
Name	Type	Description	Internal Name
Entity Delete Count	measurement	Get number of entity deletes.	entity-delete-count
Entity Delete Count per Minute	measurement	Get number of entity deletes.	entity-delete-count
Entity Fetch Count	measurement	Get number of entity fetches.	entity-fetch-count
Entity Fetch Count per Minute	measurement	Get number of entity fetches.	entity-fetch-count
Entity Insert Count	measurement	Get number of entity inserts.	entity-insert-count
Entity Insert Count per Minute	measurement	Get number of entity inserts.	entity-insert-count
Entity Load Count	measurement	Get number of entity loads.	entity-load-count
Entity Load Count per Minute	measurement	Get number of entity loads.	entity-load-count
Entity Update Count	measurement	Get number of entity updates.	entity-update-count
Entity Update Count per Minute	measurement	Get number of entity updates.	entity-update-count
Optimistic Failure Count	measurement	Number of optimistic lock exceptions.	optimistic-failure-count
Optimistic Failure Count per Minute	measurement	Number of optimistic lock exceptions.	optimistic-failure-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.5.1.3. JBossAS7 - Collection Service

Overview

Table 3.1129. Overview
Description:	Statistics for individual collections.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1130.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1131. Metrics
Name	Type	Description	Internal Name
Collection Fetch Count	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Fetch Count per Minute	measurement	Number of times collection was fetched.	collection-fetch-count
Collection Load Count	measurement	Number of times collection was loaded.	collection-load-count
Collection Load Count per Minute	measurement	Number of times collection was loaded.	collection-load-count
Collection Recreated Count	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Recreated Count per Minute	measurement	Number of times collection was recreated.	collection-recreated-count
Collection Remove Count	measurement	Number of times collection was removed.	collection-remove-count
Collection Remove Count per Minute	measurement	Number of times collection was removed.	collection-remove-count
Collection Update Count	measurement	Number of times collection was updated.	collection-update-count
Collection Update Count per Minute	measurement	Number of times collection was updated.	collection-update-count

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.1.6. JBossAS7 - Datasources Runtime Service

Overview

Table 3.1132. Overview
Description:	Runtime resources exposed by data sources included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.6.1, “JBossAS7 - XA Datasource Runtime Service”
Section 3.3.2.4.1.6.2, “JBossAS7 - Datasource Runtime Service”

Connection Properties

Table 3.1133.
Name	Description	Required	Internal 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.3.2.4.1.6.1. JBossAS7 - XA Datasource Runtime Service

Overview

Table 3.1134. Overview
Description:	A JDBC XA data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1135.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1136. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.1137.
Name	Description	Required	Internal Name
Properties		no	*2
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Interleaving	An element to enable interleaving for XA connections. The default value is false.	no	interleaving
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
No Recovery	Specifies if the connection pool should be excluded from recovery	no	no-recovery
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false.	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded. The default value is false.	no	pad-xid
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Recovery Password	The password used for recovery	no	recovery-password
Recovery Plugin Class Name	The fully qualified class name of the recovery plugin implementation	no	recovery-plugin-class-name
Recovery Plugin Properties	The properties for the recovery plugin	no	recovery-plugin-properties
Recovery Security Domain	The security domain used for recovery	no	recovery-security-domain
Recovery Username	The user name used for recovery	no	recovery-username
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match
Wrap Xa Resource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true.	no	wrap-xa-resource
Xa Datasource Class	The fully qualifed name of the javax.sql.XADataSource implementation	no	xa-datasource-class
Xa Resource Timeout	The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero	no	xa-resource-timeout

Note

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

Operations

Table 3.1138. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.2.4.1.6.2. JBossAS7 - Datasource Runtime Service

Overview

Table 3.1139. Overview
Description:	A JDBC data-source configuration
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1140.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1141. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.1142.
Name	Description	Required	Internal Name
Connection Property		no	*1
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise	no	background-validation-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool	no	check-valid-connection-sql
Connection Url	The JDBC driver connection URL	no	connection-url
Datasource Class	The fully qualifed name of the JDBC datasource class	no	datasource-class
Driver Class	The fully qualifed name of the JDBC driver class	no	driver-class
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	no	driver-name
Enabled	Specifies if the datasource should be enabled	no	enabled
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error	no	exception-sorter-class-name
Exception Sorter Properties	The exception sorter properties	no	exception-sorter-properties
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.	no	idle-timeout-minutes
Jndi Name	Specifies the JNDI name for the datasource	no	jndi-name
Jta	Enable JTA integration. The default value is true.	no	jta
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool	no	new-connection-sql
Password	Specifies the password used when creating a new connection	no	password
Pool Prefill	Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Query Timeout	Any configured query timeout in seconds. If not provided no timeout will be set	no	query-timeout
Reauth Plugin Class Name	The fully qualified class name of the reauthentication plugin implementation	no	reauth-plugin-class-name
Reauth Plugin Properties	The properties for the reauthentication plugin	no	reauth-plugin-properties
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction. The default value is false.	no	set-tx-query-timeout
Share Prepared Statements	Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false.	no	share-prepared-statements
Spy	Enable spying of SQL statements. The default value is false.	no	spy
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Stale Connection Checker Properties	The stale connection checker properties	no	stale-connection-checker-properties
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'.	no	track-statements
Transaction Isolation	Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE	no	transaction-isolation
Url Delimiter	Specifies the delimeter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the datasource into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
User Name	Specify the user name used when creating a new connection	no	user-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element	no	valid-connection-checker-class-name
Valid Connection Checker Properties	The valid connection checker properties	no	valid-connection-checker-properties
Validate On Match	The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false.	no	validate-on-match

Note

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

Operations

Table 3.1143. Metrics
Name	Description
Subsystem:flush All Connection In Pool	Flushes all connections in the pool
Subsystem:flush Idle Connection In Pool	Flushes all idle connections in the pool
Subsystem:test Connection In Pool	Test if a connection can be obtained

Package Types

none

3.3.2.4.1.7. JBossAS7 - EJB3 Runtime Service

Overview

Table 3.1144. Overview
Description:	Runtime resources exposed by EJBs components included in this deployment.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.7.1, “JBossAS7 - Message Driven Bean Runtime Service”
Section 3.3.2.4.1.7.2, “JBossAS7 - Singleton Bean Runtime Service”
Section 3.3.2.4.1.7.3, “JBossAS7 - Stateless Session Bean Runtime Service”
Section 3.3.2.4.1.7.4, “JBossAS7 - Entity Bean Runtime Service”
Section 3.3.2.4.1.7.5, “JBossAS7 - Stateful Session Bean Runtime Service”

Connection Properties

Table 3.1145.
Name	Description	Required	Internal 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.3.2.4.1.7.1. JBossAS7 - Message Driven Bean Runtime Service

Overview

Table 3.1146. Overview
Description:	Bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1147.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1148. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1149.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.2.4.1.7.2. JBossAS7 - Singleton Bean Runtime Service

Overview

Table 3.1150. Overview
Description:	Singleton bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1151.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1152. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1153.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.2.4.1.7.3. JBossAS7 - Stateless Session Bean Runtime Service

Overview

Table 3.1154. Overview
Description:	Stateless session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1155.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1156. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1157.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain
Timers	EJB timers associated with the component.	yes	timers

Note

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

Operations

none

Package Types

none

3.3.2.4.1.7.4. JBossAS7 - Entity Bean Runtime Service

Overview

Table 3.1158. Overview
Description:	Entity bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1159.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1160. Metrics
Name	Type	Description	Internal Name
Pool Available Count	measurement	The number of available (i.e. not in use) instances in the pool.	pool-available-count
Pool Create Count	measurement	The number of instances created for the pool.	pool-create-count
Pool Current Size	measurement	The current size of the instance pool.	pool-current-size
Pool Max Size	measurement	The maximum size of the instance pool.	pool-max-size
Pool Remove Count	measurement	The number of instances removed from the pool.	pool-remove-count
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1161.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.2.4.1.7.5. JBossAS7 - Stateful Session Bean Runtime Service

Overview

Table 3.1162. Overview
Description:	Stateful session bean component included in the deployment.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1163.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1164. Metrics
Name	Type	Description	Internal Name
Peak concurrent invocations	measurement	The maximum number of concurrent invocations at any given time.	peak-concurrent-invocations
Invocations	measurement	The total number of invocations made on this EJB.	invocations
Invocations per Minute	measurement	Number of invocations processed.	invocations
Wait Time	measurement	Total sum of wait-time for all methods in milliseconds.	wait-time
Execution Time	measurement	Total execution-time (sum of all execution-time from all of the methods) in milliseconds	execution-time
Execution Time per Minute	measurement	Time spent within a bean method	execution-time
Method Execution Time	calltime	The execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem	__calltime:execution-time

Note

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

Configuration Properties

Table 3.1165.
Name	Description	Required	Internal Name
Component Class Name	The component's class name.	no	component-class-name
Declared Roles	The roles declared (via @DeclareRoles) on this EJB component.	yes	declared-roles
Run As Role	The run-as role (if any) for this EJB component.	no	run-as-role
Security Domain	The security domain for this EJB component.	no	security-domain

Note

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

Operations

none

Package Types

none

3.3.2.4.1.8. JBossAS7 - Resource Adapters Runtime Service

Overview

Table 3.1166. Overview
Description:	Configuration of the resource adapters subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.1.8.1, “JBossAS7 - Connection Definition Runtime Service”

Connection Properties

Table 3.1167.
Name	Description	Required	Internal 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.3.2.4.1.8.1. JBossAS7 - Connection Definition Runtime Service

Overview

Table 3.1168. Overview
Description:	Specifies the connection definitions.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1169.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1170. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.2. JBossAS7 - Naming (Managed Server) Service

Overview

Table 3.1171. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.2.1, “JBossAS7 - Binding (Managed Server) Service”

Connection Properties

Table 3.1172.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 3.1173. Metrics
Name	Description
JNDIView	Peek at the JNDI tree

Package Types

none

3.3.2.4.2.1. JBossAS7 - Binding (Managed Server) Service

Overview

Table 3.1174. Overview
Description:	JNDI bindings for primitive types
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1175.
Name	Description	Required	Internal 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.1176.
Name	Description	Required	Internal Name
Binding Type	The type of binding to create, may be simple, lookup or object-factory	yes	binding-type
Class	The object factory class name for object factory bindings	no	class
Lookup	The entry to lookup in JNDI for lookup bindings	no	lookup
Module	The module to load the object factory from for object factory bindings	no	module
Type	The type of the value to bind for simple bindings, this must be a primitive type	no	type
Value	The value to bind for simple bindings	no	value

Note

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

Operations

none

Package Types

none

3.3.2.4.3. JBossAS7 - Webservices (Managed Server) Service

Overview

Table 3.1177. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.3.1, “JBossAS7 - Endpoint (Managed Server) Service”

Connection Properties

Table 3.1178.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1179.
Name	Description	Required	Internal Name
Modify Wsdl Address	Whether the soap address can be modified.	no	modify-wsdl-address
Wsdl Host	The WSDL, that is a required deployment artifact for an endpoint, has a <soap:address> element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of <soap:address> is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of <soap:address> is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the <soap:address>	no	wsdl-host
Wsdl Port	The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.	no	wsdl-port
Wsdl Secure Port	The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.	no	wsdl-secure-port

Note

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

Operations

none

Package Types

none

3.3.2.4.3.1. JBossAS7 - Endpoint (Managed Server) Service

Overview

Table 3.1180. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.3.1.1, “JBossAS7 - Post Handler Chain (Managed Server) Service”
Section 3.3.2.4.3.1.2, “JBossAS7 - Pre Handler Chain (Managed Server) Service”
Section 3.3.2.4.3.1.3, “JBossAS7 - Property (Read Only) Service”

Connection Properties

Table 3.1181.
Name	Description	Required	Internal 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.3.2.4.3.1.1. JBossAS7 - Post Handler Chain (Managed Server) Service

Overview

Table 3.1182. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.3.1.1.1, “JBossAS7 - Post Handler (Managed Server) Service”

Connection Properties

Table 3.1183.
Name	Description	Required	Internal 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.1184.
Name	Description	Required	Internal Name
Protocol Bindings	Protocol binding	no	protocol-bindings

Note

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

Operations

none

Package Types

none

3.3.2.4.3.1.1.1. JBossAS7 - Post Handler (Managed Server) Service

Overview

Table 3.1185. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1186.
Name	Description	Required	Internal 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.1187.
Name	Description	Required	Internal Name
Class	Handler class	yes	class

Note

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

Operations

none

Package Types

none

3.3.2.4.3.1.2. JBossAS7 - Pre Handler Chain (Managed Server) Service

Overview

Table 3.1188. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.3.1.2.1, “JBossAS7 - Pre Handler (Managed Server) Service”

Connection Properties

Table 3.1189.
Name	Description	Required	Internal 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.1190.
Name	Description	Required	Internal Name
Protocol Bindings	Protocol binding	no	protocol-bindings

Note

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

Operations

none

Package Types

none

3.3.2.4.3.1.2.1. JBossAS7 - Pre Handler (Managed Server) Service

Overview

Table 3.1191. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1192.
Name	Description	Required	Internal 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.1193.
Name	Description	Required	Internal Name
Class	Handler class	yes	class

Note

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

Operations

none

Package Types

none

3.3.2.4.3.1.3. JBossAS7 - Property (Read Only) Service

Overview

Table 3.1194. Overview
Description:	A property
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1195.
Name	Description	Required	Internal 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.1196.
Name	Description	Required	Internal Name
Value	The property value.	no	value

Note

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

Operations

none

Package Types

none

3.3.2.4.4. JBossAS7 - JacORB (Managed Server) Service

Overview

Table 3.1197. Overview
Description:	JacORB subsystem configuration
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1198.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1199.
Name	Description	Required	Internal Name
Add Component Via Interceptor	Indicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is on.	no	add-component-via-interceptor
Cache Poa Names	Indicates whether POA names should be cached (on) or not (off). The default value is off.	no	cache-poa-names
Cache Typecodes	Indicates whether typecodes should be cached (on) or not (off). The default value is off.	no	cache-typecodes
Chunk Custom Rmi Valuetypes	Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on.	no	chunk-custom-rmi-valuetypes
Client Requires	Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None.	no	client-requires
Client Supports	Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth.	no	client-supports
Client Timeout	The client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0.	no	client-timeout
Comet	Indicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off.	no	comet
Export Corbaloc	Indicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is on.	no	export-corbaloc
Giop Minor Version	The GIOP minor version to be used. The default value is 2.	no	giop-minor-version
Indirection Encoding Disable	Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off.	no	indirection-encoding-disable
Iona	Indicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off.	no	iona
Lax Boolean Encoding	Indicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off). The default value is off.	no	lax-boolean-encoding
Max Managed Buf Size	The log2 of maximum size managed by the internal buffer manager. The default value is 24.	no	max-managed-buf-size
Max Server Connections	The maximum number of connections accepted by the server. The default value is 2147483647.	no	max-server-connections
Max Threads	The maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job. The default value is 32.	no	max-threads
Monitoring	Indicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off.	no	monitoring
Name	The name of the running ORB. The default value is JBoss.	no	name
Outbuf Cache Timeout	The buffer cache timeout in milliseconds. The default value is -1.	no	outbuf-cache-timeout
Outbuf Size	The size of the network buffers for outgoing messages. The default value is 2048.	no	outbuf-size
Pool Size	The size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise. The default value is 5.	no	pool-size
Print Version	Indicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off.	no	print-version
Properties	A list of generic key/value properties.	no	properties
Queue Max	The maximum number of requests that can be queued. The default value is 100.	no	queue-max
Queue Min	The size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests. The default value is 10.	no	queue-min
Queue Wait	Indicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full. The default value is off.	no	queue-wait
Retries	The number of retries if connections cannot be promptly established. The default value is 5.	no	retries
Retry Interval	The interval in milliseconds between retries. The default value is 500.	no	retry-interval
Root Context	The naming service root context. The default value is JBoss/Naming/root.	no	root-context
Security	Indicates whether the security interceptors are to be installed (on) or not (off). The default value is off.	no	security
Security Domain	The name of the security domain that holds the key and trust stores that will be used to establish SSL connections.	no	security-domain
Server Requires	Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None.	no	server-requires
Server Supports	Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth.	no	server-supports
Server Timeout	The server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0.	no	server-timeout
Strict Check On Tc Creation	Indicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off). The default value is off.	yes	strict-check-on-tc-creation
Sun	Indicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on.	no	sun
Support Ssl	Indicates whether SSL is to be supported (on) or not (off). The default value is off.	no	support-ssl
Transactions	Indicates 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 off.	no	transactions
Use Bom	Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off.	no	use-bom
Use Imr	Indicates whether the implementation repository should be used (on) or not (off). The default value is off.	no	use-imr

Note

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

Operations

none

Package Types

none

3.3.2.4.5. JBossAS7 - JAXR (Managed Server) Service

Overview

Table 3.1200. Overview
Description:	The configuration of the JAXR subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.5.1, “JBossAS7 - Property (JAXR - Managed Server) Service”

Connection Properties

Table 3.1201.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1202.
Name	Description	Required	Internal Name
Class	The JAXR ConnectionFactory implementation class	no	class
Jndi Name	The JNDI name under which the JAXR ConnectionFactory is bound	no	jndi-name

Note

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

Operations

none

Package Types

none

3.3.2.4.5.1. JBossAS7 - Property (JAXR - Managed Server) Service

Overview

Table 3.1203. Overview
Description:	A JAXR property. The identity of the resource defines the property name.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1204.
Name	Description	Required	Internal 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.1205.
Name	Description	Required	Internal Name
Value	The JAXR property value.	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.6. JBossAS7 - JPA (Managed Server) Service

Overview

Table 3.1206. Overview
Description:	The configuration of the JPA subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1207.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1208.
Name	Description	Required	Internal Name
Default Datasource	The name of the default global datasource.	no	default-datasource

Note

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

Operations

none

Package Types

none

3.3.2.4.7. JBossAS7 - EE (Managed Server) Service

Overview

Table 3.1209. Overview
Description:	The configuration of the EE subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1210.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1211.
Name	Description	Required	Internal Name
Ear Subdeployments Isolated	Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear. The default value is false.	no	ear-subdeployments-isolated
Global Modules	A list of modules that should be made available to all deployments.	no	global-modules

Note

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

Operations

none

Package Types

none

3.3.2.4.8. JBossAS7 - Infinispan (Managed Server) Service

Overview

Table 3.1212. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.8.1, “JBossAS7 - Cache Container (Managed Server) Service”

Connection Properties

Table 3.1213.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

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.3.2.4.8.1. JBossAS7 - Cache Container (Managed Server) Service

Overview

Table 3.1214. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.8.1.1, “JBossAS7 - Cache (Managed Server) Service”
Section 3.3.2.4.8.1.2, “JBossAS7 - Distributed Cache (Managed Server) Service”
Section 3.3.2.4.8.1.3, “JBossAS7 - Local Cache (Managed Server) Service”
Section 3.3.2.4.8.1.4, “JBossAS7 - Transport (Managed Server) Service”

Connection Properties

Table 3.1215.
Name	Description	Required	Internal 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.1216.
Name	Description	Required	Internal Name
Default Cache	The default infinispan cache	no	default-cache
Aliases	The list of aliases for this cache container	no	aliases
Jndi Name	The jndi name to which to bind this cache container	no	jndi-name
Start	The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Listener Executor	The executor used for the replication queue	no	listener-executor
Eviction Executor	The scheduled executor used for eviction	no	eviction-executor
Module	The module whose class loader should be used when building this cache container's configuration. The default value is org.jboss.as.clustering.infinispan.	no	module
Replication Queue Executor	The executor used for asynchronous cache operations	no	replication-queue-executor

Note

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

Operations

none

Package Types

none

3.3.2.4.8.1.1. JBossAS7 - Cache (Managed Server) Service

Overview

Table 3.1217. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1218.
Name	Description	Required	Internal 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.1219.
Name	Description	Required	Internal Name
Start	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Batching	If enabled, the invocation batching API will be made available for this cache.	no	batching
Indexing	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.	no	indexing
Jndi Name	The jndi-name to which to bind this cache instance.	no	jndi-name
Mode	Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.	no	mode
Queue Size	In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.	no	queue-size
Queue Flush Interval	In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.	no	queue-flush-interval
Remote Timeout	In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.	no	remote-timeout
Async Marshalling	If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false.	no	async-marshalling
Module	The module whose class loader should be used when building this cache's configuration.	no	module
Type of cache	Type of cache	yes	__type

Note

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

Operations

none

Package Types

none

3.3.2.4.8.1.2. JBossAS7 - Distributed Cache (Managed Server) Service

Overview

Table 3.1220. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1221.
Name	Description	Required	Internal 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.1222.
Name	Description	Required	Internal Name
Start	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Batching	If enabled, the invocation batching API will be made available for this cache.	no	batching
Indexing	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.	no	indexing
Jndi Name	The jndi-name to which to bind this cache instance.	no	jndi-name
Mode	Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.	no	mode
Queue Size	In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.	no	queue-size
Queue Flush Interval	In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.	no	queue-flush-interval
Remote Timeout	In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.	no	remote-timeout
Async Marshalling	If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false.	no	async-marshalling
L 1 Lifespan	Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored. The default value is 600000.	no	l1-lifespan
Module	The module whose class loader should be used when building this cache's configuration.	no	module
Owners	Number of cluster-wide replicas for each cache entry. The default value is 2.	no	owners
Virtual Nodes	Controls the number of virtual nodes per 'real' node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used. The default value is 1.	no	virtual-nodes

Note

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

Operations

none

Package Types

none

3.3.2.4.8.1.3. JBossAS7 - Local Cache (Managed Server) Service

Overview

Table 3.1223. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1224.
Name	Description	Required	Internal 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.1225.
Name	Description	Required	Internal Name
Start	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).	no	start
Batching	If enabled, the invocation batching API will be made available for this cache.	no	batching
Indexing	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.	no	indexing
Jndi Name	The jndi-name to which to bind this cache instance.	no	jndi-name
Module	The module whose class loader should be used when building this cache's configuration.	no	module

Note

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

Operations

none

Package Types

none

3.3.2.4.8.1.4. JBossAS7 - Transport (Managed Server) Service

Overview

Table 3.1226. Overview
Description:	The description of the transport used by this cache container
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1227.
Name	Description	Required	Internal 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.1228.
Name	Description	Required	Internal Name
Cluster	The name of the group communication cluster	no	cluster
Executor	The executor to use for the transport	no	executor
Lock Timeout	The timeout for locks for the transport. The default value is 240000.	no	lock-timeout
Stack	The jgroups stack to use for the transport	no	stack

Note

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

Operations

none

Package Types

none

3.3.2.4.9. JBossAS7 - JGroups (Managed Server) Service

Overview

Table 3.1229. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1230.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1231.
Name	Description	Required	Internal Name
Default Stack	Default stack to use	yes	default-stack

Note

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

Operations

none

Package Types

none

3.3.2.4.10. JBossAS7 - Remoting (Managed Server) Service

Overview

Table 3.1232. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1233.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1234.
Name	Description	Required	Internal Name
Worker Read Threads	The number of read threads to create for the remoting worker. The default value is 1.	no	worker-read-threads
Worker Task Core Threads	The number of core threads for the remoting worker task thread pool. The default value is 4.	no	worker-task-core-threads
Worker Task Keepalive	The number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60.	no	worker-task-keepalive
Worker Task Limit	The maximum number of remoting worker tasks to allow before rejecting. The default value is 16384.	no	worker-task-limit
Worker Task Max Threads	The maximum number of threads for the remoting worker task thread pool. The default value is 16.	no	worker-task-max-threads
Worker Write Threads	The number of write threads to create for the remoting worker. The default value is 1.	no	worker-write-threads

Note

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

Operations

none

Package Types

none

3.3.2.4.11. JBossAS7 - Mail (Managed Server) Service

Overview

Table 3.1235. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.11.1, “JBossAS7 - Mail Session (Managed Server) Service”

Connection Properties

Table 3.1236.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

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.3.2.4.11.1. JBossAS7 - Mail Session (Managed Server) Service

Overview

Table 3.1237. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.11.1.1, “JBossAS7 - SMTP Mail Server (Managed Server) Service”
Section 3.3.2.4.11.1.2, “JBossAS7 - IMAP Mail Server (Managed Server) Service”
Section 3.3.2.4.11.1.3, “JBossAS7 - POP3 Mail Server (Managed Server) Service”

Connection Properties

Table 3.1238.
Name	Description	Required	Internal 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.1239.
Name	Description	Required	Internal Name
Debug	Enables javamail debugging. The default value is false.	no	debug
From	From address that is used as default from, if not set when sending	no	from
Jndi Name	JNDI name to where mail session should be bound	no	jndi-name

Note

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

Operations

none

Package Types

none

3.3.2.4.11.1.1. JBossAS7 - SMTP Mail Server (Managed Server) Service

Overview

Table 3.1240. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1241.
Name	Description	Required	Internal 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.1242.
Name	Description	Required	Internal Name
Outbound Socket Binding Ref	Outbound Socket binding to SMTP server	no	outbound-socket-binding-ref
Password	Password to authenticate on server	no	password
Ssl	Does server requires SSL?. The default value is false.	no	ssl
Username	Username to authenticate on server	no	username

Note

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

Operations

none

Package Types

none

3.3.2.4.11.1.2. JBossAS7 - IMAP Mail Server (Managed Server) Service

Overview

Table 3.1243. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1244.
Name	Description	Required	Internal 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.1245.
Name	Description	Required	Internal Name
Outbound Socket Binding Ref	Outbound Socket binding to IMAP server	no	outbound-socket-binding-ref
Password	Password to authenticate on server	no	password
Ssl	Does server requires SSL?. The default value is false.	no	ssl
Username	Username to authenticate on server	no	username

Note

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

Operations

none

Package Types

none

3.3.2.4.11.1.3. JBossAS7 - POP3 Mail Server (Managed Server) Service

Overview

Table 3.1246. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1247.
Name	Description	Required	Internal 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.1248.
Name	Description	Required	Internal Name
Outbound Socket Binding Ref	Outbound Socket binding to POP3 server	no	outbound-socket-binding-ref
Password	Password to authenticate on server	no	password
Ssl	Does server requires SSL?. The default value is false.	no	ssl
Username	Username to authenticate on server	no	username

Note

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

Operations

none

Package Types

none

3.3.2.4.12. JBossAS7 - JBossWeb (Managed Server) Service

Overview

Table 3.1249. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.12.1, “JBossAS7 - Connector (Managed Server) Service”
Section 3.3.2.4.12.2, “JBossAS7 - VHost (Managed Server) Service”

Connection Properties

Table 3.1250.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1251.
Name	Description	Required	Internal Name
Disabled: 0	Enable the default Servlet mapping. The default value is false.	no	disabled:0
File Encoding	Force a file encoding.	no	file-encoding
Listings	Enable folder listings. The default value is false.	no	listings
Max Depth	Maximum recursion for PROPFIND. The default value is 3.	no	max-depth
Read Only	Allow write HTTP methods (PUT, DELETE). The default value is true.	no	read-only
Sendfile	Enable sendfile if possible, for files bigger than the specified byte size. The default value is 49152.	no	sendfile
Secret	Secret for WebDAV locking operations.	no	secret
Webdav	Enable WebDAV functionality. The default value is false.	no	webdav
Check Interval	Check interval for JSP updates using a background thread. The default value is 0.	no	check-interval
Development	Enable the development mode, which gives more information when an error occurs. The default value is false.	no	development
Disabled: 1	Enable the JSP container. The default value is false.	no	disabled:1
Display Source Fragment	When a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true.	no	display-source-fragment
Dump Smap	Write SMAP data to a file. The default value is false.	no	dump-smap
Error On Use Bean Invalid Class Attribute	Enable errors when using a bad class in useBean. The default value is false.	no	error-on-use-bean-invalid-class-attribute
Generate Strings As Char Arrays	Generate String constants as char arrays. The default value is false.	no	generate-strings-as-char-arrays
Java Encoding	Specify the encoding used for Java sources. The default value is UTF8.	no	java-encoding
Keep Generated	Keep the generated Servlets. The default value is true.	no	keep-generated
Mapped File	Map to the JSP source. The default value is true.	no	mapped-file
Modification Test Interval	Minimum amount of time between two tests for updates, in seconds. The default value is 4.	no	modification-test-interval
Recompile On Fail	Retry failed JSP compilations on each request. The default value is false.	no	recompile-on-fail
Scratch Dir	Specify a different work directory.	no	scratch-dir
Smap	Enable SMAP. The default value is true.	no	smap
Source Vm	Source VM level for compilation. The default value is 1.5.	no	source-vm
Tag Pooling	Enable tag pooling. The default value is true.	no	tag-pooling
Target Vm	Target VM level for compilation. The default value is 1.5.	no	target-vm
Trim Spaces	Trim some spaces from the generated Servlet. The default value is false.	no	trim-spaces
X Powered By	Enable advertising the JSP engine in x-powered-by. The default value is true.	no	x-powered-by
Welcome File	A welcome file declaration.	no	welcome-file
Default Virtual Server	The web container's default virtual server. The default value is default-host.	yes	default-virtual-server
Instance Id	The identifier for this server instance.	no	instance-id
Native	Add the native initialization listener to the web container. The default value is true.	no	native

Note

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

Operations

none

Package Types

none

3.3.2.4.12.1. JBossAS7 - Connector (Managed Server) Service

Overview

Table 3.1252. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1253.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1254. Metrics
Name	Type	Description	Internal Name
Bytes Sent	measurement	Number of byte sent by the connector.	bytesSent
Bytes Sent per Minute	measurement	Number of byte sent by the connector.	bytesSent
Bytes Received	measurement	Number of byte received by the connector (POST data).	bytesReceived
Bytes Received per Minute	measurement	Number of byte received by the connector (POST data).	bytesReceived
Processing Time	measurement	Processing time used by the connector. Im milli-seconds.	processingTime
Processing Time per Minute	measurement	Processing time used by the connector. Im milli-seconds.	processingTime
Error Count	measurement	Number of error that occurs when processing requests by the connector.	errorCount
Error Count per Minute	measurement	Number of error that occurs when processing requests by the connector.	errorCount
Max Time	measurement	Max time spent to process a requests.	maxTime
Request Count	measurement	Number of the request processed by the connector.	requestCount
Request Count per Minute	measurement	Number of the request processed by the connector.	requestCount
Max connections	measurement	Number of max connections this connector can handle (see configuration to set it)	_expr:max-connections

Note

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

Configuration Properties

Table 3.1255.
Name	Description	Required	Internal Name
Configuration		no	*Configuration+
Scheme	The web connector scheme.	yes	scheme
Socket Binding	The web connector socket-binding reference, this connector should be bound to.	no	socket-binding
Enabled	Defines whether the connector should be started on startup. The default value is true.	no	enabled
Enable Lookups	Enable DNS lookups for Servlet API. The default value is false.	no	enable-lookups
Executor	The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool.	no	executor
Max connections	Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used.	no	max-connections:expr
Max Post Size	Maximum size in bytes of a POST request that can be parsed by the container. The default value is 2097152.	no	max-post-size
Max Save Post Size	Maximum size in bytes of a POST request that will be saved during certain authentication schemes. The default value is 4096.	no	max-save-post-size
Name	A unique name for the connector.	no	name
Protocol	The web connector protocol. (e.g. 'HTTP/1.1' or 'AJP' or a name of a class implementing ProtocolHandler and MBeanRegistration )	yes	protocol
Proxy Name	The host name that will be used when sending a redirect. The default value is null.	no	proxy-name
Proxy Port	The port that will be used when sending a redirect.	no	proxy-port
Redirect Port	The port for redirection to a secure connector. The default value is 8433.	no	redirect-port:expr
Secure	Indicates if content sent or received by the connector is secured from the user perspective. The default value is false.	no	secure
Virtual Server	The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers.	no	virtual-server

Note

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

Operations

none

Package Types

none

3.3.2.4.12.2. JBossAS7 - VHost (Managed Server) Service

Overview

Table 3.1256. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.12.2.1, “JBossAS7 - Rewrite Rules (Managed Server) Service”
Section 3.3.2.4.12.2.2, “JBossAS7 - Access Log (Managed Server) Service”

Connection Properties

Table 3.1257.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1258. Metrics
Name	Type	Description	Internal Name
_aliases	trait	Aliases for this virtual host	_aliases

Note

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

Configuration Properties

Table 3.1259.
Name	Description	Required	Internal Name
Configuration		no	*Configuration+
Virtual server aliases	The virtual server aliases	yes	alias
Default Web Module	The web module deployment name that will be mapped as the root webapp.	yes	default-web-module
Enable Welcome Root	Whether or not the bundled welcome directory is used as the root web context. The default value is false.	yes	enable-welcome-root
Name	A unique virtual host name	no	name

Note

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

Operations

none

Package Types

none

3.3.2.4.12.2.1. JBossAS7 - Rewrite Rules (Managed Server) Service

Overview

Table 3.1260. Overview
Description:	A list of rewrite rules that will be processed in order on the URL or vhost specified in the request. Those follow the rules for mod_rewrite. Please consult the manual for help on settings
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1261.
Name	Description	Required	Internal 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.1262.
Name	Description	Required	Internal Name
Conditions		no	*1
Flags	Option flags for this rewrite rule. Consult the mod_rewrite docs.	yes	flags
Pattern	The pattern that will be matched. Consult the mod_rewrite docs.	yes	pattern
Substitution	The string that will replace the original URL or vhost. Consult the mod_rewrite docs.	yes	substitution

Note

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

Operations

none

Package Types

none

3.3.2.4.12.2.2. JBossAS7 - Access Log (Managed Server) Service

Overview

Table 3.1263. Overview
Description:	The access log configuration for this virtual server.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1264.
Name	Description	Required	Internal 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.1265.
Name	Description	Required	Internal Name
Path	The relative folder path.	no	path
Relative To	The folder the path is relative to. The default value is jboss.server.log.dir.	no	relative-to
Extended	Enable extended pattern, with more options. The default value is false.	no	extended
Pattern	The access log pattern. The default value is common.	no	pattern
Prefix	Prefix for the log file name. The default value is false.	no	prefix
Resolve Hosts	Host resolution. The default value is false.	no	resolve-hosts
Rotate	Rotate the access log every day. The default value is true.	no	rotate

Note

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

Operations

none

Package Types

none

3.3.2.4.13. JBossAS7 - JCA (Managed Server) Service

Overview

Table 3.1266. Overview
Description:	The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.13.1, “JBossAS7 - BootstrapContext (Managed Server) Service”
Section 3.3.2.4.13.2, “JBossAS7 - Workmanager (Managed Server) Service”

Connection Properties

Table 3.1267.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1268.
Name	Description	Required	Internal Name
Enabled	Specify whether bean validation is enabled. The default value is true.	no	enabled:1
Enabled	Specify whether archive validation is enabled. The default value is true.	no	enabled:2
Fail On Error	Should an archive validation error report fail the deployment. The default value is true.	no	fail-on-error
Fail On Warn	Should an archive validation warning report fail the deployment. The default value is false.	no	fail-on-warn
Debug	Enable/disable debug information logging. The default value is false.	no	debug
Error	Enable/disable error information logging. The default value is false.	no	error
Install	Enable/disable the cached connection manager valve and interceptor. The default value is false.	no	install

Note

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

Operations

none

Package Types

none

3.3.2.4.13.1. JBossAS7 - BootstrapContext (Managed Server) Service

Overview

Table 3.1269. Overview
Description:	Bootstrap context for resource adapters.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1270.
Name	Description	Required	Internal 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.1271.
Name	Description	Required	Internal Name
Name	The name of the BootstrapContext	no	name
Workmanager	The WorkManager instance for the BootstrapContext	no	workmanager

Note

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

Operations

none

Package Types

none

3.3.2.4.13.2. JBossAS7 - Workmanager (Managed Server) Service

Overview

Table 3.1272. Overview
Description:	WorkManager for resource adapters.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.13.2.1, “JBossAS7 - Long Running Thread Pool (Managed Server) Service”
Section 3.3.2.4.13.2.2, “JBossAS7 - Short Running Thread Pool (Managed Server) Service”

Connection Properties

Table 3.1273.
Name	Description	Required	Internal 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.1274.
Name	Description	Required	Internal Name
Name	The name of the WorkManager	no	name

Note

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

Operations

none

Package Types

none

3.3.2.4.13.2.1. JBossAS7 - Long Running Thread Pool (Managed Server) Service

Overview

Table 3.1275. Overview
Description:	Long running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1276.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1277. Metrics
Name	Type	Description	Internal Name
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.	rejected-count

Note

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

Configuration Properties

Table 3.1278.
Name	Description	Required	Internal Name
Allow Core Timeout	Whether core threads may time out. The default value is false.	no	allow-core-timeout
Core Threads	The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.	no	core-threads:expr
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	yes	max-threads:expr
Name	The name of the thread pool.	no	name
Queue Length	The queue length.	yes	queue-length:expr
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory

Note

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

Operations

none

Package Types

none

3.3.2.4.13.2.2. JBossAS7 - Short Running Thread Pool (Managed Server) Service

Overview

Table 3.1279. Overview
Description:	Short running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1280.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1281. Metrics
Name	Type	Description	Internal Name
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.	rejected-count

Note

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

Configuration Properties

Table 3.1282.
Name	Description	Required	Internal Name
Allow Core Timeout	Whether core threads may time out. The default value is false.	no	allow-core-timeout
Core Threads	The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.	no	core-threads:expr
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	yes	max-threads:expr
Name	The name of the thread pool.	no	name
Queue Length	The queue length.	yes	queue-length:expr
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory

Note

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

Operations

none

Package Types

none

3.3.2.4.14. JBossAS7 - Osgi (Managed Server) Service

Overview

Table 3.1283. Overview
Description:	The OSGi subsystem configuration.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.14.1, “JBossAS7 - Capability (Managed Server) Service”
Section 3.3.2.4.14.2, “JBossAS7 - Bundle (Managed Server) Service”
Section 3.3.2.4.14.3, “JBossAS7 - Property (Read Only) Service”

Connection Properties

Table 3.1284.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1285.
Name	Description	Required	Internal Name
Activation	Activation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY.	no	activation
Startlevel	The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly.	no	startlevel

Note

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

Operations

Table 3.1286. Metrics
Name	Description
Activate	Activate the OSGi subsystem.

Package Types

none

3.3.2.4.14.1. JBossAS7 - Capability (Managed Server) Service

Overview

Table 3.1287. Overview
Description:	A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1288.
Name	Description	Required	Internal 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.1289.
Name	Description	Required	Internal Name
Startlevel	The startlevel for the capability. Can only be specified for OSGi bundles.	no	startlevel

Note

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

Operations

none

Package Types

none

3.3.2.4.14.2. JBossAS7 - Bundle (Managed Server) Service

Overview

Table 3.1290. Overview
Description:	Runtime bundle information.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1291.
Name	Description	Required	Internal 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.1292.
Name	Description	Required	Internal Name
Id	The bundle ID.	no	id
Startlevel	The bundle's start level.	no	startlevel
Symbolic Name	The bundle symbolic name.	no	symbolic-name
Version	The bundle version.	no	version

Note

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

Operations

Table 3.1293. Metrics
Name	Description
Start	Starts the bundle.
Stop	Stops the bundle.

Package Types

none

3.3.2.4.14.3. JBossAS7 - Property (Read Only) Service

Overview

Table 3.1294. Overview
Description:	A property
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1295.
Name	Description	Required	Internal 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.1296.
Name	Description	Required	Internal Name
Value	The property value.	no	value

Note

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

Operations

none

Package Types

none

3.3.2.4.15. JBossAS7 - JMX (Managed Server) Service

Overview

Table 3.1297. Overview
Description:	The configuration of the JMX subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.15.1, “JBossAS7 - Remoting Connector (Managed Server) Service”

Connection Properties

Table 3.1298.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1299.
Name	Description	Required	Internal Name
Show Model	Set to 'true' to include MBeans for the model controller resources	no	show-model

Note

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

Operations

none

Package Types

none

3.3.2.4.15.1. JBossAS7 - Remoting Connector (Managed Server) Service

Overview

Table 3.1300. Overview
Description:	The configuration of a resource adapter.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1301.
Name	Description	Required	Internal 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.1302.
Name	Description	Required	Internal Name
Use Management Endpoint	If true the connector will use the management endpoint, otherwise it will use the remoting subsystem one. The default value is true.	no	use-management-endpoint

Note

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

Operations

none

Package Types

none

3.3.2.4.16. JBossAS7 - Resource Adapters (Managed Server) Service

Overview

Table 3.1303. Overview
Description:	Configuration of the resource adapters subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.16.1, “JBossAS7 - Resource Adapter (Managed Server) Service”

Connection Properties

Table 3.1304.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

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.3.2.4.16.1. JBossAS7 - Resource Adapter (Managed Server) Service

Overview

Table 3.1305. Overview
Description:	The configuration of a resource adapter.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.16.1.1, “JBossAS7 - Admin Objects (Managed Server) Service”
Section 3.3.2.4.16.1.2, “JBossAS7 - Connection Definitions (Managed Server) Service”
Section 3.3.2.4.16.1.3, “JBossAS7 - Config Properties (Read Only) Service”

Connection Properties

Table 3.1306.
Name	Description	Required	Internal 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.1307.
Name	Description	Required	Internal Name
Archive	Specifies the resource adapter archive	yes	archive
Beanvalidationgroups	Specifies the bean validation groups that should be used	no	beanvalidationgroups
Bootstrapcontext	Specifies the unique name of the bootstrap context that should be used	no	bootstrapcontext
Transaction Support	Specifies the transaction support level of the resource adapter	yes	transaction-support

Note

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

Operations

none

Package Types

none

3.3.2.4.16.1.1. JBossAS7 - Admin Objects (Managed Server) Service

Overview

Table 3.1308. Overview
Description:	Specifies the administration objects.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1309.
Name	Description	Required	Internal 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.1310.
Name	Description	Required	Internal Name
Class Name	Specifies the fully qualified class name of a managed connection factory or admin object	yes	class-name
Enabled	Specifies if the resource adapter should be enabled. The default value is true.	no	enabled
Jndi Name	Specifies the JNDI name for the connection factory or admin object	no	jndi-name
Use Java Context	Setting this to false will bind the object into global JNDI. The default value is true.	no	use-java-context

Note

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

Operations

none

Package Types

none

3.3.2.4.16.1.2. JBossAS7 - Connection Definitions (Managed Server) Service

Overview

Table 3.1311. Overview
Description:	Specifies the connection definitions.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.16.1.2.1, “JBossAS7 - Config Properties (Read Only) Service”

Connection Properties

Table 3.1312.
Name	Description	Required	Internal 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.1313.
Name	Description	Required	Internal Name
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception	no	allocation-retry:expr
Allocation Retry Wait Millis	The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection	no	allocation-retry-wait-millis:expr
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart. The default value is false.	no	background-validation
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart	no	background-validation-millis:expr
Blocking Timeout Wait Millis	The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time	no	blocking-timeout-wait-millis:expr
Class Name	Specifies the fully qualified class name of a managed connection factory or admin object	yes	class-name
Enabled	Specifies if the resource adapter should be enabled. The default value is true.	no	enabled
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Idle Timeout Minutes	The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart.	no	idle-timeout-minutes:expr
Interleaving	An element to enable interleaving for XA connections. The default value is false.	no	interleaving
Jndi Name	Specifies the JNDI name for the connection factory or admin object	no	jndi-name
Max Pool Size	The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20.	no	max-pool-size
Min Pool Size	The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0.	no	min-pool-size
No Recovery	Specifies if the connection pool should be excluded from recovery	no	no-recovery
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false.	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded. The default value is false.	no	pad-xid
Pool Prefill	Should the pool be prefilled. Changing this value requires a server restart. The default value is false.	no	pool-prefill
Pool Use Strict Min	Specifies if the min-pool-size should be considered strictly. The default value is false.	no	pool-use-strict-min
Recovery Password	The password used for recovery	no	recovery-password
Recovery Plugin Class Name	The fully qualified class name of the recovery plugin implementation	no	recovery-plugin-class-name
Recovery Plugin Properties	The properties for the recovery plugin	no	recovery-plugin-properties
Recovery Security Domain	The security domain used for recovery	no	recovery-security-domain
Recovery Username	The user name used for recovery	no	recovery-username
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Security Application	Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool	no	security-application
Security Domain	Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool	no	security-domain
Security Domain and Application	Indicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool	no	security-domain-and-application
Use Ccm	Enable the use of a cached connection manager. The default value is true.	no	use-ccm
Use Fast Fail	Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false.	no	use-fast-fail
Use Java Context	Setting this to false will bind the object into global JNDI. The default value is true.	no	use-java-context
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock:expr
Wrap Xa Resource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true.	no	wrap-xa-resource
XA Resource Timeout	The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero	no	xa-resource-timeout:expr

Note

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

Operations

Table 3.1314. Metrics
Name	Description
Flush All Connections in Pool	Flushes all connections in the pool
Flush Idle Connections in Pool	Flushes all idle connections in the pool
Test Connection in Pool	Test if a connection can be obtained

Package Types

none

3.3.2.4.16.1.2.1. JBossAS7 - Config Properties (Read Only) Service

Overview

Table 3.1315. Overview
Description:	Custom defined config properties.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1316.
Name	Description	Required	Internal 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.1317.
Name	Description	Required	Internal Name
Value	Custom defined config property value	no	value

Note

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

Operations

none

Package Types

none

3.3.2.4.16.1.3. JBossAS7 - Config Properties (Read Only) Service

Overview

Table 3.1318. Overview
Description:	Custom defined config properties.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1319.
Name	Description	Required	Internal 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.1320.
Name	Description	Required	Internal Name
Value	Custom defined config property value	no	value

Note

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

Operations

none

Package Types

none

3.3.2.4.17. JBossAS7 - CMP (Managed Server) Service

Overview

Table 3.1321. Overview
Description:	The configuration of the cmp subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.17.1, “JBossAS7 - HiloKeygenerator (Managed Server) Service”

Connection Properties

Table 3.1322.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

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.3.2.4.17.1. JBossAS7 - HiloKeygenerator (Managed Server) Service

Overview

Table 3.1323. Overview
Description:	HiLo based key generators.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1324.
Name	Description	Required	Internal 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.1325.
Name	Description	Required	Internal Name
Block Size	The block size	no	block-size
Create Table	Boolean to determine whether to create create the tables	no	create-table
Create Table Ddl	The DDL used to create the table	no	create-table-ddl
Data Source	The datasource used for sequence generation	yes	data-source
Drop Table	Boolean to determine whether to create drop the tables	no	drop-table
Id Column	The ID column name	yes	id-column
Select Hi Ddl	The DDL used to select the hi value	no	select-hi-ddl
Sequence Column	The sequence column name	yes	sequence-column
Sequence Name	The name of the sequence	yes	sequence-name
Table Name	The table name	yes	table-name

Note

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

Operations

none

Package Types

none

3.3.2.4.18. JBossAS7 - EJB3 (Managed Server) Service

Overview

Table 3.1326. Overview
Description:	The configuration of the ejb3 subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.18.1, “JBossAS7 - EJB3 Thread Pool (Managed Server) Service”
Section 3.3.2.4.18.2, “JBossAS7 - File Passivation Store (Managed Server) Service”
Section 3.3.2.4.18.3, “JBossAS7 - Strict Max Bean Instance Pool (Managed Server) Service”
Section 3.3.2.4.18.4, “JBossAS7 - SFSB Cache (Managed Server) Service”
Section 3.3.2.4.18.5, “JBossAS7 - Cluster Passivation Store (Managed Server) Service”
Section 3.3.2.4.18.6, “JBossAS7 - Async Service (Managed Server) Service”
Section 3.3.2.4.18.7, “JBossAS7 - IIOP Service (Managed Server) Service”
Section 3.3.2.4.18.8, “JBossAS7 - Remote Service (Managed Server) Service”
Section 3.3.2.4.18.9, “JBossAS7 - Timer Service (Managed Server) Service”

Connection Properties

Table 3.1327.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1328.
Name	Description	Required	Internal Name
Default Clustered Sfsb Cache	Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level	no	default-clustered-sfsb-cache
Default Entity Bean Instance Pool	Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level	no	default-entity-bean-instance-pool
Default Entity Bean Optimistic Locking	If set to true entity beans will use optimistic locking by default	no	default-entity-bean-optimistic-locking
Default Mdb Instance Pool	Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level	no	default-mdb-instance-pool
Default Resource Adapter Name	Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is hornetq-ra.	no	default-resource-adapter-name
Default Sfsb Cache	Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level	no	default-sfsb-cache
Default Singleton Bean Access Timeout	The default access timeout for singleton beans. The default value is 5000.	no	default-singleton-bean-access-timeout:expr
Default Slsb Instance Pool	Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level	no	default-slsb-instance-pool
Default Stateful Bean Access Timeout	The default access timeout for stateful beans. The default value is 5000.	no	default-stateful-bean-access-timeout:expr
In Vm Remote Interface Invocation Pass By Value	If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value. The default value is true.	no	in-vm-remote-interface-invocation-pass-by-value
Enable Statistics	If set to true, enable the collection of invocation statistics.	no	enable-statistics

Note

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

Operations

none

Package Types

none

3.3.2.4.18.1. JBossAS7 - EJB3 Thread Pool (Managed Server) Service

Overview

Table 3.1329. Overview
Description:	A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1330.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1331. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The approximate number of threads that are actively executing tasks.	active-count
Completed Task Count	measurement	The approximate total number of tasks that have completed execution.	completed-task-count
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been rejected.	rejected-count
Task Count	measurement	The approximate total number of tasks that have ever been scheduled for execution.	task-count

Note

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

Configuration Properties

Table 3.1332.
Name	Description	Required	Internal Name
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	no	max-threads:expr
Name	The name of the thread pool.	no	name
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory

Note

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

Operations

none

Package Types

none

3.3.2.4.18.2. JBossAS7 - File Passivation Store (Managed Server) Service

Overview

Table 3.1333. Overview
Description:	A file system based passivation store.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1334.
Name	Description	Required	Internal 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.1335.
Name	Description	Required	Internal Name
Groups Path		no	groups-path
Idle Timeout	The timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300.	no	idle-timeout:expr
Idle Timeout Unit	The unit of idle-timeout. The default value is SECONDS.	no	idle-timeout-unit
Max Size	The maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000.	no	max-size:expr
Relative To		no	relative-to
Sessions Path		no	sessions-path
Subdirectory Count		no	subdirectory-count:expr

Note

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

Operations

none

Package Types

none

3.3.2.4.18.3. JBossAS7 - Strict Max Bean Instance Pool (Managed Server) Service

Overview

Table 3.1336. Overview
Description:	A bean instance pool with a strict upper limit
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1337.
Name	Description	Required	Internal 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.1338.
Name	Description	Required	Internal Name
Max Pool Size	The maximum number of bean instances that the pool can hold at a given point in time. The default value is 20.	no	max-pool-size:expr
Timeout	The maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5.	no	timeout:expr
Timeout Unit	The instance acquisition timeout unit. The default value is MINUTES.	no	timeout-unit

Note

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

Operations

none

Package Types

none

3.3.2.4.18.4. JBossAS7 - SFSB Cache (Managed Server) Service

Overview

Table 3.1339. Overview
Description:	A SFSB cache.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1340.
Name	Description	Required	Internal 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.1341.
Name	Description	Required	Internal Name
Aliases	The aliases by which this cache may also be referenced	yes	aliases
Passivation Store	The passivation store used by this cache	no	passivation-store

Note

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

Operations

none

Package Types

none

3.3.2.4.18.5. JBossAS7 - Cluster Passivation Store (Managed Server) Service

Overview

Table 3.1342. Overview
Description:	A clustered passivation store.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1343.
Name	Description	Required	Internal 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.1344.
Name	Description	Required	Internal Name
Bean Cache	The name of the cache used to store bean instances.	no	bean-cache
Cache Container	The name of the cache container used for the bean and client-mappings caches. The default value is ejb.	no	cache-container
Client Mappings Cache	The name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings. The default value is remote-connector-client-mappings.	no	client-mappings-cache
Idle Timeout	The timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300.	no	idle-timeout:expr
Idle Timeout Unit	The unit of idle-timeout. The default value is SECONDS.	no	idle-timeout-unit
Max Size	The maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000.	no	max-size:expr
Passivate Events On Replicate	Indicates whether replication should trigger passivation events on the bean. The default value is true.	no	passivate-events-on-replicate

Note

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

Operations

none

Package Types

none

3.3.2.4.18.6. JBossAS7 - Async Service (Managed Server) Service

Overview

Table 3.1345. Overview
Description:	The EJB3 Asynchronous Invocation Service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1346.
Name	Description	Required	Internal 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.1347.
Name	Description	Required	Internal Name
Thread Pool Name	The name of the thread pool which handles asynchronous invocations	no	thread-pool-name

Note

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

Operations

none

Package Types

none

3.3.2.4.18.7. JBossAS7 - IIOP Service (Managed Server) Service

Overview

Table 3.1348. Overview
Description:	The IIOP service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1349.
Name	Description	Required	Internal 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.1350.
Name	Description	Required	Internal Name
Enable By Default	If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor	no	enable-by-default
Use Qualified Name	If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb)	no	use-qualified-name

Note

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

Operations

none

Package Types

none

3.3.2.4.18.8. JBossAS7 - Remote Service (Managed Server) Service

Overview

Table 3.1351. Overview
Description:	The EJB3 remote service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.18.8.1, “JBossAS7 - Channel Creation Options (Managed Server) Service”

Connection Properties

Table 3.1352.
Name	Description	Required	Internal 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.1353.
Name	Description	Required	Internal Name
Connector Ref	The name of the connector on which the EJB3 remoting channel is registered	no	connector-ref
Thread Pool Name	The name of the thread pool that handles remote invocations	no	thread-pool-name

Note

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

Operations

none

Package Types

none

3.3.2.4.18.8.1. JBossAS7 - Channel Creation Options (Managed Server) Service

Overview

Table 3.1354. Overview
Description:	The options that will be used during the EJB remote channel creation
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1355.
Name	Description	Required	Internal 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.1356.
Name	Description	Required	Internal Name
Type	The type of the channel creation option	no	type
Value	The value for the EJB remote channel creation option	no	value

Note

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

Operations

none

Package Types

none

3.3.2.4.18.9. JBossAS7 - Timer Service (Managed Server) Service

Overview

Table 3.1357. Overview
Description:	The EJB timer service
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1358.
Name	Description	Required	Internal 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.1359.
Name	Description	Required	Internal Name
Path	The directory to store persistent timer information in	no	path
Relative To	The relative path that is used to resolve the timer data store location	no	relative-to
Thread Pool Name	The name of the thread pool used to run timer service invocations	no	thread-pool-name

Note

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

Operations

none

Package Types

none

3.3.2.4.19. JBossAS7 - Threads (Managed Server) Service

Overview

Table 3.1360. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.19.1, “JBossAS7 - ThreadFactory (Managed Server) Service”
Section 3.3.2.4.19.2, “JBossAS7 - ThreadPool (Managed Server) Service”

Connection Properties

Table 3.1361.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

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.3.2.4.19.1. JBossAS7 - ThreadFactory (Managed Server) Service

Overview

Table 3.1362. Overview
Description:	A thread factory (implementing java.util.concurrent.ThreadFactory).
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1363.
Name	Description	Required	Internal 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.1364.
Name	Description	Required	Internal Name
Group Name	Specifies the name of a thread group to create for this thread factory.	no	group-name
Name	The name of the created thread factory.	no	name
Priority	May be used to specify the thread priority of created threads. The default value is -1.	no	priority:expr
Thread Name Pattern	The template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID.	no	thread-name-pattern

Note

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

Operations

none

Package Types

none

3.3.2.4.19.2. JBossAS7 - ThreadPool (Managed Server) Service

Overview

Table 3.1365. Overview
Description:	A thread pool executor
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1366.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1367. Metrics
Name	Type	Description	Internal Name
Active Count	measurement	The approximate number of threads that are actively executing tasks.	active-count
Completed Task Count	measurement	The approximate total number of tasks that have completed execution.	completed-task-count
Current Thread Count	measurement	The current number of threads in the pool.	current-thread-count
Largest Thread Count	measurement	The largest number of threads that have ever simultaneously been in the pool.	largest-thread-count
Rejected Count	measurement	The number of tasks that have been rejected.	rejected-count
Task Count	measurement	The approximate total number of tasks that have ever been scheduled for execution.	task-count

Note

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

Configuration Properties

Table 3.1368.
Name	Description	Required	Internal Name
Keepalive Time	Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.	no	keepalive-time
Max Threads	The maximum thread pool size.	yes	max-threads:expr
Name	The name of the thread pool.	no	name
Queue Length	The queue length. Required only for Bounded and Blocking Bounded Thread Pools.	no	queue-length:expr
Thread Factory	Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.	no	thread-factory
Allow Core Timeout	Whether core threads may time out. The default value is false.	no	allow-core-timeout
Core Threads	The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.	no	core-threads:expr
Handoff Executor	An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.	no	handoff-executor
Thread Pool Type	Thread pool type	yes	__type

Note

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

Operations

none

Package Types

none

3.3.2.4.20. JBossAS7 - Security (Managed Server) Service

Overview

Table 3.1369. Overview
Description:	The configuration of the security subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1, “JBossAS7 - Security Domain (Managed Server) Service”
Section 3.3.2.4.20.2, “JBossAS7 - Vault (Managed Server) Service”

Connection Properties

Table 3.1370.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1371.
Name	Description	Required	Internal Name
Deep Copy Subject Mode	Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads. The default value is false.	no	deep-copy-subject-mode

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1. JBossAS7 - Security Domain (Managed Server) Service

Overview

Table 3.1372. Overview
Description:	Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.1, “JBossAS7 - ACL (Managed Server) Service”
Section 3.3.2.4.20.1.2, “JBossAS7 - Audit (Managed Server) Service”
Section 3.3.2.4.20.1.3, “JBossAS7 - Authentication (Classic - Managed Server) Service”
Section 3.3.2.4.20.1.4, “JBossAS7 - Authentication (Jaspi - Managed Server) Service”
Section 3.3.2.4.20.1.5, “JBossAS7 - Authorization (Managed Server) Service”
Section 3.3.2.4.20.1.6, “JBossAS7 - Identity Trust (Managed Server) Service”
Section 3.3.2.4.20.1.7, “JBossAS7 - JSSE (Managed Server) Service”
Section 3.3.2.4.20.1.8, “JBossAS7 - Mapping (Managed Server) Service”

Connection Properties

Table 3.1373.
Name	Description	Required	Internal 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.1374.
Name	Description	Required	Internal Name
Cache Type	Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache.	no	cache-type

Note

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

Operations

Table 3.1375. Metrics
Name	Description
Flush Cache	Remove entries stored in the authentication cache for this security domain. A single entry can be flushed by using the principal argument with the username as the value. If no argument is passed to the operation, all entries are flushed.
List Cached Principals	Lists the principals stored in the authentication cache for this security domain.

Package Types

none

3.3.2.4.20.1.1. JBossAS7 - ACL (Managed Server) Service

Overview

Table 3.1376. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.1.1, “JBossAS7 - Acl Modules (Managed Server) Service”

Connection Properties

Table 3.1377.
Name	Description	Required	Internal 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.1378.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.1.1. JBossAS7 - Acl Modules (Managed Server) Service

Overview

Table 3.1379. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.1.1.1, “JBossAS7 - Module Options (Acl - Managed Server) Service”

Connection Properties

Table 3.1380.
Name	Description	Required	Internal 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.1381.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.1.1.1. JBossAS7 - Module Options (Acl - Managed Server) Service

Overview

Table 3.1382. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1383.
Name	Description	Required	Internal 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.1384.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.2. JBossAS7 - Audit (Managed Server) Service

Overview

Table 3.1385. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.2.1, “JBossAS7 - Provider Modules (Managed Server) Service”

Connection Properties

Table 3.1386.
Name	Description	Required	Internal 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.1387.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.2.1. JBossAS7 - Provider Modules (Managed Server) Service

Overview

Table 3.1388. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.2.1.1, “JBossAS7 - Module Options (Provider Modules - Managed Server) Service”

Connection Properties

Table 3.1389.
Name	Description	Required	Internal 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.1390.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.2.1.1. JBossAS7 - Module Options (Provider Modules - Managed Server) Service

Overview

Table 3.1391. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1392.
Name	Description	Required	Internal 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.1393.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.3. JBossAS7 - Authentication (Classic - Managed Server) Service

Overview

Table 3.1394. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.3.1, “JBossAS7 - Login Modules (Classic - Managed Server) Service”

Connection Properties

Table 3.1395.
Name	Description	Required	Internal 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.3.2.4.20.1.3.1. JBossAS7 - Login Modules (Classic - Managed Server) Service

Overview

Table 3.1396. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.3.1.1, “JBossAS7 - Module Options (Classic - Managed Server) Service”

Connection Properties

Table 3.1397.
Name	Description	Required	Internal 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.1398.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.3.1.1. JBossAS7 - Module Options (Classic - Managed Server) Service

Overview

Table 3.1399. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1400.
Name	Description	Required	Internal 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.1401.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.4. JBossAS7 - Authentication (Jaspi - Managed Server) Service

Overview

Table 3.1402. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.4.1, “JBossAS7 - Login Module Stack (Managed Server) Service”

Connection Properties

Table 3.1403.
Name	Description	Required	Internal 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.1404.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.4.1. JBossAS7 - Login Module Stack (Managed Server) Service

Overview

Table 3.1405. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.4.1.1, “JBossAS7 - Module Options (Login Module Stack (Managed Server)) Service”

Connection Properties

Table 3.1406.
Name	Description	Required	Internal 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.1407.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.4.1.1. JBossAS7 - Module Options (Login Module Stack (Managed Server)) Service

Overview

Table 3.1408. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1409.
Name	Description	Required	Internal 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.1410.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.5. JBossAS7 - Authorization (Managed Server) Service

Overview

Table 3.1411. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.5.1, “JBossAS7 - Authorization Modules (Managed Server) Service”

Connection Properties

Table 3.1412.
Name	Description	Required	Internal 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.1413.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.5.1. JBossAS7 - Authorization Modules (Managed Server) Service

Overview

Table 3.1414. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.5.1.1, “JBossAS7 - Module Options (Authorization - Managed Server) Service”

Connection Properties

Table 3.1415.
Name	Description	Required	Internal 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.1416.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.5.1.1. JBossAS7 - Module Options (Authorization - Managed Server) Service

Overview

Table 3.1417. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1418.
Name	Description	Required	Internal 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.1419.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.6. JBossAS7 - Identity Trust (Managed Server) Service

Overview

Table 3.1420. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.6.1, “JBossAS7 - Identity Trust Modules (Managed Server) Service”

Connection Properties

Table 3.1421.
Name	Description	Required	Internal 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.1422.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.6.1. JBossAS7 - Identity Trust Modules (Managed Server) Service

Overview

Table 3.1423. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.6.1.1, “JBossAS7 - Module Options (Identity Trust - Managed Server) Service”

Connection Properties

Table 3.1424.
Name	Description	Required	Internal 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.1425.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Flag	The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.	yes	flag

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.6.1.1. JBossAS7 - Module Options (Identity Trust - Managed Server) Service

Overview

Table 3.1426. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1427.
Name	Description	Required	Internal 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.1428.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.7. JBossAS7 - JSSE (Managed Server) Service

Overview

Table 3.1429. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1430.
Name	Description	Required	Internal 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.1431.
Name	Description	Required	Internal Name
Cipher Suites	Comma separated list of cipher suites to enable on SSLSockets.	no	cipher-suites
Client Alias	Preferred alias to use when the KeyManager chooses the client alias.	no	client-alias
Client Auth	Boolean attribute to indicate if client's certificates should also be authenticated on the server side.	no	client-auth
Key Manager	JSEE Key Manager factory	no	key-manager
Keystore	Configures a JSSE key store	no	keystore
Protocols	Comma separated list of protocols to enable on SSLSockets.	no	protocols
Server Alias	Preferred alias to use when the KeyManager chooses the server alias.	no	server-alias
Service Auth Token	Token to retrieve PrivateKeys from the KeyStore.	no	service-auth-token
Trust Manager	JSEE Trust Manager factory	no	trust-manager
Truststore	Configures a JSSE trust store	no	truststore

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.8. JBossAS7 - Mapping (Managed Server) Service

Overview

Table 3.1432. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.8.1, “JBossAS7 - Mapping Modules (Managed Server) Service”

Connection Properties

Table 3.1433.
Name	Description	Required	Internal 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.1434.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Type	Type of mapping this module performs. Allowed values are principal, role, attribute or credential..	yes	type

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.8.1. JBossAS7 - Mapping Modules (Managed Server) Service

Overview

Table 3.1435. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.20.1.8.1.1, “JBossAS7 - Module Options (Mapping - Managed Server) Service”

Connection Properties

Table 3.1436.
Name	Description	Required	Internal 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.1437.
Name	Description	Required	Internal Name
Code	Class name of the module to be instantiated.	yes	code
Type	Type of mapping this module performs. Allowed values are principal, role, attribute or credential..	yes	type

Note

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

Operations

none

Package Types

none

3.3.2.4.20.1.8.1.1. JBossAS7 - Module Options (Mapping - Managed Server) Service

Overview

Table 3.1438. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1439.
Name	Description	Required	Internal 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.1440.
Name	Description	Required	Internal Name
Module Options		no	Module Options

Note

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

Operations

none

Package Types

none

3.3.2.4.20.2. JBossAS7 - Vault (Managed Server) Service

Overview

Table 3.1441. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1442.
Name	Description	Required	Internal 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.1443.
Name	Description	Required	Internal Name
Code	Fully Qualified Name of the Security Vault Implementation.	no	code

Note

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

Operations

none

Package Types

none

3.3.2.4.21. JBossAS7 - Messaging (Managed Server) Service

Overview

Table 3.1444. Overview
Description:	The messaging subsystems
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1, “JBossAS7 - HornetQ (Managed Server) Service”

Connection Properties

Table 3.1445.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

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.3.2.4.21.1. JBossAS7 - HornetQ (Managed Server) Service

Overview

Table 3.1446. Overview
Description:	The HornetQ based messaging subsystem
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.1, “JBossAS7 - JMS Queue (Managed Server) Service”
Section 3.3.2.4.21.1.2, “JBossAS7 - JMS Topic (Managed Server) Service”
Section 3.3.2.4.21.1.3, “JBossAS7 - Connection Factory (Managed Server) Service”
Section 3.3.2.4.21.1.4, “JBossAS7 - Pooled Connection Factory (Managed Server) Service”
Section 3.3.2.4.21.1.5, “JBossAS7 - Security Setting (Managed Server) Service”
Section 3.3.2.4.21.1.6, “JBossAS7 - Address Setting (Managed Server) Service”
Section 3.3.2.4.21.1.7, “JBossAS7 - Grouping Handler (Managed Server) Service”
Section 3.3.2.4.21.1.8, “JBossAS7 - Acceptor (Managed Server) Service”
Section 3.3.2.4.21.1.9, “JBossAS7 - Connector (HornetQ - Managed Server) Service”
Section 3.3.2.4.21.1.10, “JBossAS7 - In VM Acceptor (Managed Server) Service”
Section 3.3.2.4.21.1.11, “JBossAS7 - In VM Connector (Managed Server) Service”
Section 3.3.2.4.21.1.12, “JBossAS7 - Remote Acceptor (Managed Server) Service”
Section 3.3.2.4.21.1.13, “JBossAS7 - Remote Connector (Managed Server) Service”
Section 3.3.2.4.21.1.14, “JBossAS7 - Divert (Managed Server) Service”
Section 3.3.2.4.21.1.15, “JBossAS7 - Queue (Managed Server) Service”
Section 3.3.2.4.21.1.16, “JBossAS7 - Core Address (Managed Server) Service”
Section 3.3.2.4.21.1.17, “JBossAS7 - Cluster Connection (Managed Server) Service”
Section 3.3.2.4.21.1.18, “JBossAS7 - Broadcast Group (Managed Server) Service”
Section 3.3.2.4.21.1.19, “JBossAS7 - Path (Managed Server) Service”
Section 3.3.2.4.21.1.20, “JBossAS7 - Bridge (Managed Server) Service”
Section 3.3.2.4.21.1.21, “JBossAS7 - Discovery Group (Managed Server) Service”
Section 3.3.2.4.21.1.22, “JBossAS7 - Connector Service (Managed Server) Service”
Section 3.3.2.4.21.1.23, “JBossAS7 - Runtime Queue (Managed Server) Service”

Connection Properties

Table 3.1447.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1448. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this server is started.	started
Version	trait	The server's version.	version

Note

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

Configuration Properties

Table 3.1449.
Name	Description	Required	Internal Name
Allow Failback	Whether this server will automatically shutdown if the original live server comes back up. The default value is true.	no	allow-failback
Async Connection Execution Enabled	Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true.	no	async-connection-execution-enabled
Backup	Whether this server is a backup server. The default value is false.	no	backup
Cluster Password	The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!.	no	cluster-password
Cluster User	The user used by cluster connections to communicate between the clustered nodes. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	cluster-user
Clustered	Whether the server is clustered. The default value is false.	no	clustered
Connection Ttl Override	If set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1.	no	connection-ttl-override
Create Bindings Dir	Whether the server should create the bindings directory on start up. The default value is true.	no	create-bindings-dir
Create Journal Dir	Whether the server should create the journal directory on start up. The default value is true.	no	create-journal-dir
Failback Delay	How long to wait before failback occurs on live server restart. The default value is 5000.	no	failback-delay
Failover On Shutdown	Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false.	no	failover-on-shutdown
Id Cache Size	The size of the cache for pre-creating message IDs. The default value is 2000.	no	id-cache-size
Jmx Domain	The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq.	no	jmx-domain
Jmx Management Enabled	Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false.	no	jmx-management-enabled
Journal Buffer Size	The size of the internal buffer on the journal.	no	journal-buffer-size
Journal Buffer Timeout	The timeout (in nanoseconds) used to flush internal buffers on the journal.	no	journal-buffer-timeout
Journal Compact Min Files	The minimal number of journal data files before we can start compacting. The default value is 10.	no	journal-compact-min-files
Journal Compact Percentage	The percentage of live data on which we consider compacting the journal. The default value is 30.	no	journal-compact-percentage
Journal File Size	The size (in bytes) of each journal file. The default value is 10485760.	no	journal-file-size
Journal Max Io	The maximum number of write requests that can be in the AIO queue at any one time.	no	journal-max-io
Journal Min Files	How many journal files to pre-create. The default value is 2.	no	journal-min-files
Journal Sync Non Transactional	Whether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true.	no	journal-sync-non-transactional
Journal Sync Transactional	Whether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true.	no	journal-sync-transactional
Journal Type	The type of journal to use. The default value is ASYNCIO.	no	journal-type
Live Connector Ref	The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'.	no	live-connector-ref
Log Journal Write Rate	Whether to periodically log the journal's write rate and flush rate. The default value is false.	no	log-journal-write-rate
Management Address	Address to send management messages to. The default value is jms.queue.hornetq.management.	no	management-address
Management Notification Address	The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications.	no	management-notification-address
Memory Measure Interval	Frequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1.	no	memory-measure-interval:expr
Memory Warning Threshold	Percentage of available memory which if exceeded results in a warning log. The default value is 25.	no	memory-warning-threshold:expr
Message Counter Enabled	Whether message counters are enabled. The default value is false.	no	message-counter-enabled
Message Counter Max Day History	How many days to keep message counter history. The default value is 10.	no	message-counter-max-day-history
Message Counter Sample Period	The sample period (in ms) to use for message counters. The default value is 10000.	no	message-counter-sample-period
Message Expiry Scan Period	How often (in ms) to scan for expired messages. The default value is 30000.	no	message-expiry-scan-period
Message Expiry Thread Priority	The priority of the thread expiring messages. The default value is 3.	no	message-expiry-thread-priority
Page Max Concurrent Io	The maximum number of concurrent reads allowed on paging. The default value is 5.	no	page-max-concurrent-io
Perf Blast Pages	TODO. The default value is -1.	no	perf-blast-pages
Persist Delivery Count Before Delivery	Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false.	no	persist-delivery-count-before-delivery
Persist Id Cache	Whether IDs are persisted to the journal. The default value is true.	no	persist-id-cache
Persistence Enabled	Whether the server will use the file based journal for persistence. The default value is true.	no	persistence-enabled
Remoting Interceptors	The list of interceptor classes used by this server.	no	remoting-interceptors:nullable
Run Sync Speed Test	Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false.	no	run-sync-speed-test
Scheduled Thread Pool Max Size	The number of threads that the main scheduled thread pool has. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Security Domain	The security domain to use to verify user and role information. The default value is other.	no	security-domain
Security Enabled	Whether security is enabled. The default value is true.	no	security-enabled
Security Invalidation Interval	How long (in ms) to wait before invalidating the security cache. The default value is 10000.	no	security-invalidation-interval
Server Dump Interval	How often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1.	no	server-dump-interval
Shared Store	Whether this server is using a shared store for failover. The default value is true.	no	shared-store
Thread Pool Max Size	The number of threads that the main thread pool has. -1 means no limit. The default value is 30.	no	thread-pool-max-size:expr
Transaction Timeout	How long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000.	no	transaction-timeout
Transaction Timeout Scan Period	How often (in ms) to scan for timeout transactions. The default value is 1000.	no	transaction-timeout-scan-period
Wild Card Routing Enabled	Whether the server supports wild card routing. The default value is true.	no	wild-card-routing-enabled

Note

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

Operations

Table 3.1450. Metrics
Name	Description
Close Connections for Address	Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise.
Commit Prepared Transaction	Heuristically commits a prepared transaction.
Force Failover	Force the messaging server to stop and notify clients to failover.
Get Address Settings as JSON	Returns the address settings as a JSON string for an address match. The returned String is a JSON string containing an array of address settings details.
Get Connectors as JSON	Returns the connectors configured for this server using JSON serialization.
Get Last Sent Message ID	Returns the ID of the last message sent from the given session to the given address.
Get Session Creation Time	Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch.
List All Consumers as JSON	Lists all the consumers.
List Connection IDs	Lists the IDs of all the connections connected to this server.
List Connections as JSON	List all JMS connections.
List Consumers as JSON	Lists all the consumers which belongs to the JMS Connection specified by the connection-id.
List Heuristic Committed Transactions	Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Heuristic Rolled Back Transactions	Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID.
List Prepared Transaction Details as HTML	List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List Prepared Transaction Details as JSON	List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List Prepared Transaction JMS Details as HTML	List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format
List Prepared Transaction JMS details as JSON	List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format
List Prepared Transactions	List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.
List Producers Info as JSON	For all sessions, lists information about message producers using JSON serialization.
List Remote Addresses	Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List Sessions	Lists all the sessions IDs for the specified connection ID.
List Sessions as JSON	Lists all the sessions IDs for the specified connection ID. The returned String is a JSON string containing an array of session ids.
List Target Destinations	Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names.
Reset All Message Counter Histories	Reset all message counters history.
Reset All Message Counters	Reset all message counters.
Rollback Prepared Transaction	Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise.

Package Types

none

3.3.2.4.21.1.1. JBossAS7 - JMS Queue (Managed Server) Service

Overview

Table 3.1451. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1452.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1453. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Expiry Address	trait	The address to send expired messages to.	expiry-address
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Temporary	trait	Whether the queue is temporary.	temporary
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address

Note

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

Configuration Properties

Table 3.1454.
Name	Description	Required	Internal Name
Durable	Whether the queue is durable or not. The default value is true.	no	durable
Entries	The jndi names the queue will be bound to.	yes	entries
Selector	The queue selector.	no	selector

Note

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

Operations

Table 3.1455. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.2.4.21.1.2. JBossAS7 - JMS Topic (Managed Server) Service

Overview

Table 3.1456. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1457.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1458. Metrics
Name	Type	Description	Internal Name
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable Message Count	measurement	The number of messages for all durable subscribers for this topic.	durable-message-count
Durable Subscription Count	measurement	The number of durable subscribers for this topic.	durable-subscription-count
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Non Durable Message Count	measurement	The number of messages for all non-durable subscribers for this topic.	non-durable-message-count
Non Durable Subscription Count	measurement	The number of non-durable subscribers for this topic.	non-durable-subscription-count
Subscription Count	measurement	The number of (durable and non-durable) subscribers for this topic.	subscription-count
Temporary	trait	Whether the topic is temporary.	temporary
Topic Address	trait	The address the topic points to.	topic-address

Note

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

Configuration Properties

Table 3.1459.
Name	Description	Required	Internal Name
JNDI Names	The jndi names the queue will be bound to.	yes	entries

Note

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

Operations

Table 3.1460. Metrics
Name	Description
Count Messages for Subscription	Count the number of messages matching the filter for the given subscription.
Drop All Subscriptions	Drop all subscriptions from this topic.
Drop Durable Subscription	Drop a durable subscription
List All Subscriptions	List all subscriptions.
List All Subscriptions as JSON	List all subscriptions as a string in JSON format.
List Durable Subscriptions	List only the durable subscriptions.
List Durable Subscriptions as JSON	List only the durable subscriptions, as a string in JSON format.
List Messages for Subscription	List all the messages for the given subscription.
List Messages for Subscription as JSON	List all the messages for the given subscription as a string in JSON format.
List Non-Durable Subscriptions	List only the non-durable subscriptions.
List Non-Durable Subscriptions as JSON	List only the non-durable subscriptions, as a string in JSON format.
Remove Messages	Remove messages matching the given filter from the destination.

Package Types

none

3.3.2.4.21.1.3. JBossAS7 - Connection Factory (Managed Server) Service

Overview

Table 3.1461. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1462.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.1463.
Name	Description	Required	Internal Name
Connector	Defines the connector to be used. This is mutually exclusive with discovery-group-name	no	connector:collapsed
JNDI Names	The jndi names the connection factory should be bound to.	yes	entries
Auto Group	Whether or not message grouping is automatically used. The default value is false.	no	auto-group
Block On Acknowledge	True to set block on acknowledge. The default value is false.	no	block-on-acknowledge
Block On Durable Send	True to set block on durable send. The default value is true.	no	block-on-durable-send
Block On Non Durable Send	True to set block on non durable send. The default value is false.	no	block-on-non-durable-send
Cache Large Message Client	True to cache large messages. The default value is false.	no	cache-large-message-client
Call Timeout	The call time out. The default value is 30000.	no	call-timeout
Client Failure Check Period	The client failure check period. The default value is 30000.	no	client-failure-check-period
Client Id	The client id.	no	client-id
Compress Large Messages	Whether large messages should be compressed. The default value is false.	no	compress-large-messages
Confirmation Window Size	The confirmation window size. The default value is -1.	no	confirmation-window-size
Connection Load Balancing Policy Class Name	Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy.	no	connection-load-balancing-policy-class-name
Connection Ttl	The connection ttl. The default value is 60000.	no	connection-ttl
Consumer Max Rate	The consumer max rate. The default value is -1.	no	consumer-max-rate
Consumer Window Size	The consumer window size. The default value is 1048576.	no	consumer-window-size
Discovery Group Name	The discovery group name.	no	discovery-group-name
Discovery Initial Wait Timeout	The discovery initial wait time out.	no	discovery-initial-wait-timeout
Dups Ok Batch Size	The dups ok batch size. The default value is 1048576.	no	dups-ok-batch-size
Factory Type	The type of connection factory.	no	factory-type
Failover On Initial Connection	True to fail over on initial connection. The default value is false.	no	failover-on-initial-connection
Failover On Server Shutdown	True to fail over on server shutdown.	no	failover-on-server-shutdown
Group Id	The group id.	no	group-id
Ha	Whether the connection factory supports High Availability. The default value is false.	yes	ha
Initial Message Packet Size	The initial size of messages created through this factory.	yes	initial-message-packet-size
Max Retry Interval	The max retry interval. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The min large message size. The default value is 102400.	no	min-large-message-size
Pre Acknowledge	True to pre-acknowledge. The default value is false.	no	pre-acknowledge
Producer Max Rate	The producer max rate. The default value is -1.	no	producer-max-rate
Producer Window Size	The producer window size. The default value is 65536.	no	producer-window-size
Reconnect Attempts	The reconnect attempts. The default value is 0.	no	reconnect-attempts
Retry Interval	The retry interval. The default value is 2000.	no	retry-interval
Retry Interval Multiplier	The retry interval multiplier. The default value is 1.0.	no	retry-interval-multiplier
Scheduled Thread Pool Max Size	The scheduled thread pool max size. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Thread Pool Max Size	The thread pool max size. The default value is 30.	no	thread-pool-max-size:expr
Transaction Batch Size	The transaction batch size. The default value is 1048576.	no	transaction-batch-size
Use Global Pools	True to use global pools. The default value is true.	no	use-global-pools

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.4. JBossAS7 - Pooled Connection Factory (Managed Server) Service

Overview

Table 3.1464. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1465.
Name	Description	Required	Internal 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.1466.
Name	Description	Required	Internal Name
Connector	Defines the connectors. These are stored in a map by connector name, with the backup connectors stored as the value, or an undefined value if there is no backup connector.	no	connector:collapsed
JNDI Names	The jndi names the connection factory should be bound to.	yes	entries
Auto Group	The autogroup. The default value is false.	no	auto-group
Block On Acknowledge	True to set block on acknowledge. The default value is false.	no	block-on-acknowledge
Block On Durable Send	True to set block on durable send. The default value is true.	no	block-on-durable-send
Block On Non Durable Send	True to set block on non durable send. The default value is false.	no	block-on-non-durable-send
Cache Large Message Client	True to cache large messages. The default value is false.	no	cache-large-message-client
Call Timeout	The call time out. The default value is 30000.	no	call-timeout
Client Failure Check Period	The client failure check period. The default value is 30000.	no	client-failure-check-period
Client Id	The client id.	no	client-id
Confirmation Window Size	The confirmation window size. The default value is -1.	no	confirmation-window-size
Connection Load Balancing Policy Class Name	Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy.	no	connection-load-balancing-policy-class-name
Connection Ttl	The connection ttl. The default value is 60000.	no	connection-ttl
Consumer Max Rate	The consumer max rate. The default value is -1.	no	consumer-max-rate
Consumer Window Size	The consumer window size. The default value is 1048576.	no	consumer-window-size
Discovery Group Name	The discovery group name.	no	discovery-group-name
Discovery Initial Wait Timeout	The discovery initial wait time out.	no	discovery-initial-wait-timeout
Dups Ok Batch Size	The dups ok batch size. The default value is 1048576.	no	dups-ok-batch-size
Failover On Initial Connection	True to fail over on initial connection. The default value is false.	no	failover-on-initial-connection
Failover On Server Shutdown	True to fail over on server shutdown.	no	failover-on-server-shutdown
Group Id	The group id.	no	group-id
Ha	Whether the connection factory supports High Availability. The default value is false.	no	ha
Jndi Params	The JNDI params to use for locating the destination for incoming connections.	no	jndi-params
Max Pool Size	The maximum size for the pool. The default value is -1.	no	max-pool-size:expr
Max Retry Interval	The max retry interval. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The min large message size. The default value is 102400.	no	min-large-message-size
Min Pool Size	The minimum size for the pool. The default value is -1.	no	min-pool-size:expr
Password	The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.	no	password
Pre Acknowledge	True to pre-acknowledge. The default value is false.	no	pre-acknowledge
Producer Max Rate	The producer max rate. The default value is -1.	no	producer-max-rate
Producer Window Size	The producer window size. The default value is 65536.	no	producer-window-size
Reconnect Attempts	The reconnect attempts. The default value is 0.	no	reconnect-attempts
Retry Interval	The retry interval. The default value is 2000.	no	retry-interval
Retry Interval Multiplier	The retry interval multiplier. The default value is 1.0.	no	retry-interval-multiplier
Scheduled Thread Pool Max Size	The scheduled thread pool max size. The default value is 5.	no	scheduled-thread-pool-max-size:expr
Setup Attempts	The number of times to set up an MDB endpoint	no	setup-attempts
Setup Interval	The interval between attempts at setting up an MDB endpoint.	no	setup-interval
Thread Pool Max Size	The thread pool max size. The default value is 30.	no	thread-pool-max-size:expr
Transaction	TODO. The default value is transaction.	no	transaction
Transaction Batch Size	The transaction batch size. The default value is 1048576.	no	transaction-batch-size
Use Global Pools	True to use global pools. The default value is true.	no	use-global-pools
Use Jndi	Use JNDI to locate the destination for incoming connections	no	use-jndi
Use Local Tx	Use a local transaction for incoming sessions	no	use-local-tx
User	The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.	no	user

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.5. JBossAS7 - Security Setting (Managed Server) Service

Overview

Table 3.1467. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.5.1, “JBossAS7 - Role (Managed Server) Service”

Connection Properties

Table 3.1468.
Name	Description	Required	Internal 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.3.2.4.21.1.5.1. JBossAS7 - Role (Managed Server) Service

Overview

Table 3.1469. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1470.
Name	Description	Required	Internal 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.1471.
Name	Description	Required	Internal Name
Consume	his permission allows the user to consume a message from a queue bound to matching addresses. The default value is false.	yes	consume
Create Durable Queue	This permission allows the user to create a durable queue. The default value is false.	yes	create-durable-queue
Create Non Durable Queue	This permission allows the user to create a temporary queue. The default value is false.	yes	create-non-durable-queue
Delete Durable Queue	This permission allows the user to delete a durable queue. The default value is false.	yes	delete-durable-queue
Delete Non Durable Queue	This permission allows the user to delete a temporary queue. The default value is false.	yes	delete-non-durable-queue
Manage	This permission allows the user to invoke management operations by sending management messages to the management address. The default value is false.	yes	manage
Send	This permission allows the user to send a message to matching addresses. The default value is false.	yes	send

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.6. JBossAS7 - Address Setting (Managed Server) Service

Overview

Table 3.1472. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1473.
Name	Description	Required	Internal 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.1474.
Name	Description	Required	Internal Name
Address Full Policy	Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK). The default value is PAGE.	no	address-full-policy
Dead Letter Address	The dead letter address	no	dead-letter-address
Expiry Address	Defines where to send a message that has expired.	no	expiry-address
Last Value Queue	Defines whether a queue only uses last values or not. The default value is false.	no	last-value-queue
Max Delivery Attempts	Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address. The default value is 10.	no	max-delivery-attempts
Max Size Bytes	The max bytes size. The default value is -1.	no	max-size-bytes
Message Counter History Day Limit	Day limit for the message counter history. The default value is 0.	no	message-counter-history-day-limit
Page Max Cache Size	The number of page files to keep in memory to optimize IO during paging navigation. The default value is 5.	no	page-max-cache-size
Page Size Bytes	The paging size. The default value is 10485760.	no	page-size-bytes
Redelivery Delay	Defines how long to wait before attempting redelivery of a cancelled message. The default value is 0.	no	redelivery-delay
Redistribution Delay	Defines how long to wait when the last consumer is closed on a queue before redistributing any messages. The default value is -1.	no	redistribution-delay
Send To Dla On No Route	If this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists. The default value is false.	no	send-to-dla-on-no-route

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.7. JBossAS7 - Grouping Handler (Managed Server) Service

Overview

Table 3.1475. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1476.
Name	Description	Required	Internal 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.1477.
Name	Description	Required	Internal Name
Grouping Handler Address	A reference to a cluster connection and the address it uses.	yes	grouping-handler-address
Timeout	How long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept. The default value is 5000.	no	timeout
Type	Whether the handler is the single 'Local' handler for the cluster, which makes handling decisions, or a 'Remote' handler which converses with the local handler.	no	type

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.8. JBossAS7 - Acceptor (Managed Server) Service

Overview

Table 3.1478. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.8.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1479.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1480. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this acceptor is started.	started

Note

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

Configuration Properties

Table 3.1481.
Name	Description	Required	Internal Name
Factory Class	The factory class.	yes	factory-class
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

Table 3.1482. Metrics
Name	Description
Start	Starts the acceptor.
Stop	Stops the acceptor.

Package Types

none

3.3.2.4.21.1.8.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1483. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1484.
Name	Description	Required	Internal 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.1485.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.9. JBossAS7 - Connector (HornetQ - Managed Server) Service

Overview

Table 3.1486. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.9.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1487.
Name	Description	Required	Internal 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.1488.
Name	Description	Required	Internal Name
Factory Class	The factory class.	yes	factory-class
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.9.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1489. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1490.
Name	Description	Required	Internal 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.1491.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.10. JBossAS7 - In VM Acceptor (Managed Server) Service

Overview

Table 3.1492. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.10.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1493.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1494. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether it's stopped or started.	started

Note

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

Configuration Properties

Table 3.1495.
Name	Description	Required	Internal Name
Server Id	The server id.	yes	server-id

Note

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

Operations

Table 3.1496. Metrics
Name	Description
Start	Starts the acceptor.
Stop	Stops the acceptor.

Package Types

none

3.3.2.4.21.1.10.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1497. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1498.
Name	Description	Required	Internal 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.1499.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.11. JBossAS7 - In VM Connector (Managed Server) Service

Overview

Table 3.1500. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.11.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1501.
Name	Description	Required	Internal 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.1502.
Name	Description	Required	Internal Name
Server Id	The server id.	yes	server-id

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.11.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1503. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1504.
Name	Description	Required	Internal 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.1505.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.12. JBossAS7 - Remote Acceptor (Managed Server) Service

Overview

Table 3.1506. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.12.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1507.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1508. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether this acceptor is started.	started

Note

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

Configuration Properties

Table 3.1509.
Name	Description	Required	Internal Name
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

Table 3.1510. Metrics
Name	Description
Start	Starts the acceptor.
Stop	Stops the acceptor.

Package Types

none

3.3.2.4.21.1.12.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1511. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1512.
Name	Description	Required	Internal 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.1513.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.13. JBossAS7 - Remote Connector (Managed Server) Service

Overview

Table 3.1514. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.13.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1515.
Name	Description	Required	Internal 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.1516.
Name	Description	Required	Internal Name
Socket Binding	The socket binding reference.	no	socket-binding

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.13.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1517. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1518.
Name	Description	Required	Internal 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.1519.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.14. JBossAS7 - Divert (Managed Server) Service

Overview

Table 3.1520. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1521.
Name	Description	Required	Internal 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.1522.
Name	Description	Required	Internal Name
Divert Address	Address to divert from	yes	divert-address
Exclusive	Whether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all. The default value is false.	no	exclusive
Filter	An optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.	no	filter
Forwarding Address	Address to divert to	yes	forwarding-address
Routing Name	Routing name of the divert	no	routing-name
Transformer Class Name	The name of a class used to transform the message's body or properties before it is diverted.	no	transformer-class-name

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.15. JBossAS7 - Queue (Managed Server) Service

Overview

Table 3.1523. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1524.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1525. Metrics
Name	Type	Description	Internal Name
Id	trait	The id of the queue.	id
Paused	trait	Whether the queue is paused.	paused
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

Table 3.1526.
Name	Description	Required	Internal Name
Durable	Defines whether the queue is durable. The default value is true.	no	durable
Filter	A queue message filter definition. An undefined or empty filter will match all messages.	no	filter
Queue Address	The queue address defines what address is used for routing messages.	yes	queue-address

Note

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

Operations

Table 3.1527. Metrics
Name	Description
Change Message Priority	Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages Priority	Change the priority of the messages corresponding to the given filter.
Count Messages	Returns the number of the messages in the queue matching the given filter.
Expire Message	Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire Messages	Expire the messages matching the given filter.
List Consumers as JSON	A string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter History as HTML	List the message counter history.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
List Messages	List all messages in the queue that match the filter
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
List Scheduled Messages	List the messages scheduled for delivery.
List Scheduled Messages as JSON	List the messages scheduled for delivery as a string in JSON format.
Move Message	Move the message corresponding to the given message-id to another queue
Move Messages	Move the messages corresponding to the given filter to another queue.
Pause	Pause the queue.
Remove Message	Remove the message corresponding to the given message-id.
Remove Messages	Remove messages matching the given filter from the destination.
Reset Message Counter	Reset the message counters.
Resume	Resume the queue.
Send Message to Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Package Types

none

3.3.2.4.21.1.16. JBossAS7 - Core Address (Managed Server) Service

Overview

Table 3.1528. Overview
Description:	A runtime-only resource representing a HornetQ address. Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1529.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.1530.
Name	Description	Required	Internal Name
Binding Names	The names of all bindings (both queues and diverts) bound to this address.	yes	binding-names
Number Of Bytes Per Page	The number of bytes used by each page for this address.	yes	number-of-bytes-per-page
Number Of Pages	The number of pages used by this address.	yes	number-of-pages
Queue Names	The names of the queues associated with the address.	yes	queue-names
Roles	A list of the security roles (name and permissions) associated with the address.	yes	roles

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.17. JBossAS7 - Cluster Connection (Managed Server) Service

Overview

Table 3.1531. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1532.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1533. Metrics
Name	Type	Description	Internal Name
Node Id	trait	The node ID used by this cluster connection.	node-id
Started	trait	Whether the cluster connection is started.	started

Note

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

Configuration Properties

Table 3.1534.
Name	Description	Required	Internal Name
Call Timeout	The timeout (in ms) for remote calls made by the cluster connection. The default value is 30000.	no	call-timeout
Check Period	The period (in milliseconds) between client failure check. The default value is 30000.	no	check-period
Cluster Connection Address	Each cluster connection only applies to messages sent to an address that starts with this value.	yes	cluster-connection-address
Confirmation Window Size	The confirmation-window-size to use for the connection used to forward messages to a target node. The default value is 1048576.	no	confirmation-window-size
Connection Ttl	The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat). The default value is 60000.	no	connection-ttl
Connector Ref	The confirmation-window-size to use for the connection used to forward messages to a target node.	yes	connector-ref
Discovery Group Name	The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.	no	discovery-group-name
Forward When No Consumers	Whether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then HornetQ will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message. The default value is false.	no	forward-when-no-consumers
Max Hops	The maximum number of times a message can be forwarded. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ servers as intermediates in a chain. The default value is 1.	no	max-hops
Max Retry Interval	The maximum interval of time used to retry connections. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400.	no	min-large-message-size
Reconnect Attempts	The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1.	no	reconnect-attempts
Retry Interval	The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 500.	no	retry-interval
Retry Interval Multiplier	A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0.	no	retry-interval-multiplier
Static Connectors	The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.	no	static-connectors:nullable
Use Duplicate Detection	Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true.	no	use-duplicate-detection

Note

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

Operations

Table 3.1535. Metrics
Name	Description
Get Nodes	Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.
Start	Starts the cluster connection.
Stop	Stops the cluster connection.

Package Types

none

3.3.2.4.21.1.18. JBossAS7 - Broadcast Group (Managed Server) Service

Overview

Table 3.1536. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1537.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1538. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether the broadcast group is started.	started

Note

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

Configuration Properties

Table 3.1539.
Name	Description	Required	Internal Name
Broadcast Period	The period in milliseconds between consecutive broadcasts. The default value is 2000.	no	broadcast-period
Connectors	Specifies the names of connectors that will be broadcast.	no	connectors
Socket Binding	The broadcast group socket binding.	yes	socket-binding

Note

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

Operations

Table 3.1540. Metrics
Name	Description
Get Connector Pairs as JSON	Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.
Start	Starts the broadcast group.
Stop	Stops the broadcast group.

Package Types

none

3.3.2.4.21.1.19. JBossAS7 - Path (Managed Server) Service

Overview

Table 3.1541. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1542.
Name	Description	Required	Internal 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.1543.
Name	Description	Required	Internal Name
Path	The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.	yes	path
Relative To	The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The 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	relative-to
Path Type	Path Type	yes	__name

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.20. JBossAS7 - Bridge (Managed Server) Service

Overview

Table 3.1544. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1545.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1546. Metrics
Name	Type	Description	Internal Name
Started	trait	Whether the bridge is started.	started

Note

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

Configuration Properties

Table 3.1547.
Name	Description	Required	Internal Name
Check Period	The period (in milliseconds) between client failure check. The default value is 30000.	no	check-period
Confirmation Window Size	The confirmation-window-size to use for the connection used to forward messages to the target node. The default value is 1048576.	no	confirmation-window-size
Connection Ttl	The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat). The default value is 60000.	no	connection-ttl
Discovery Group Name	The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.	no	discovery-group-name
Failover On Server Shutdown	Whether the bridge will attempt to failover onto a backup server (if specified) when the target server is cleanly shutdown rather than crashed.	no	failover-on-server-shutdown
Filter	An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.	no	filter
Forwarding Address	The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.	no	forwarding-address
Ha	Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover. The default value is false.	no	ha
Max Retry Interval	The maximum interval of time used to retry connections. The default value is 2000.	no	max-retry-interval
Min Large Message Size	The minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400.	no	min-large-message-size
Password	The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used. The default value is CHANGE ME!!.	no	password
Queue Name	The unique name of the local queue that the bridge consumes from.	yes	queue-name
Reconnect Attempts	The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1.	no	reconnect-attempts
Retry Interval	The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 2000.	no	retry-interval
Retry Interval Multiplier	A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0.	no	retry-interval-multiplier
Static Connectors	A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.	no	static-connectors:nullable
Transformer Class Name	The name of a user-defined class which implements the org.hornetq.core.server.cluster.Transformer interface.	no	transformer-class-name
Use Duplicate Detection	Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true.	no	use-duplicate-detection
User	The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used. The default value is HORNETQ.CLUSTER.ADMIN.USER.	no	user

Note

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

Operations

Table 3.1548. Metrics
Name	Description
Start	Starts the bridge.
Stop	Stops the bridge.

Package Types

none

3.3.2.4.21.1.21. JBossAS7 - Discovery Group (Managed Server) Service

Overview

Table 3.1549. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1550.
Name	Description	Required	Internal 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.1551.
Name	Description	Required	Internal Name
Initial Wait Timeout	Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster. The default value is 10000.	no	initial-wait-timeout
Refresh Timeout	Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list. The default value is 10000.	no	refresh-timeout
Socket Binding	The discovery group socket binding.	no	socket-binding

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.22. JBossAS7 - Connector Service (Managed Server) Service

Overview

Table 3.1552. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.21.1.22.1, “JBossAS7 - Param (Read Only) Service”

Connection Properties

Table 3.1553.
Name	Description	Required	Internal 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.1554.
Name	Description	Required	Internal Name
Factory Class	Class name of the factory class that can instantiate the connector service.	yes	factory-class

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.22.1. JBossAS7 - Param (Read Only) Service

Overview

Table 3.1555. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1556.
Name	Description	Required	Internal 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.1557.
Name	Description	Required	Internal Name
Value	The parameter value	yes	value

Note

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

Operations

none

Package Types

none

3.3.2.4.21.1.23. JBossAS7 - Runtime Queue (Managed Server) Service

Overview

Table 3.1558. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1559.
Name	Description	Required	Internal 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.1560. Metrics
Name	Type	Description	Internal Name
Consumer Count	measurement	The number of consumers consuming messages from this queue.	consumer-count
Dead Letter Address	trait	The address to send the queue's dead messages to.	dead-letter-address
Delivering Count	measurement	The number of messages that this queue is currently delivering to its consumers.	delivering-count
Durable	trait	Defines whether the queue is durable.	durable
Expiry Address	trait	The address to send the queue's expired messages to.	expiry-address
Filter	trait	A queue message filter definition. An undefined or empty filter will match all messages.	filter
Message Count	measurement	The number of messages currently in this queue.	message-count
Messages Added	measurement	The number of messages added to this queue since it was created.	messages-added
Paused	trait	Whether the queue is paused.	paused
Queue Address	trait	The queue address defines what address is used for routing messages.	queue-address
Scheduled Count	measurement	The number of scheduled messages in this queue.	scheduled-count
Temporary	trait	Whether the queue is temporary.	temporary

Note

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

Configuration Properties

none

Operations

Table 3.1561. Metrics
Name	Description
List Scheduled Messages as JSON	List the messages scheduled for delivery as a string in JSON format.
List Messages as JSON	List all messages in the queue that match the filter and return them as a string in JSON format.
Count Messages	Returns the number of the messages in the queue matching the given filter.
List Consumers as JSON	Lists consumers.
Change Messages Priority	Change the priority of the messages corresponding to the given filter.
Pause	Pause the queue.
List Message Counter History as JSON	List the message counter history as a string in JSON format.
Expire Messages	Expire the messages matching the given filter.
List Messages	List all messages in the queue that match the filter
Send message To Dead Letter Address	Send the message corresponding to the given message-id to this queue's Dead Letter Address.
Reset Message Counters	Reset the message counters.
Move Message	Move the message corresponding to the given message-id to another queue
Expire Message	Expire the message corresponding to the given message-id.
List Message Counter as JSON	List the message counter as a string in JSON format.
List Message Counter as HTML	List the message counter as a string in HTML format.
Remove Messages	Remove messages matching the given filter from the destination.
Move Messages	Move the messages corresponding to the given filter to another queue.
List Message Counter as HTML	List the message counter history.
List Scheduled Messages	List the messages scheduled for delivery.
Resume	Resume the queue.
Send Messages to Dead Letter Address	Send the messages corresponding to the given filter to this queue's Dead Letter Address.
Remove Message	Remove the message corresponding to the given message-id.
Change Message Priority	Change the priority of the message corresponding to the given message-id.

Package Types

none

3.3.2.4.22. JBossAS7 - Logging (Managed Server) Service

Overview

Table 3.1562. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.22.1, “JBossAS7 - Async Handler (Managed Server) Service”
Section 3.3.2.4.22.2, “JBossAS7 - Console Handler (Managed Server) Service”
Section 3.3.2.4.22.3, “JBossAS7 - Custom Handler (Managed Server) Service”
Section 3.3.2.4.22.4, “JBossAS7 - File Handler (Managed Server) Service”
Section 3.3.2.4.22.5, “JBossAS7 - Logger (Managed Server) Service”
Section 3.3.2.4.22.6, “JBossAS7 - Periodic Rotating File Handler (Managed Server) Service”
Section 3.3.2.4.22.7, “JBossAS7 - Size Rotating File Handler (Managed Server) Service”

Connection Properties

Table 3.1563.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1564.
Name	Description	Required	Internal Name
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Handlers	The Handlers associated with this Logger.	yes	handlers

Note

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

Operations

none

Package Types

none

3.3.2.4.22.1. JBossAS7 - Async Handler (Managed Server) Service

Overview

Table 3.1565. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1566.
Name	Description	Required	Internal 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.1567.
Name	Description	Required	Internal Name
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Overflow Action	Specify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK.	yes	overflow-action
Queue Length	The queue length to use before flushing writing	yes	queue-length
Subhandlers	The Handlers associated with this async handler.	no	subhandlers

Note

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

Operations

none

Package Types

none

3.3.2.4.22.2. JBossAS7 - Console Handler (Managed Server) Service

Overview

Table 3.1568. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1569.
Name	Description	Required	Internal 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.1570.
Name	Description	Required	Internal Name
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Target	Defines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR. The default value is System.out.	no	target

Note

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

Operations

none

Package Types

none

3.3.2.4.22.3. JBossAS7 - Custom Handler (Managed Server) Service

Overview

Table 3.1571. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1572.
Name	Description	Required	Internal 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.1573.
Name	Description	Required	Internal Name
Class	The logging handler class to be used.	yes	class
Encoding	The character encoding used by this Handler.	no	encoding
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Module	The module that the logging handler depends on.	yes	module
Properties		yes	properties

Note

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

Operations

none

Package Types

none

3.3.2.4.22.4. JBossAS7 - File Handler (Managed Server) Service

Overview

Table 3.1574. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1575.
Name	Description	Required	Internal 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.1576.
Name	Description	Required	Internal Name
Append	Specify whether to append to the target file. The default value is true.	no	append
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
File	The file description consisting of the path and optional relative to path.	no	file
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level

Note

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

Operations

none

Package Types

none

3.3.2.4.22.5. JBossAS7 - Logger (Managed Server) Service

Overview

Table 3.1577. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1578.
Name	Description	Required	Internal 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.1579.
Name	Description	Required	Internal Name
Handlers	The Handlers associated with this Logger.	no	handlers
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Use Parent Handlers	Specifies whether or not this logger should send its output to it's parent Logger. The default value is true.	no	use-parent-handlers

Note

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

Operations

none

Package Types

none

3.3.2.4.22.6. JBossAS7 - Periodic Rotating File Handler (Managed Server) Service

Overview

Table 3.1580. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1581.
Name	Description	Required	Internal 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.1582.
Name	Description	Required	Internal Name
Append	Specify whether to append to the target file. The default value is true.	no	append
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
File	The file description consisting of the path and optional relative to path.	no	file
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Suffix	Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.	yes	suffix

Note

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

Operations

none

Package Types

none

3.3.2.4.22.7. JBossAS7 - Size Rotating File Handler (Managed Server) Service

Overview

Table 3.1583. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1584.
Name	Description	Required	Internal 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.1585.
Name	Description	Required	Internal Name
Append	Specify whether to append to the target file. The default value is true.	no	append
Autoflush	Automatically flush after each write. The default value is true.	no	autoflush
Encoding	The character encoding used by this Handler.	no	encoding
File	The file description consisting of the path and optional relative to path.	no	file
Formatter	Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n.	no	formatter
Level	The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.	no	level
Max Backup Index	The maximum number of backups to keep. The default value is 1.	yes	max-backup-index
Rotate Size	The size at which to rotate the log file. The default value is 2m.	yes	rotate-size

Note

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

Operations

none

Package Types

none

3.3.2.4.23. JBossAS7 - JVM Service

Overview

Table 3.1586. Overview
Description:	Information about the underlying JVM
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.23.1, “JBossAS7 - Operating System Service”
Section 3.3.2.4.23.2, “JBossAS7 - Memory Service”
Section 3.3.2.4.23.3, “JBossAS7 - Runtime Service”
Section 3.3.2.4.23.4, “JBossAS7 - Threading Service”
Section 3.3.2.4.23.5, “JBossAS7 - Garbage Collector Service”
Section 3.3.2.4.23.6, “JBossAS7 - Memory Pool Service”

Connection Properties

Table 3.1587.
Name	Description	Required	Internal 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.3.2.4.23.1. JBossAS7 - Operating System Service

Overview

Table 3.1588. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1589.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1590. Metrics
Name	Type	Description	Internal Name
Available Processors	measurement	The number of processors available to the Java virtual machine.	available-processors
System Load Average	measurement	The 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.3.2.4.23.2. JBossAS7 - Memory Service

Overview

Table 3.1591. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1592.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1593. Metrics
Name	Type	Description	Internal Name
Object Pending Finalization Count	measurement	The approximate number of objects for which finalization is pending.	object-pending-finalization-count
Initial heap usage	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	heap-memory-usage:init
Used heap	measurement	The amount of used memory in bytes.	heap-memory-usage:used
Committed heap	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	heap-memory-usage:committed
Maximum heap usage	measurement	The maximum amount of memory in bytes that can be used for memory management.	heap-memory-usage:max
Initial non-heap usage	measurement	The 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 memory	measurement	The amount of used memory in bytes.	non-heap-memory-usage:used
Committed non-heap memory	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	non-heap-memory-usage:committed
Maximum non-heap usage	measurement	The 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.1594. Metrics
Name	Description
Trigger GC	Runs the garbage collector.

Package Types

none

3.3.2.4.23.3. JBossAS7 - Runtime Service

Overview

Table 3.1595. Overview
Description:
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1596.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1597. Metrics
Name	Type	Description	Internal Name
Uptime	measurement	The 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.3.2.4.23.4. JBossAS7 - Threading Service

Overview

Table 3.1598. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1599.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1600. Metrics
Name	Type	Description	Internal Name
Thread Count	measurement	The current number of live threads including both daemon and non-daemon threads.	thread-count
Peak Thread Count	measurement	The peak live thread count since the Java virtual machine started or peak was reset.	peak-thread-count
Total Started Thread Count	measurement	The total number of threads created and also started since the Java virtual machine started.	total-started-thread-count
Daemon Thread Count	measurement	The current number of live daemon threads.	daemon-thread-count
Current Thread Cpu Time	measurement	The 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 Time	measurement	The 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.1601.
Name	Description	Required	Internal Name
Thread Contention Monitoring Enabled	Whether thread contention monitoring is enabled.	no	thread-contention-monitoring-enabled
Thread Cpu Time Enabled	Whether thread CPU time measurement is enabled.	no	thread-cpu-time-enabled
Thread Contention Monitoring Supported	Whether the Java virtual machine supports thread contention monitoring.	no	thread-contention-monitoring-supported
Thread Cpu Time Supported	Whether the Java virtual machine implementation supports CPU time measurement for any thread.	no	thread-cpu-time-supported
Current Thread Cpu Time Supported	Whether the Java virtual machine supports CPU time measurement for the current thread.	no	current-thread-cpu-time-supported
Object Monitor Usage Supported	Whether the Java virtual machine supports monitoring of object monitor usage.	no	object-monitor-usage-supported
Synchronizer Usage Supported	Whether 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.1602. Metrics
Name	Description
Dump All Threads	Returns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked Threads	Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked Threads	Finds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu Time	Returns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread Info	Returns 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 Infos	Returns the thread info for each thread whose ID is in the input list.
Get Thread User Time	Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread Count	Resets the peak thread count to the current number of live threads.
Get All thread ids	Get 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.3.2.4.23.5. JBossAS7 - Garbage Collector Service

Overview

Table 3.1603. Overview
Description:	Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.23.5.1, “JBossAS7 - Garbage Collector Resource Service”

Connection Properties

Table 3.1604.
Name	Description	Required	Internal 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.3.2.4.23.5.1. JBossAS7 - Garbage Collector Resource Service

Overview

Table 3.1605. Overview
Description:	The management interface for one of the garbage collectors in the Java virtual machine.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1606.
Name	Description	Required	Internal 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.1607. Metrics
Name	Type	Description	Internal Name
Collection Count	measurement	The total number of collections that have occurred.	collection-count
Collection Count per Minute	measurement	The total number of collections that have occurred.	collection-count
Collection Time	measurement	The approximate accumulated collection elapsed time in milliseconds.	collection-time
Collection Time per Minute	measurement	The approximate accumulated collection elapsed time in milliseconds.	collection-time
Name	trait	The name representing this garbage collector	name
Valid	trait	Whether 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.1608.
Name	Description	Required	Internal Name
Memory Pool Names	The 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.3.2.4.23.6. JBossAS7 - Memory Pool Service

Overview

Table 3.1609. Overview
Description:	Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.23.6.1, “JBossAS7 - Memory Pool Resource Service”

Connection Properties

Table 3.1610.
Name	Description	Required	Internal 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.3.2.4.23.6.1. JBossAS7 - Memory Pool Resource Service

Overview

Table 3.1611. 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:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1612.
Name	Description	Required	Internal 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.1613. Metrics
Name	Type	Description	Internal Name
Collection Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	collection-usage:init
Collection Usage - Used	measurement	The amount of used memory in bytes.	collection-usage:used
Collection Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	collection-usage:committed
Collection Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	collection-usage:max
Collection Usage Threshold Count	measurement	The 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 Exceeded	trait	Whether 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 Supported	trait	Whether this memory pool supports a collection usage threshold.	collection-usage-threshold-supported
Name	trait	The name representing this memory pool.	name
Peak Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	peak-usage:init
Peak Usage - Used	measurement	The amount of used memory in bytes.	peak-usage:used
Peak Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	peak-usage:committed
Peak Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	peak-usage:max
Type	trait	The type of this memory pool.	type
Usage - Init	measurement	The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.	usage:init
Usage - Used	measurement	The amount of used memory in bytes.	usage:used
Usage - Committed	measurement	The amount of memory in bytes that is committed for the Java virtual machine to use.	usage:committed
Usage - Max	measurement	The maximum amount of memory in bytes that can be used for memory management.	usage:max
Usage Threshold Count	measurement	The 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 Exceeded	trait	Whether 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 Supported	trait	Whether this memory pool supports usage threshold.	usage-threshold-supported
Valid	trait	Whether 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.1614.
Name	Description	Required	Internal Name
Collection Usage Threshold	The 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 Names	The names of the memory managers that manage this memory pool.	yes	memory-manager-names
Usage Threshold	The 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.1615. Metrics
Name	Description
Reset Peak Usage	Resets the peak memory usage statistic of this memory pool to the current memory usage.

Package Types

none

3.3.2.4.24. JBossAS7 - Datasources (Managed) Service

Overview

Table 3.1616. Overview
Description:	Datasources subsystem for Managed servers.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.24.1, “JBossAS7 - DataSource (Managed) Service”
Section 3.3.2.4.24.2, “JBossAS7 - XADataSource (Managed) Service”

Connection Properties

Table 3.1617.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

Table 3.1618.
Name	Description	Required	Internal Name
Available drivers		yes	*4

Note

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

Operations

none

Package Types

none

3.3.2.4.24.1. JBossAS7 - DataSource (Managed) Service

Overview

Table 3.1619. Overview
Description:	A non-XA data source
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1620.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1621. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.1622.
Name	Description	Required	Internal Name
Connection Property		no	*1
Connection Url	The JDBC driver connection URL	yes	connection-url
Driver Name	Name of the (existing) JDBC driver to use	yes	driver-name
Driver Class	The fully qualified name of the JDBC driver class	no	driver-class
Jndi Name	Specifies the JNDI name for the datasource	yes	jndi-name
Driver	Defines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class	no	driver
User Name	Specify the username used when creating a new connection.	no	user-name
Password	Specify the password used when creating a new connection.	no	password
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool.	no	new-connection-sql
Url Delimiter	Specifies the delimiter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Java Context	Setting this to false will bind the DataSource into global JNDI;	no	use-java-context
Enabled	Specifies if the datasource should be enabled	no	enabled
Max Pool Size	The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool.	no	max-pool-size
Min Pool Size	The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection.	no	min-pool-size
Pool Prefill	Whether to attempt to prefill the connection pool. Changing this value require a server restart.	no	pool-prefill
Pool Use Strict Min	Define if the min-pool-size should be considered a strictly.	no	pool-use-strict-min
Security Domain	Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute.	no	security-domain
Reauth Plugin Class Name	re-authentication plugin implementation provided for specific purpose (i.e vendor)	no	reauth-plugin-class-name
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Share Prepared Statements	Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement	no	share-prepared-statements
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed	no	track-statements
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.	no	allocation-retry
Allocation Retry Wait Millis	Indicates the time in milliseconds to wait between retrying to allocate a connection.	no	allocation-retry-wait-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time.	no	blocking-timeout-wait-millis
Idle Timeout Minutes	The idle-timeout-minutes elements indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart.	no	idle-timeout-minutes
Query Timeout	Any configured query timeout in seconds The default is no timeout	no	query-timeout
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction.	no	set-tx-query-timeout
Transaction Isolation	Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels.	no	transaction-isolation
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.	no	check-valid-connection-sql
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred	no	exception-sorter-class-name
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present.	no	valid-connection-checker-class-name
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart.	no	background-validation-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart.	no	background-validation
Use Fast Fail	Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)	no	use-fast-fail
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation	no	validate-on-match
Spy	whatever spy or not the jdbc connection	no	spy
Use Ccm	Enable the use of a cached connection manager	no	use-ccm

Note

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

Operations

Table 3.1623. Metrics
Name	Description
Flush All Connection In Pool	Flushes the pool for all connections
Flush Idle Connection In Pool	Flushes the pool for idle connections
Test Connection In Pool	Tests if a connection can be obtained

Package Types

none

3.3.2.4.24.2. JBossAS7 - XADataSource (Managed) Service

Overview

Table 3.1624. Overview
Description:	An XA data source
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1625.
Name	Description	Required	Internal Name
Path		yes	path

Note

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

Metrics

Table 3.1626. Metrics
Name	Type	Description	Internal Name
Prepared Statement Cache Current Size	measurement	The number of prepared and callable statements currently cached in the statement cache	PreparedStatementCacheCurrentSize
Prepared Statement Cache Miss Count	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per Minute	measurement	The number of times that a statement request could not be satisfied with a statement from the cache	PreparedStatementCacheMissCount
Prepared Statement Cache Add Count	measurement	The number of statements added to the statement cache	PreparedStatementCacheAddCount
Prepared Statement Cache Access Count	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per Minute	measurement	The number of times that the statement cache was accessed	PreparedStatementCacheAccessCount
Prepared Statement Cache Delete Count	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per Minute	measurement	The number of statements discarded from the cache	PreparedStatementCacheDeleteCount
Prepared Statement Cache Hit Count	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per Minute	measurement	The number of times that statements from the cache were used	PreparedStatementCacheHitCount
Active Count	measurement	The active count	ActiveCount
Available Count	measurement	The available count	AvailableCount
Average Blocking Time	measurement	The average time spent blocking for a connection	AverageBlockingTime
Average Creation Time	measurement	The average time spent creating a physical connection	AverageCreationTime
Created Count	measurement	The created count	CreatedCount
Created Count per Minute	measurement	The created count	CreatedCount
Destroyed Count	measurement	The destroyed count	DestroyedCount
Destroyed Count per Minute	measurement	The destroyed count	DestroyedCount
Max Creation Time	measurement	The maximum time for creating a physical connection	MaxCreationTime
Max Used Count	measurement	The maximum number of connections used	MaxUsedCount
Max Wait Time	measurement	The maximum wait time for a connection	MaxWaitTime
Timed Out	measurement	The timed out count	TimedOut
Timed Out per Minute	measurement	The timed out count	TimedOut
Total Creation Time	measurement	The total time spent creating physical connections	TotalCreationTime
Total Creation Time per Minute	measurement	The total time spent creating physical connections	TotalCreationTime
Total Blocking Time	measurement	The total blocking time	TotalBlockingTime
Total Blocking Time per Minute	measurement	The total blocking time	TotalBlockingTime
Connection Available?	trait	Connection Available?	connectionAvailable
Min Pool Size setting	measurement	The min pool size setting	min-pool-size
Max Pool Size setting	measurement	The max pool size setting	max-pool-size

Note

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

Configuration Properties

Table 3.1627.
Name	Description	Required	Internal Name
Properties		no	*2
Xa Datasource Class	The fully qualified name of the javax.sql.XADataSource implementation	yes	xa-datasource-class
Jndi Name	Specifies the JNDI name for the datasource	yes	jndi-name
Driver Name	Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit	yes	driver-name
User Name	Specify the username used when creating a new connection.	no	user-name
Password	Specify the password used when creating a new connection.	no	password
New Connection Sql	Specifies an SQL statement to execute whenever a connection is added to the connection pool.	no	new-connection-sql
Url Delimiter	Specifies the delimiter for URLs in connection-url for HA datasources	no	url-delimiter
Url Selector Strategy Class Name	A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy	no	url-selector-strategy-class-name
Use Java Context	Setting this to false will bind the DataSource into global JNDI;	no	use-java-context
Enabled	Specifies if the datasource should be enabled	no	enabled
Max Pool Size	The max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool.	no	max-pool-size
Min Pool Size	The min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection.	no	min-pool-size
Pool Prefill	Whether to attempt to prefill the connection pool. Changing this value require a server restart.	no	pool-prefill
Pool Use Strict Min	Define if the min-pool-size should be considered a strictly.	no	pool-use-strict-min
Interleaving	An element to enable interleaving for XA connection factories	no	interleaving
No Tx Separate Pool	Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context	no	no-tx-separate-pool
Pad Xid	Should the Xid be padded	no	pad-xid
Same Rm Override	The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false	no	same-rm-override
Wrap Xa Datasource	Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance	no	wrap-xa-datasource
Security Domain	Indicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute.	no	security-domain
Recovery Plugin Class Name	recovery plugin implementation provided for specific purpose (i.e vendor)	no	recovery-plugin-class-name
Reauth Plugin Class Name	re-authentication plugin implementation provided for specific purpose (i.e vendor)	no	reauth-plugin-class-name
Flush Strategy	Specifies how the pool should be flush in case of an error.	no	flush-strategy
Prepared Statements Cache Size	The number of prepared statements per connection in an LRU cache	no	prepared-statements-cache-size
Share Prepared Statements	Whether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement	no	share-prepared-statements
Track Statements	Whether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed	no	track-statements
Allocation Retry	The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.	no	allocation-retry
Allocation Retry Wait Millis	he allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection.	no	allocation-retry-wait-millis
Blocking Timeout Wait Millis	The blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time.	no	blocking-timeout-wait-millis
Idle Timeout Minutes	The idle-timeout-minutes elements indicates the maximum time in minutes a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart.	no	idle-timeout-minutes
Query Timeout	Any configured query timeout in seconds The default is no timeout	no	query-timeout
Use Try Lock	Any configured timeout for internal locks on the resource adapter objects in seconds	no	use-try-lock
Set Tx Query Timeout	Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction.	no	set-tx-query-timeout
Transaction Isolation	Set java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels.	no	transaction-isolation
Check Valid Connection Sql	Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.	no	check-valid-connection-sql
Exception Sorter Class Name	An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred	no	exception-sorter-class-name
Stale Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException	no	stale-connection-checker-class-name
Valid Connection Checker Class Name	An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present.	no	valid-connection-checker-class-name
Background Validation Millis	The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart.	no	background-validation-millis
Background Validation	An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart.	no	background-validation
Use Fast Fail	Whether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)	no	use-fast-fail
Validate On Match	The validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation	no	validate-on-match
Xa Resource Timeout	Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds	no	xa-resource-timeout
Spy	whatever spy or not the jdbc connection	no	spy
Use Ccm	Enable the use of a cached connection manager	no	use-ccm
Recovery Username	username used to try connection recovery	no	recovery-username
Recovery Password	password used to try connection recovery	no	recovery-password
Recovery Security Domain	security-domain used to try connection recovery	no	recovery-security-domain
No Recovery	if true no recovery are tried for this connection pool	no	no-recovery

Note

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

Operations

Table 3.1628. Metrics
Name	Description
Flush All Connection In Pool	Flushes the pool for all connections
Flush Idle Connection In Pool	Flushes the pool for idle connections
Test Connection In Pool	Tests if a connection can be obtained

Package Types

none

3.3.2.4.25. JBossAS7 - JVM Definition Service

Overview

Table 3.1629. Overview
Description:	A JVM definition that can override host and server group level definitions with the same name
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1630.
Name	Description	Required	Internal 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.1631.
Name	Description	Required	Internal Name
Base Definition	The definition from host level to use/override	yes	baseDefinition
Agent Lib	The JVM agent lib.	no	agent-lib
Agent Path	The JVM agent path.	no	agent-path
Env Classpath Ignored	Ignore the environment classpath.	no	env-classpath-ignored
Environment Variables	The JVM environment variables.	no	environment-variables
Heap Size	The initial heap size allocated by the JVM.	no	heap-size
Java Agent	The java agent.	no	java-agent
Java Home	The java home	no	java-home
Jvm Options	The JVM options. Those can not be changed after initial creation of the definition.	no	jvm-options
Max Heap Size	The maximum heap size that can be allocated by the JVM.	no	max-heap-size
Max Permgen Size	The maximum size of the permanent generation.	no	max-permgen-size
Permgen Size	The initial permanent generation size.	no	permgen-size
Stack Size	The JVM stack size settings.	no	stack-size
Type	The JVM type can be either SUN or IBM	no	type

Note

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

Operations

none

Package Types

none

3.3.2.4.26. JBossAS7 - Transactions Subsystem (Managed) Service

Overview

Table 3.1632. Overview
Description:	The transactions subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.26.1, “JBossAS7 - Log Store (Managed) Service”

Connection Properties

Table 3.1633.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

Table 3.1634. Metrics
Name	Type	Description	Internal Name
Number Of Nested Transactions	measurement	The total number of nested (sub) transactions created.	number-of-nested-transactions
Number Of Nested Transactions per Minute	measurement	The total number of nested (sub) transactions created.	number-of-nested-transactions
Number Of Timed Out Transactions	measurement	The number of transactions that have rolled back due to timeout.	number-of-timed-out-transactions
Number Of Timed Out Transactions per Minute	measurement	The number of transactions that have rolled back due to timeout.	number-of-timed-out-transactions
Number Of Committed Transactions	measurement	The number of committed transactions.	number-of-committed-transactions
Number Of Committed Transactions per Minute	measurement	The number of committed transactions.	number-of-committed-transactions
Number Of Transactions	measurement	The total number of transactions (top-level and nested) created	number-of-transactions
Number Of Transactions per Minute	measurement	The total number of transactions (top-level and nested) created	number-of-transactions
Number Of Heuristics	measurement	The number of transactions which have terminated with heuristic outcomes.	number-of-heuristics
Number Of Heuristics per Minute	measurement	The number of transactions which have terminated with heuristic outcomes.	number-of-heuristics
Number Of Aborted Transactions	measurement	The number of aborted (i.e. rolledback) transactions.	number-of-aborted-transactions
Number Of Aborted Transactions per Minute	measurement	The number of aborted (i.e. rolledback) transactions.	number-of-aborted-transactions
Number Of Inflight Transactions	measurement	The number of transactions that have begun but not yet terminated.	number-of-inflight-transactions
Number Of Inflight Transactions per Minute	measurement	The number of transactions that have begun but not yet terminated.	number-of-inflight-transactions
Number Of Application Rollbacks	measurement	The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.	number-of-application-rollbacks
Number Of Application Rollbacks per Minute	measurement	The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.	number-of-application-rollbacks
Number Of Resource Rollbacks	measurement	The number of transactions that rolled back due to resource (participant) failure.	number-of-resource-rollbacks
Number Of Resource Rollbacks per Minute	measurement	The number of transactions that rolled back due to resource (participant) failure.	number-of-resource-rollbacks

Note

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

Configuration Properties

none

Operations

none

Package Types

none

3.3.2.4.26.1. JBossAS7 - Log Store (Managed) Service

Overview

Table 3.1635. Overview
Description:	Representation of the transaction logging storage mechanism.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.26.1.1, “JBossAS7 - Transactions (Managed) Service”

Connection Properties

Table 3.1636.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.1637.
Name	Description	Required	Internal Name
Type	Specifies the implementation type of the logging store.	no	type

Note

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

Operations

none

Package Types

none

3.3.2.4.26.1.1. JBossAS7 - Transactions (Managed) Service

Overview

Table 3.1638. Overview
Description:	The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.4.26.1.1.1, “JBossAS7 - Participants (Managed) Service”

Connection Properties

Table 3.1639.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.1640.
Name	Description	Required	Internal Name
Age In Seconds	The time since this transaction was prepared or when the recovery system last tried to recover it.	no	age-in-seconds
Id	The id of this transaction.	no	id
Jmx Name	The JMX name of this transaction.	no	jmx-name
Type	The type name under which this record is stored.	no	type

Note

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

Operations

none

Package Types

none

3.3.2.4.26.1.1.1. JBossAS7 - Participants (Managed) Service

Overview

Table 3.1641. Overview
Description:	The resources that did work in a transaction.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1642.
Name	Description	Required	Internal 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

none

Configuration Properties

Table 3.1643.
Name	Description	Required	Internal Name
Eis Product Name	The JCA enterprise information system's product name.	no	eis-product-name
Eis Product Version	The JCA enterprise information system's product version	no	eis-product-version
Jmx Name	The JMX name of this participant.	no	jmx-name
Jndi Name	JNDI name of this participant.	no	jndi-name
Status	Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).	no	status
Type	The type name under which this record is stored.	no	type

Note

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

Operations

none

Package Types

none

3.3.2.4.27. JBossAS7 - JDR Service

Overview

Table 3.1644. Overview
Description:	JBoss Diagnostic Reporter (JDR) Subsystem.
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1645.
Name	Description	Required	Internal Name
Path		yes	path
Managed Runtime		yes	managedRuntime

Note

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

Metrics

none

Configuration Properties

none

Operations

Table 3.1646. Metrics
Name	Description
Generate JDR Report	Request the generation of a JDR report.

Package Types

none

3.3.2.5. JBossAS7 - Profile Service

Overview

Table 3.1647. Overview
Description:	A profile in a domain. Profiles are assigned to server groups.
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.5.1, “JBossAS7 - ModCluster Domain Service”
Section 3.3.2.5.2, “JBossAS7 - Naming (Profile) Service”
Section 3.3.2.5.3, “JBossAS7 - JBossWeb (Profile) Service”
Section 3.3.2.5.4, “JBossAS7 - JCA (Profile) Service”
Section 3.3.2.5.5, “JBossAS7 - Osgi (Profile) Service”
Section 3.3.2.5.6, “JBossAS7 - Resource Adapters (Profile) Service”
Section 3.3.2.5.7, “JBossAS7 - EJB3 (Profile) Service”
Section 3.3.2.5.8, “JBossAS7 - Threads (Profile) Service”
Section 3.3.2.5.9, “JBossAS7 - Security (Profile) Service”
Section 3.3.2.5.10, “JBossAS7 - Messaging (Profile) Service”
Section 3.3.2.5.11, “JBossAS7 - Datasources (Profile) Service”
Section 3.3.2.5.12, “JBossAS7 - Logging Service”
Section 3.3.2.5.13, “JBossAS7 - Webservices Service”
Section 3.3.2.5.14, “JBossAS7 - Transactions Subsystem (Profile) Service”
Section 3.3.2.5.15, “JBossAS7 - JacORB Service”
Section 3.3.2.5.16, “JBossAS7 - JAXR Service”
Section 3.3.2.5.17, “JBossAS7 - JPA Service”
Section 3.3.2.5.18, “JBossAS7 - CMP Service”
Section 3.3.2.5.19, “JBossAS7 - EE Service”
Section 3.3.2.5.20, “JBossAS7 - JMX Service”
Section 3.3.2.5.21, “JBossAS7 - Infinispan Service”
Section 3.3.2.5.22, “JBossAS7 - JGroups Service”
Section 3.3.2.5.23, “JBossAS7 - Remoting Service”
Section 3.3.2.5.24, “JBossAS7 - Mail Service”

Connection Properties

Table 3.1648.
Name	Description	Required	Internal 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.3.2.5.1. JBossAS7 - ModCluster Domain Service

Overview

Table 3.1649. Overview
Description:	Mod_cluster support
Singleton:	yes
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.5.1.1, “JBossAS7 - Domain Service Configuration Service”

Connection Properties

Table 3.1650.
Name	Description	Required	Internal 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.3.2.5.1.1. JBossAS7 - Domain Service Configuration Service

Overview

Table 3.1651. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.5.1.1.1, “JBossAS7 - Domain Dynamic Load Provider Service”
Section 3.3.2.5.1.1.2, “JBossAS7 - Domain Ssl Service”

Connection Properties

Table 3.1652.
Name	Description	Required	Internal 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.1653.
Name	Description	Required	Internal Name
Proxy List	List of proxies, Format (hostname:port) separated with commas.	no	proxy-list
Proxy Url	Base URL for MCMP requests.	no	proxy-url
Advertise Socket	Name of Socket binding to use for the Advertise socket.	no	advertise-socket
Advertise	Use Advertise logic or not.	no	advertise
Advertise Security Key	String containing the security key for the Advertise logic.	no	advertise-security-key
Balancer	The balancer name.	no	balancer
Connector	Name of the web connector used to communicate with the load balancer.	yes	connector
Load Balancing Group	loadBalancingGroup name.	no	load-balancing-group
Excluded Contexts	List of contexts mod_cluster should ignore, Format String separated with commas.	no	excluded-contexts
Auto Enable Contexts	Enable contexts even if disabled in mod_cluster_manger (httpd).	no	auto-enable-contexts
Sticky Session	Use sticky sessions for requests.	no	sticky-session
Sticky Session Remove	Remove session information on failover.	no	sticky-session-remove
Sticky Session Force	Don't failover a request with session information.	no	sticky-session-force
Worker Timeout	Timeout to wait in httpd for an available worker to process the requests.	no	worker-timeout
Max Attempts	Max attempts to process an idempotent request.	no	max-attempts
Flush Packets	Enables/disables packet flushing in httpd.	no	flush-packets
Flush Wait	Time to wait before flushing packets in httpd.	no	flush-wait
Ping	Time (in seconds) in which to wait for a pong answer to a ping.	no	ping
Smax	Soft maximum idle connection count in httpd	no	smax
Ttl	Time to live (in seconds) for idle connections above smax	no	ttl
Node Timeout	Timeout (in seconds) for proxy connections to a node.	no	node-timeout
Stop Context Timeout	Max time to wait for context to process pending requests.	no	stop-context-timeout
Socket Timeout	Timeout 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.1654. Metrics
Name	Description
Add Custom Metric	Add new custom metric to the load balancer provider.
Add Metric	Add new metric to the load balancer provider.
Remove Custom Metric	Remove a custom metric from the load balancer provider.
Remove Metric	Add new metric to the load balancer provider.

Package Types

none

3.3.2.5.1.1.1. JBossAS7 - Domain Dynamic Load Provider Service

Overview

Table 3.1655. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

Section 3.3.2.5.1.1.1.1, “JBossAS7 - Domain Custom Load Metric Service”
Section 3.3.2.5.1.1.1.2, “JBossAS7 - Domain Load Metric Service”

Connection Properties

Table 3.1656.
Name	Description	Required	Internal 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.1657.
Name	Description	Required	Internal Name
Decay	Decay. The default value is 2.	no	decay
History	History. 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.3.2.5.1.1.1.1. JBossAS7 - Domain Custom Load Metric Service

Overview

Table 3.1658. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1659.
Name	Description	Required	Internal 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.1660.
Name	Description	Required	Internal Name
Capacity	Capacity of the metric. The default value is 1	no	capacity
Class	Class name of the custom metric.	yes	class
Weight	Weight 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.3.2.5.1.1.1.2. JBossAS7 - Domain Load Metric Service

Overview

Table 3.1661. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1662.
Name	Description	Required	Internal 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.1663.
Name	Description	Required	Internal Name
Capacity	Capacity of the metric. The default value is 1.	no	capacity
Type	Type of the metric	yes	type
Weight	Weight 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.3.2.5.1.1.2. JBossAS7 - Domain Ssl Service

Overview

Table 3.1664. Overview
Description:
Singleton:	no
Plugin:	JBossAS7

Child Resource Types

none

Connection Properties

Table 3.1665.
Name	Description	Required	Internal 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.1666.
Name	Description	Required	Internal Name