urn:jboss:domain:10.0

Name	Type	Default	Description
name	string	Unnamed Domain	The name to use for the domain controller. Useful for administrators who need to work with multiple domains.
domain-organization	string		The name of the organization running this domain.

Name	Type	Default	Description
name	string		Name of the profile
includes			A profile may include another profile. Overriding of included profiles is not supported.

Name	Type	Default	Description
name	string		The name of the server group
profile	string		The name of the profile this server is running.
management-subsystem-endpoint	boolean	false	Set to true to have servers belonging to the server group connect back to the host controller using the endpoint from their remoting subsystem. The subsystem must be preset for this to work.

Name	Type	Default	Description
ref	string		The socket group to use for the server group or server.
port-offset	int	0	Increment to apply to the base port values defined in the referenced socket group to derive the values to use on this server.
default-interface	string		Name of an interface that should be used as the interface for any sockets that do not explicitly declare one, overiding the one defined in the socket-binding-group referenced.

Root element for a document configuring a host controller and the group of servers under the control of that host controller. The standard usage would be for a domain to have one such host controller on each physical (or virtual) host machine. Emphasis in this document is on enumerating the servers, configuring items that are specific to the host environment (e.g. IP addresses), and on any server-specific configuration settings.

Name	Type	Default	Description
name	string		The name to use for this host's host controller. Must be unique across the domain. If not set, defaults to the runtime value "HOSTNAME" or "COMPUTERNAME" environment variables, or, if neither environment variable is present, to the value of InetAddress.getLocalHost().getHostName(). If the special value "jboss.domain.uuid" is used, a java.util.UUID will be created and used, based on the value of InetAddress.getLocalHost().
organization	string		The name of the organization running this host.

extensions?

Contains a list of extension modules.

extension+

A module that extends the standard capabilities of a domain or a standalone server.

Name	Type	Default	Description
module	string		The name of the module

system-properties?

property+

Name	Type	Default	Description
boot-time	boolean	true

Name	Type	Default	Description
name	FIXME
value	FIXME

paths?

A list of named filesystem paths.

path*

A named filesystem path.

Name	Type	Description
name	string	The name of the path. Cannot be one of the standard fixed paths provided by the system: jboss.home.dir - 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 Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.
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. Note relative path declarations have to use '/' as file separator.
relative-to	string	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.dir - 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.config.dir - directory in which server configuration files are stored. 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.temp.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

vault?

Vault Configuration. If no 'code' and 'module' are supplied the default implementation will be used. If 'code' is specified but no 'module', it will look for the class named by 'specified' in the picketbox module. If 'module' is specified, it will look for the class specified by 'code' in the module specified by 'module'.

Name	Type	Default	Description
code	string
module	string

vault-option*

Name	Type	Default	Description
name	FIXME
value	FIXME

management

The centralized configuration for the management of a Host Controller.

audit-log?

formatters

Declaration of management operation audit logging formatters.

json-formatter

Configuration of a JSON formatter for the audit log.

Name	Type	Default	Description
compact	boolean	false	If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.
escape-new-line	boolean	false	If true will escape all new lines with the ascii code in octal, e.g. #012.
escape-control-characters	boolean	false	If true will escape all control characters (ascii entries with a decimal value less than 32) with the ascii code in octal, e.g.'\n\ becomes '#012'. If this is true, it will override escape-new-line="false"

Shared configuration for audit log formatters..

Name	Type	Default	Description
name	string		The name of the formatter. Must be unique across all types of formatter (there is only the JSON formatter at present but more are planned for the future)
include-date	boolean	true	Whether or not to include the date in the formatted log record
date-format	string	yyyy-MM-dd HH:mm:ss	The date format to use as understood by {@link java.text.SimpleDateFormat}. Will be ignored if include-date="false".
date-separator	string	-	The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".

handlers

Declaration of management operation audit logging handlers.

file-handler

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
rotate-at-startup	boolean		Whether or not should an old log file be rotated during a handler initialization.

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
path	string		The path of the audit log.
relative-to	string		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.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

size-rotating-file-handler

Configuration of a size rotating file handler for the audit log. This writes to a local file, rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups..

Name	Type	Default	Description
rotate-size			The size at which to rotate the log file.
max-backup-index	positiveInteger		The maximum number of backups to keep.

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
path	string		The path of the audit log.
relative-to	string		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.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

periodic-rotating-file-handler

Configuration of a periodic rotating file handler for the audit log. This writes to a local file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

Name	Type	Default	Description
suffix	string		The suffix string in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
path	string		The path of the audit log.
relative-to	string		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.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

syslog-handler

Configuration of a syslog file handler for the audit log on a server. This writes to syslog server.

Name

Type

Default

Description

syslog-format

RFC5424	Format the syslog data according to the RFC-5424 standard
RFC3164	Format the syslog data according to the RFC-3164 standard

RFC5424

The format to use for the syslog messages. See your syslog provider's documentation for what is supported.

max-length

int

The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.

truncate

boolean

true

Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.

facility

KERNEL	0
USER_LEVEL	1
MAIL_SYSTEM	2
SYSTEM_DAEMONS	3
SECURITY	4
SYSLOGD	5
LINE_PRINTER	6
NETWORK_NEWS	7
UUCP	8
CLOCK_DAEMON	9
SECURITY2	10
FTP_DAEMON	11
NTP	12
LOG_AUDIT	13
LOG_ALERT	14
CLOCK_DAEMON2	15
LOCAL_USE_0	16
LOCAL_USE_1	17
LOCAL_USE_2	18
LOCAL_USE_3	19
LOCAL_USE_4	20
LOCAL_USE_5	21
LOCAL_USE_6	22
LOCAL_USE_7	23

USER_LEVEL

The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164. The numerical values in the enumeration entries, is the numerical value as defined in the RFC.

app-name

string

The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

in-memory-handler

Configuration of a in memory handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
max-history	integer	10	The number of logging entries stored in memory.

logger

Declaration of management operation audit logging configuration coming from the model controller core.

Name	Type	Default	Description
log-boot	boolean	false	Whether operations should be logged on boot.
log-read-only	boolean	false	Whether operations that do not modify the configuration or any runtime services should be logged.
enabled	boolean	true	Whether audit logging is enabled.

handlers

References to audit-log-handlers defined in the audit-log-handlers section

handler?

A reference to an audit-log-handler defined in the audit-log-appenders section

Name	Type	Default	Description
name	string

server-logger?

Declaration of management operation audit logging configuration coming from the model controller core.

Name	Type	Default	Description
log-boot	boolean	false	Whether operations should be logged on boot.
log-read-only	boolean	false	Whether operations that do not modify the configuration or any runtime services should be logged.
enabled	boolean	true	Whether audit logging is enabled.

handlers

References to audit-log-handlers defined in the audit-log-handlers section

handler?

A reference to an audit-log-handler defined in the audit-log-appenders section

Name	Type	Default	Description
name	string

management-interfaces

native-interface?

Configuration of a host's exposed native management interface.

socket

Configuration of the socket used by host or standalone server's exposed HTTP management interface.

Name	Type	Default	Description
port	int		Port on which the host's socket for native management communication should be opened.

Configuration of the socket used by host or standalone server's exposed management interface.

Name	Type	Default	Description
interface	string		Network interface on which the host's socket for management communication should be opened.

Name	Type	Default	Description
sasl-authentication-factory	string		The SASL server authentication policy to secure connections upgraded from HTTP.

Name	Type	Default	Description
ssl-context	string		Reference to the SSLContext to use for this management interface. If this is not set then the SSLContext will be obtained from any referenced security-realm.
security-realm	string		The security realm to use for this management interface, the capabilities of the security realm will be queried to identify the authentication mechanism(s) to offer.
sasl-protocol	string	remote	Where Remoting is accepting incomming connections part of the authentication process advertises the name of the protocol in use, by default this is 'remote' but this attribute can be set if an alternative is required.
server-name	string		Where Remoting is accepting incomming connection the initial exchange and the authentication process both advertise the name of the server, by default this is derived from the address Remoting is listening on but this attribute can be set to override the name.

http-interface?

Configuration of a host's exposed HTTP management interface.

Name	Type	Default	Description
console-enabled	boolean	true

socket

Configuration of the socket used by host's exposed HTTP management interface.

Name	Type	Default	Description
secure-interface	string		Network interface on which the host's socket for HTTPS management communication should be opened if a different interface should be used from that specified by the 'interface' attribute. If not specified the interface specified by the 'interface' attribute will be used. Has no effect if the 'secure-port' attribute is not set. If specified with a different value from the 'interface' attribute, redirect of HTTPS requests received on the HTTP socket to the HTTPS address will not be supported. If specified an ssl-context or security-realm will be required to obtain the SSL configuration.

Configuration of the socket used by host or standalone server's exposed HTTP management interface.

Name	Type	Default	Description
port	int		Port on which the host's socket for management communication should be opened. If not specified the port will not be opened.
secure-port	int		Port on which the host's socket for HTTPS management communication should be opened. If not specified the port will not be opened. If specified an ssl-context or security-realm will be required to obtain the SSL configuration.

Configuration of the socket used by host or standalone server's exposed management interface.

Name	Type	Default	Description
interface	string		Network interface on which the host's socket for management communication should be opened.

Name	Type	Default	Description
http-authentication-factory	string		The HTTP authentication factory to use to secure normal HTTP requests.

http-upgrade?

HTTP Upgrade configuration on the management interface.

Name	Type	Default	Description
enabled	boolean	false	Is HTTP Upgrade to 'remote' enabled.
sasl-authentication-factory	string		The SASL authentication policy to secure connections upgraded from HTTP.

Name	Type	Default	Description
ssl-context	string		Reference to the SSLContext to use for this management interface. If this is not set then the SSLContext will be obtained from any referenced security-realm.
security-realm	string		The security realm to use for this management interface, the capabilities of the security realm will be queried to identify the authentication mechanism(s) to offer.
sasl-protocol	string	remote	Where Remoting is accepting incomming connections part of the authentication process advertises the name of the protocol in use, by default this is 'remote' but this attribute can be set if an alternative is required.
server-name	string		Where Remoting is accepting incomming connection the initial exchange and the authentication process both advertise the name of the server, by default this is derived from the address Remoting is listening on but this attribute can be set to override the name.

Domain-wide default configuration settings for the management of standalone servers and a Host Controller.

configuration-changes?

Configuration for the history of configuration changes.

Name	Type	Default	Description
max-history	integer	10	Number of configuration changes that are available in history.

identity?

Definition of the security domain to use to obtain the current identity from.

Name	Type	Default	Description
security-domain	string		Reference to the security domain to use to obtain the current identity.

security-realms?

security-realm+

Configuration of a security realm for securing access to the management interfaces.

Name	Type	Default	Description
name	string		The name of this security-realm, each security-realm must be assigned a unique name.

plug-ins?

List of modules to be searched for supported security realm plug-ins.

plug-in

Name	Type	Default	Description
module	string		The name of the module.

server-identities?

Configuration of the identities that represent the server.

ssl?

Configuration of the SSL identity of this server.

Name	Type	Default	Description
protocol	string	TLS	The protocol to use when creating the SSLContext. Note: This is separate from the enabled protocols on the underlying SSLEngine, to configure those add the engine specific configuration.

engine?

Configuration options specific to the unlerlying SSLEngine created for request handling.

Name	Type	Default	Description
enabled-protocols		TLSv1 TLSv1.1 TLSv1.2	A space separated list of protocols that may be enabled on the SSLEngine handling requests. At runtime the intersection of the available protocols and the protocols specified here will be used, if that results in an empy list an error will be reported.
enabled-cipher-suites			A space separated list of cipher suites that may be enabled on the SSLEngine handling requests. At runtime the intersection of the available suites and the suites specified here will be used, if that results in an empy list an error will be reported.

keystore

An extension of keyStoreType used by realms.

Name	Type	Default	Description
provider	string	JKS	The provider for the store, the default is a file based JKS store.
path	string		The path of the keystore, this is required if the provider is JKS otherwise it will be ignored.
relative-to	string		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.

This is a more complex keystore definition which also allows for an alias and key password to be specified.

Name	Type	Description
alias	string	The alias of the entry to use from the keystore, if specified all remaining entries in the keystore will be ignored. Note: The use of aliases is only available for JKS based stores, for other store types this will be ignored.
key-password	string	The password to use when loading keys from the keystore.
generate-self-signed-certificate-host	string	If this is set and the key store does not exist then a new keystore will be created and a self signed certificate will be generated. The host name for the self signed certificate will be the value of this attribute. This is not intended for production use.

key-password-credential-reference?

Credential reference to be used by as protection parameter when loading keys from the keystore.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

The keystore configuration for the server.

Name	Type	Default	Description
keystore-password	string		The password to open the keystore.

keystore-password-credential-reference?

Credential reference to be used by as protection parameter for the Keystore.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

secret?

Configuration of the secret/password-based identity of this server.

Name	Type	Default	Description
value	string		The secret / password - Base64 Encoded

credential-reference?

Credential to be used by as protection parameter for the Credential Store.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

kerberos?

Configuration of a servers Kerberos identity.

keytab

Reference to an individual keytab. On handling the authentication for an incoming request two pieces of information are known, the protocol and the name of the host this server is acting as. For HTTP requests the protocol will always be HTTP, for requests over Remoting by default the protocol will be 'remote' although this can be overridden. At the time authentication is going to be handled the keytab will be selected as follows: - 1 - Iterate the list of keytabs and identity one where the for-hosts attribute contains an entry matching protocol/hostname. 2 - Iterate the list of keytabs and identify one where the name of the principal matches matches protocol/hostname. 3 - Iterate the list of keytabs and identity one where the for-hosts attribute contains an entry matching hostname. 4 - Iterate the list of keytabs and identify one where the hostname portion of the principal matches the hostname of the request. 5 - Use the keytab where for-hosts is set to '*'. If no match is found no keytab will be selected and Kerberos will not be available for communication as that host.

Name	Type	Description
path	string	The path of the keytab.
relative-to	string	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.
principal	string	The name of the principal represented by the keytab.
for-hosts		A space separated list of the host names this keytab can be used for. Can also be set to '*' if applicable for all hosts if a better match is not found. If multiple keytabs are defined as handling the same host which one is selected is undefined and subject to change, for predictability you should ensure that no more than one keytab is defined per host.

authentication?

Configuration of the server side authentication mechanisms. Optionally one truststore can be defined and one username/password based store can be defined. Authentication will first attempt to use the truststore and if this is not available will fall back to the username/password authentication. If none of these are specified the only available mechanism will be the local mechanism for the Native interface and the HTTP interface will not be accessible.

truststore?

Configuration of a keystore to use to create a trust manager to verify clients.

An extension of keyStoreType used by realms.

Name	Type	Default	Description
provider	string	JKS	The provider for the store, the default is a file based JKS store.
path	string		The path of the keystore, this is required if the provider is JKS otherwise it will be ignored.
relative-to	string		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 keystore configuration for the server.

Name	Type	Default	Description
keystore-password	string		The password to open the keystore.

keystore-password-credential-reference?

Credential reference to be used by as protection parameter for the Keystore.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

local?

Configuration to enable the local authentication mechanism, if this element is omitted then local authentication will be disabled.

This type definition is used to control the local authentication mechanism.

Name	Type	Default	Description
default-user	string		When using the local mechanism it is optional for the client side to send an authentication user name - this attribute specifies the user name to be assumed if the remote client does not send one.
allowed-users	string		A comma separated list of users that can be specified by the client when connecting using the local authentication mechanism. If a default user has been specified then that user is automatically added to the allowed list. If both default-user and allowed-users are omitted despite the mechanism being enabled no incoming connection attemps using the mechanism will succeed. If any user name should be accepted the value should be set to "*".
skip-group-loading	boolean	false	After authentication has occurred the username of the authenticated user is then passed to the configured authorization mechanism to load the group membership information for the authenticated user. As the local authenitication mechanism is a special case with an artificial identifier for the authenticated user this can cause problems during group loading where a user with the same name does not exist. Setting this attribute to 'false' will disable the loading of groups for the local user.

kerberos?

Configuration to enable Kerberos authentication.

Definition to enable Kerberos for authentication.

Name	Type	Default	Description
remove-realm	boolean	false	When a user is authenticated using Kerberos typically their identity will be represented in the form username@REALM, setting this option to true will strip the @REALM part of the name. This may be desired to bring the names in-line with username/password based authentication if used in parallel.

jaas?

Definition to use a JAAS based configuration for authentication.

Name	Type	Default	Description
name	string		The name identifying the jaas configuration of LoginModules.
assign-groups	boolean	false	When JAAS is delegated to for authentication a user is also assigned a set of roles, if this attribute is set to true then those roles will be assigned to the user a groups.

ldap?

Definition to use LDAP as the user repository.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search for the user.
recursive	boolean	false	Should the search be recursive.
user-dn	string	dn	The name of the attribute which is the users distinguished name.
username-load	string		This attribute is independent of the filtering configuration, if this attribute is set then after the users entry in LDAP is identified this attribute will be read to discover the users actual username. This is optional but could be useful in a few scenarios e.g. authenticate with an e-mail address but be identified by a username, correcting the case of an entered username or even in the future ensuring consistency after a different authentication approach. Note: This value will become the username used for any subsequent group loading.
allow-empty-passwords	boolean	false	Should users be allowed to supply an empty password? Some LDAP servers will allow an anonymous bind so an empty password could appear as a successful authentication even though no password was sent to verify.

cache?

Name	Type	Default	Description
type		by-search-time	The type of cache, by-search-time and the entries are evicted based on search time and search order, by-access-time and the entires are evicted based on the time they were last accessed.
eviction-time	int	900	The time until an entry is evicted from the cache in seconds, a time of <=0 means no eviction based on time. If items are not going to be evicted based on time then max-cache-size should be set otherwise the cache could grow without restriction. Note: The eviction time is handled on a best-efforts basis, during times of many concurrent authentications there could be small delay before the evictions fire.
cache-failures	boolean	false	Should non IO failures be cached? e.g. should searches for a non-existent user be cached to avoid repeating the same search.
max-cache-size	int	0	The maximum number of items to hold in the cache before items are evicted, or <=0 where the size of the cache is unlimited. This value should be higher than the anticipated cache size for current users otherwise items will be continually evicted.

username-filter

Name	Type	Default	Description
attribute	string		The name of the attribute to search for the user, this filter will then perform a simple search where the username entered by the user matches the attribute specified here.

advanced-filter

Name	Type	Default	Description
filter	string		The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.

The base type used for LDAP authentication and authorization definitions.

Name	Type	Default	Description
connection	string		The name of the connection to use to connect to LDAP.

properties?

Declaration of users stored within properties files. The entries within the properties file are username={credentials} with each user being specified on it's own line.

Name	Type	Default	Description
plain-text	boolean	false	Are the credentials within the properties file stored in plain text, if not the {credential} is expected to be the hex encoded Digest hash of 'username : realm : password'.

Declaration of a location of a properties file.

Name	Type	Default	Description
relative-to	string		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.
path	string		The path of the properties file.

users?

A set of users

user+

A single user.

Name	Type	Default	Description
username	string		The users username.

password

plug-in?

This type defines which plug in will be used to handle either the loading of the authentication data or authorization data during the authentication process.

Name

Type

Default

Description

name

string

The short name of the plug-in as already dynamically registered by being referenced in the plug-ins element.

mechanism

DIGEST
PLAIN

DIGEST

By default plug-ins will be assumed to be used with the DIGEST authentication mechanism, this attribute can override the plug-in for use with the PLAIN mechanism.

properties?

The properties to be made available to the plug-in.

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

authorization?

Configuration defining how to load the authorization information for the authenticated user. After a user has been authenticated additional information such as groups or roles can be loaded and associated with the user for subsequent authorization checks, this type is used to define how the roles are loaded.

Name	Type	Default	Description
map-groups-to-roles	boolean	true	The membership information loaded is the authenticated identities group membership, commonly there is a 1:1 mapping between group membership and the applicable roles, this attribute allows for the mapping to be performed automatically.

properties?

Declaration of a location of a properties file.

Name	Type	Default	Description
relative-to	string		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.
path	string		The path of the properties file.

plug-in?

This type defines which plug in will be used to handle either the loading of the authentication data or authorization data during the authentication process.

Name

Type

Default

Description

name

string

The short name of the plug-in as already dynamically registered by being referenced in the plug-ins element.

mechanism

DIGEST
PLAIN

DIGEST

By default plug-ins will be assumed to be used with the DIGEST authentication mechanism, this attribute can override the plug-in for use with the PLAIN mechanism.

properties?

The properties to be made available to the plug-in.

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

ldap?

username-to-dn?

Search definition to locate a user from the supplied username.

Name	Type	Default	Description
force	boolean	false	If the username was already converted to a distinguished name during authentication this attribute forces the search to be repeated before loading group information. This would most likely be required if a different LDAP server was being used to load group information as was used for authentication.

cache?

Name	Type	Default	Description
type		by-search-time	The type of cache, by-search-time and the entries are evicted based on search time and search order, by-access-time and the entires are evicted based on the time they were last accessed.
eviction-time	int	900	The time until an entry is evicted from the cache in seconds, a time of <=0 means no eviction based on time. If items are not going to be evicted based on time then max-cache-size should be set otherwise the cache could grow without restriction. Note: The eviction time is handled on a best-efforts basis, during times of many concurrent authentications there could be small delay before the evictions fire.
cache-failures	boolean	false	Should non IO failures be cached? e.g. should searches for a non-existent user be cached to avoid repeating the same search.
max-cache-size	int	0	The maximum number of items to hold in the cache before items are evicted, or <=0 where the size of the cache is unlimited. This value should be higher than the anticipated cache size for current users otherwise items will be continually evicted.

username-is-dn

username-filter

Name	Type	Default	Description
user-dn-attribute	string	dn	The attribute on the user entry which is their distinguished name.
attribute	string	uid	The name of the attribute to search for the user, this filter will then perform a simple search where the username entered by the user matches the attribute specified here.

Base type of common attributes used for LDAP searches.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search.
recursive	boolean	false	Should the search be recursive.

advanced-filter

Name	Type	Default	Description
user-dn-attribute	string	dn	The attribute on the user entry which is their distinguished name.
filter	string		The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.

Base type of common attributes used for LDAP searches.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search.
recursive	boolean	false	Should the search be recursive.

group-search

Name	Type	Default	Description
group-name		SIMPLE	Defines the form the name of the group should take, either it's simple name or it's complete distringuished name.
iterative	boolean	false	Should any group searching be iterative, i.e. should additional searches be performed to identify the groups that the groups are members of.
group-dn-attribute	string	dn	On the group entry which of it's attributes is it's distingushed name.
group-name-attribute	string	uid	On the group entry which of it's attributes is it's simple name.

cache?

Name	Type	Default	Description
type		by-search-time	The type of cache, by-search-time and the entries are evicted based on search time and search order, by-access-time and the entires are evicted based on the time they were last accessed.
eviction-time	int	900	The time until an entry is evicted from the cache in seconds, a time of <=0 means no eviction based on time. If items are not going to be evicted based on time then max-cache-size should be set otherwise the cache could grow without restriction. Note: The eviction time is handled on a best-efforts basis, during times of many concurrent authentications there could be small delay before the evictions fire.
cache-failures	boolean	false	Should non IO failures be cached? e.g. should searches for a non-existent user be cached to avoid repeating the same search.
max-cache-size	int	0	The maximum number of items to hold in the cache before items are evicted, or <=0 where the size of the cache is unlimited. This value should be higher than the anticipated cache size for current users otherwise items will be continually evicted.

group-to-principal

Group search definition where an attribute on the group references the principal.

Name	Type	Default	Description
search-by		DISTINGUISHED_NAME	Should searching use the simple name or distinguished name of the principal.
prefer-original-connection	boolean	true	After a referral has been followed should the original LDAP connection defined for group loading be used or should the connection from the last referral be used instead. By default each attempt to load a group will revert back to the original connection as defined in the configuration, however setting this attribute to false will cause subsequent searches to use the connection of the last referral.

membership-filter

Name	Type	Default	Description
principal-attribute	string	member	The attribute on the group entry that references the principal.

Base type of common attributes used for LDAP searches.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search.
recursive	boolean	false	Should the search be recursive.

principal-to-group

Group search definition where an attribute on the principal references the group.

Name	Type	Default	Description
group-attribute	string	memberOf	The name of the attribute on the principal that references the group.
prefer-original-connection	boolean	true	After a referral has been followed should the original LDAP connection defined for group loading be used or should the connection from the last referral be used instead. By default each attempt to load a group will revert back to the original connection as defined in the configuration, however setting this attribute to false will cause subsequent searches to use the connection of the last referral.
skip-missing-groups	boolean	false	If an entry references non-existent groups then authentication is aborted due to the inability to query a users complete set of groups, setting this option to true allows for non-existent groups to be silently ignored.
parse-group-name-from-dn	boolean	false	Extract the groupe name from the distinguished name instead of requesting it.

The base type used for LDAP authentication and authorization definitions.

Name	Type	Default	Description
connection	string		The name of the connection to use to connect to LDAP.

outbound-connections?

ldap

The LDAP connection definition.

Name

Type

Default

Description

name

string

The name of this connection.

url

string

The URL to connect to ldap.

search-dn

string

The distinguished name to use when connecting to LDAP to perform searches.

search-credential

string

The credential to use when connecting to perform a search.

security-realm

string

A reference to a security realm to obtain an initialised SSLContext to use when establishing a connection to the LDAP server. The realm referenced here MUST NOT be a realm that is also configured to use this connection.

initial-context-factory

string

com.sun.jndi.ldap.LdapCtxFactory

The initial context factory to establish the LdapContext.

referrals

IGNORE
FOLLOW
THROW

IGNORE

Defines how referrals should be handled if encountered when using this connection, by default they are ignored. If set to FOLLOW then if referrals are encountered using this connection they will automatically be followed. Apart from the alternative location if set to FOLLOW it is assumed the remainder of settings for this connection can be applied to the connection for the referral. Finally if this option is set to THROW an exception is thrown by the connection when referrals are encountered, the security realm will then use information from the Exception to identify an alternative connection to use.

handles-referrals-for

A space seaparated list of URLs that this connection will handle referrals for. Note: Only the prototocol, host and port should be specified in the URLs. The LDAP connections are not ordered so a single URL should only be listed against a single connection, if multpile connections are defined as handling the same URL which connection will be selected is undefined and subject to change.

always-send-client-cert

boolean

false

Where an LDAPS connection is established for the purpose of validating the provided credential by default the local servers certificate is not sent to avoid inadvertently authenticating as the server. This attribute can be set to true to ensure the local servers certificate is always sent where this is required independently of the authentication based on the credential.

properties?

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

search-credential-reference?

The credential reference to use when connecting to perform a search.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

domain-controller

local

discovery-options?

discovery-option?

Name	Type	Description
name	string	The name for this domain controller discovery option.
code	string	The fully qualified class name for the DiscoveryOption implementation.
module	string	The module from which the DiscoveryOption implementation should be loaded. If not provided, the DiscoveryOption implementation must be available from the Host Controller's own module.

property*

Name	Type	Default	Description
name	FIXME
value	FIXME

static-discovery?

Name	Type	Description
name	string	The name for this domain controller discovery option.
protocol		The remote domain controller's protocol.
host	string	The remote domain controller's host name.
port	string	The remote domain controller's port.

remote

Name	Type	Default	Description
protocol			The remote domain controller's protocol. If not set, a discovery option must be provided, or the --cached-dc startup option must be used, or the --admin-only startup option must be used with the 'admin-only-policy' attribute set to a value other than 'fetch-from-master'.
host	string		The remote domain controller's host name. If not set, a discovery option must be provided, or the --cached-dc startup option must be used, or the --admin-only startup option must be used with the 'admin-only-policy' attribute set to a value other than 'fetch-from-master'.
port	integer		The remote domain controller's port. If not set, a discovery option must be provided, or the --cached-dc startup option must be used, or the --admin-only startup option must be used with the 'admin-only-policy' attribute set to a value other than 'fetch-from-master'.
authentication-context	string		Reference to the authentication-context to use when establishing the remote connection.
security-realm	string
username	string
ignore-unused-configuration	boolean		When set to true, this instructs the master Host Controller to not forward configuration and operations for profiles, socket binding groups and server groups which do not affect our servers. Setting to false will ensure that all of this configuration information is copied. Note that using the '--backup' startup option on the command line will set this to false if the value is unspecified in host.xml. If the value is specified in host.xml, then using '--backup' will not override the specified value (for example: setting ignore-unused-configuration="true" and using --backup will not override the value of ignore-unused-configuration, which will remain true). If --backup is not used, this value will be true at runtime.
admin-only-policy		allow-no-config	Policy options for how a slave host controller started in 'admin-only' mode and without the use of the '--cached-dc' startup option should deal with the absence of a local copy of the domain-wide configuration. This question is particularly relevant when fine grained management operation authorization scheme is used, as the configuration for management authorization in a managed domain comes from the domain wide configuration.

ignored-resources*

Provides names of direct child resources of the domain root resource requests for which the Host Controller should ignore. Only relevant on a slave Host Controller. Configuring such "ignored resources" may help allow a Host Controller from an earlier release to function as a slave to a master Host Controller running a later release, by letting the slave ignore portions of the configuration its version of the software cannot understand. This strategy can only be successful if the servers managed by the slave Host Controller do not reference any of the ignored configuration. Supports the following attributes: type -- the type of resource (e.g. 'profile' or 'socket-binding-group') certain instances of which should be ignored. The value corresponds to the 'key' portion of the first element in the resource's address (e.g. 'profile' in the address /profile=ha/subsystem=web) wildcard -- if 'true', all resources of the given type should be ignored. Child elements list the names of specific instances of the given type of resource that should be ignored. Each element in the list corresponds to the 'value' portion of the first element in the resource's address (e.g. 'ha' in the address /profile=ha/subsystem=web.)

Name	Type	Default
type	string
wildcard	boolean	false
names	string

instance*

The name of a specific instances of a particular type of resource that should be ignored. The 'name' attribute corresponds to the 'value' portion of the first element in the resource's address (e.g. 'ha' in the address /profile=ha/subsystem=web.)

Name	Type	Default	Description
name	string

discovery-options?

discovery-option?

Name	Type	Description
name	string	The name for this domain controller discovery option.
code	string	The fully qualified class name for the DiscoveryOption implementation.
module	string	The module from which the DiscoveryOption implementation should be loaded. If not provided, the DiscoveryOption implementation must be available from the Host Controller's own module.

property*

Name	Type	Default	Description
name	FIXME
value	FIXME

static-discovery?

Name	Type	Description
name	string	The name for this domain controller discovery option.
protocol		The remote domain controller's protocol.
host	string	The remote domain controller's host name.
port	string	The remote domain controller's port.

interfaces?

A list of fully specified named network interfaces.

interface*

A named network interface, along with required criteria for determining the IP address to associate with that interface.

Name	Type	Default	Description
name	string

jvms?

jvm*

Name	Type	Default	Description
name	string

Name

Type

Default

Description

java-home

string

type

SUN	Allows the full set of JVM options to be set via the jvm schema elements
IBM	Sets a subset of the JVM options via the jvm schema elements

SUN

env-classpath-ignored

boolean

true

heap?

Name	Type	Default	Description
size	FIXME		Initial JVM heap size
max-size	FIXME		Maximum JVM heap size

permgen?

Deprecated. Has no effect on current version servers or on any servers controlled by previous version host controllers running on JDK 8 or later, as the JVM no longer provides a separate Permanent Generation space. For legacy version servers running on JDK 7 or earlier, this configures the size of the server VM's Permanent Generation space (i.e. -XX:PermSize, -XX:MaxPermSize.)

Name	Type	Default	Description
size	string
max-size	string

stack?

Name	Type	Default	Description
size	string

agent-lib?

Name	Type	Default	Description
value	FIXME		JVM agent lib value

agent-path?

Name	Type	Default	Description
value	FIXME		JVM agent path value

java-agent?

Name	Type	Default	Description
value	FIXME		JVM javaagent value

jvm-options?

option*

Name	Type	Default	Description
value	FIXME		JVM option value

environment-variables?

variable+

Name	Type	Default	Description
name	FIXME
value	FIXME

launch-command?

Prepend commands to the JVM process launch.

Name	Type	Default	Description
prefix	string		JVM launch command prefix

servers?

Name

Type

Default

Description

directory-grouping

by-server	Indicates each server's writable directories should be grouped under the server's name in the domain/servers directory. This is the default option.
by-type	Indicates each server's writable directories should be grouped based on their "type" (i.e. "data", "log", "tmp") with directories of a given type for all servers appearing in the domain level directory for that type, e.g. domain/data/servers/server-name.

by-server

server*

Name	Type	Default	Description
name	string
group	string
auto-start	boolean	true
update-auto-start-with-server-status	boolean	false	Iif the server last status (STARTED or STOPPED) is to be used to define the value of auto-start.

paths?

A list of named filesystem paths.

path*

A named filesystem path.

Name	Type	Description
name	string	The name of the path. Cannot be one of the standard fixed paths provided by the system: jboss.home.dir - 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 Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.
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. Note relative path declarations have to use '/' as file separator.
relative-to	string	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.dir - 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.config.dir - directory in which server configuration files are stored. 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.temp.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

interfaces?

A list of fully specified named network interfaces.

interface*

A named network interface, along with required criteria for determining the IP address to associate with that interface.

Name	Type	Default	Description
name	string

socket-bindings?

Server-specific overrides to the default socket binding configuration inherited from the server group.

Name	Type	Default	Description
socket-binding-group	string		The socket binding group to use for the server. If undefined, the socket binding group specified for the server group is used.
port-offset	int	0	Increment to apply to the base port values defined in the referenced socket binding group to derive the values to use on this server.
default-interface	string		Name of an interface that should be used as the interface for any sockets that do not explicitly declare one, overiding the one defined in the socket-binding-group referenced.

system-properties?

property+

Name	Type	Default	Description
boot-time	boolean	true

Name	Type	Default	Description
name	FIXME
value	FIXME

jvm?

Name	Type	Default	Description
debug-enabled	boolean	false
debug-options	string

Name	Type	Default	Description
name	string

Name

Type

Default

Description

java-home

string

type

SUN	Allows the full set of JVM options to be set via the jvm schema elements
IBM	Sets a subset of the JVM options via the jvm schema elements

SUN

env-classpath-ignored

boolean

true

heap?

Name	Type	Default	Description
size	FIXME		Initial JVM heap size
max-size	FIXME		Maximum JVM heap size

permgen?

Name	Type	Default	Description
size	string
max-size	string

stack?

Name	Type	Default	Description
size	string

agent-lib?

Name	Type	Default	Description
value	FIXME		JVM agent lib value

agent-path?

Name	Type	Default	Description
value	FIXME		JVM agent path value

java-agent?

Name	Type	Default	Description
value	FIXME		JVM javaagent value

jvm-options?

option*

Name	Type	Default	Description
value	FIXME		JVM option value

environment-variables?

variable+

Name	Type	Default	Description
name	FIXME
value	FIXME

launch-command?

Prepend commands to the JVM process launch.

Name	Type	Default	Description
prefix	string		JVM launch command prefix

ssl?

Configuration of the SSLContext used for the connection from the application server back to it's host controller.

Name	Type	Default	Description
ssl-protocol	string	TLS	The protocol to initialise the SSLContext, if 'Default' is specified the JVM wide default SSLContext will be used instead.
trust-manager-algorithm	string		The algorithm to use when initialising the TrustManagerFactory. If not specified the JVM default is used instead.
truststore-type	string		The type of the trust store. If not specified the JVM default is used instead.
truststore-path	string		The fully qualified path to the truststore. If not specified the no file will be used to initialise the truststore.
truststore-password	string		The password to open the truststore.

profile?

Contains a list of subsystems that will be run on the host

socket-binding-group?

Contains a list of socket configurations

Name	Type	Default	Description
name	string
default-interface	string		Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.
port-offset	int	0	Increment to apply to the base port values defined in the socket group to derive the values to use on this server.

socket-binding+

Configuration information for a socket.

Name	Type	Default	Description
name	string
interface	string		Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen. This should be one of the declared interfaces.
port	unsignedShort	0	Number of the port to which the socket should be bound.
fixed-port	boolean	false	Whether the port value should remain fixed even if numerically offsets are applied to the other sockets in the socket group..
multicast-address	string		Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.
multicast-port	positiveInteger		Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.

client-mapping*

Specifies zero or more client mappings for this socket binding. A client connecting to this socket should use the destination address specified in the mapping that matches its desired outbound interface. This allows for advanced network topologies that use either network address translation, or have bindings on multiple network interfaces to function. Each mapping should be evaluated in declared order, with the first successful match used to determine the destination.

Type definition for a client mapping on a socket binding. A client mapping specifies how external clients should connect to this socket's port, provided that the client's outbound interface match the specified source network value.

Name	Type	Description
source-network	string	Source network the client connection binds on. This value is in the form of ip/netmask. A client should match this value against the desired client host network interface, and if matched the client should connect to the corresponding destination values. If omitted this mapping should match any interface.
destination-address	string	The destination address that a client should connect to if the source-network matches. This value can either be a hostname or an IP address.
destination-port	string	The destination port that a client should connect to if the source-network matches. If omitted this mapping will reuse the effective socket binding port.

outbound-socket-binding*

Configuration information for an outbound socket.

Name	Type	Default	Description
name	string		The name of the outbound socket binding
source-interface	string		The name of the interface that should be used for setting up the source address of the outbound socket. This should be one of the declared interfaces.
source-port	nonNegativeInteger		The port number that will be used for setting the source address of the outbound socket. If the source-interface attribute has been specified and the source-port attribute equals 0 or is absent, then the system uses an ephemeral port while binding the socket to a source address.
fixed-source-port	boolean	false	Whether the source-port value should remain fixed even if the socket binding group specifies a port offset

remote-destination

Name	Type	Default	Description
host	string		The remote server address to which the outbound socket has to be connect. The address can be either an IP address of the host server of the hostname of the server
port	positiveInteger		The remote port to which the outbound socket has to connect.

local-destination

Name	Type	Default	Description
socket-binding-ref	string		The reference to a socket binding that has to be used as the destination for the outbound socket binding. This socket binding name should belong to the same socket binding group to which this local destination client socket belongs.

Root element for a document specifying the configuration of a single "standalone" server that does not operate as part of a domain. Note that this element is distinct from the 'serverType' specified in this schema. The latter type forms part of the configuration of a server that operates as part of a domain.

Name	Type	Default	Description
name	string		The name to use for this server. If not set, defaults to the runtime value "HOSTNAME" or "COMPUTERNAME" environment variables, or, if neither environment variable is present, to the value of InetAddress.getLocalHost().getHostName(). If the special value "jboss.domain.uuid" is used, a java.util.UUID will be created and used, based on the value of InetAddress.getLocalHost().
organization	string		The name of the organization running this server.

extensions?

Contains a list of extension modules.

extension+

A module that extends the standard capabilities of a domain or a standalone server.

Name	Type	Default	Description
module	string		The name of the module

system-properties?

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

paths?

A list of named filesystem paths.

path*

A named filesystem path.

Name	Type	Description
name	string	The name of the path. Cannot be one of the standard fixed paths provided by the system: jboss.home.dir - 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 Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.
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. Note relative path declarations have to use '/' as file separator.
relative-to	string	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.dir - 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.config.dir - directory in which server configuration files are stored. 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.temp.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

vault?

Name	Type	Default	Description
code	string
module	string

vault-option*

Name	Type	Default	Description
name	FIXME
value	FIXME

management?

The centralized configuration for the management of standalone server.

audit-log?

formatters

Declaration of management operation audit logging formatters.

json-formatter

Configuration of a JSON formatter for the audit log.

Name	Type	Default	Description
compact	boolean	false	If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.
escape-new-line	boolean	false	If true will escape all new lines with the ascii code in octal, e.g. #012.
escape-control-characters	boolean	false	If true will escape all control characters (ascii entries with a decimal value less than 32) with the ascii code in octal, e.g.'\n\ becomes '#012'. If this is true, it will override escape-new-line="false"

Shared configuration for audit log formatters..

Name	Type	Default	Description
name	string		The name of the formatter. Must be unique across all types of formatter (there is only the JSON formatter at present but more are planned for the future)
include-date	boolean	true	Whether or not to include the date in the formatted log record
date-format	string	yyyy-MM-dd HH:mm:ss	The date format to use as understood by {@link java.text.SimpleDateFormat}. Will be ignored if include-date="false".
date-separator	string	-	The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".

handlers

Declaration of management operation audit logging handlers.

file-handler

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
rotate-at-startup	boolean		Whether or not should an old log file be rotated during a handler initialization.

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
path	string		The path of the audit log.
relative-to	string		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.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

size-rotating-file-handler

Name	Type	Default	Description
rotate-size			The size at which to rotate the log file.
max-backup-index	positiveInteger		The maximum number of backups to keep.

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
path	string		The path of the audit log.
relative-to	string		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.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

periodic-rotating-file-handler

Name	Type	Default	Description
suffix	string		The suffix string in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.

Configuration of a simple file handler for the audit log. This writes to a local file.

Name	Type	Default	Description
path	string		The path of the audit log.
relative-to	string		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.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

syslog-handler

Configuration of a syslog file handler for the audit log on a server. This writes to syslog server.

Name

Type

Default

Description

syslog-format

RFC5424	Format the syslog data according to the RFC-5424 standard
RFC3164	Format the syslog data according to the RFC-3164 standard

RFC5424

The format to use for the syslog messages. See your syslog provider's documentation for what is supported.

max-length

int

truncate

boolean

true

facility

KERNEL	0
USER_LEVEL	1
MAIL_SYSTEM	2
SYSTEM_DAEMONS	3
SECURITY	4
SYSLOGD	5
LINE_PRINTER	6
NETWORK_NEWS	7
UUCP	8
CLOCK_DAEMON	9
SECURITY2	10
FTP_DAEMON	11
NTP	12
LOG_AUDIT	13
LOG_ALERT	14
CLOCK_DAEMON2	15
LOCAL_USE_0	16
LOCAL_USE_1	17
LOCAL_USE_2	18
LOCAL_USE_3	19
LOCAL_USE_4	20
LOCAL_USE_5	21
LOCAL_USE_6	22
LOCAL_USE_7	23

USER_LEVEL

app-name

string

The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.

Common configuration of a handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
formatter	string		The name of the formatter to use for the handler.
max-failure-count	string	10	The number of logging failures before this handler is disabled.

in-memory-handler

Configuration of a in memory handler for the audit log.

Name	Type	Default	Description
name	string		The name of the handler. The name must be unique across all types of handler.
max-history	integer	10	The number of logging entries stored in memory.

logger

Declaration of management operation audit logging configuration coming from the model controller core.

Name	Type	Default	Description
log-boot	boolean	false	Whether operations should be logged on boot.
log-read-only	boolean	false	Whether operations that do not modify the configuration or any runtime services should be logged.
enabled	boolean	true	Whether audit logging is enabled.

handlers

References to audit-log-handlers defined in the audit-log-handlers section

handler?

A reference to an audit-log-handler defined in the audit-log-appenders section

Name	Type	Default	Description
name	string

management-interfaces?

native-remoting-interface?

Makes the native management interface available via the connectors set up in the remoting subsystem, using the remoting subsystem's endpoint. This should only be used for a server not for a HC/DC.

native-interface?

Configuration of the socket used by host or standalone server's exposed HTTP management interface. Configuration of the socket to use for the native management interface is a choice between a direct configuration of the address and port, or a reference to a socket-binding configuration in the server's socket-binding-group element. The latter is the recommended approach as it makes it easier to avoid port conflicts by taking advantage of the socket-binding-group's port-offset configuration. Direct configuration of the address and ports is deprecated and is only provided to preserve backward compatibility.

Name	Type	Default	Description
sasl-authentication-factory	string		The SASL server authentication policy to secure connections upgraded from HTTP.

Name	Type	Default	Description
ssl-context	string		Reference to the SSLContext to use for this management interface. If this is not set then the SSLContext will be obtained from any referenced security-realm.
security-realm	string		The security realm to use for this management interface, the capabilities of the security realm will be queried to identify the authentication mechanism(s) to offer.
sasl-protocol	string	remote	Where Remoting is accepting incomming connections part of the authentication process advertises the name of the protocol in use, by default this is 'remote' but this attribute can be set if an alternative is required.
server-name	string		Where Remoting is accepting incomming connection the initial exchange and the authentication process both advertise the name of the server, by default this is derived from the address Remoting is listening on but this attribute can be set to override the name.

http-interface?

Configuration of a standalone server's exposed HTTP/HTTPS management interface. Configuration of the socket to use for the HTTP/HTTPS management interface is a choice between a direct configuration of the address and ports, or a reference to socket-binding configurations in the server's socket-binding-group element. The latter is the recommended approach as it makes it easier to avoid port conflicts by taking advantage of the socket-binding-group's port-offset configuration. Direct configuration of the address and ports is deprecated and is only provided to preserve backward compatibility.

Name	Type	Default	Description
console-enabled	boolean	true
allowed-origins			A space separated list of Origins that will be trusted to send request to the management API once the user is authenticated. This is used following the Cross-Origin Resource Sharing recommendation (http://www.w3.org/TR/access-control/).

Name	Type	Default	Description
http-authentication-factory	string		The HTTP authentication factory to use to secure normal HTTP requests.

http-upgrade?

HTTP Upgrade configuration on the management interface.

Name	Type	Default	Description
enabled	boolean	false	Is HTTP Upgrade to 'remote' enabled.
sasl-authentication-factory	string		The SASL authentication policy to secure connections upgraded from HTTP.

Name	Type	Default	Description
ssl-context	string		Reference to the SSLContext to use for this management interface. If this is not set then the SSLContext will be obtained from any referenced security-realm.
security-realm	string		The security realm to use for this management interface, the capabilities of the security realm will be queried to identify the authentication mechanism(s) to offer.
sasl-protocol	string	remote	Where Remoting is accepting incomming connections part of the authentication process advertises the name of the protocol in use, by default this is 'remote' but this attribute can be set if an alternative is required.
server-name	string		Where Remoting is accepting incomming connection the initial exchange and the authentication process both advertise the name of the server, by default this is derived from the address Remoting is listening on but this attribute can be set to override the name.

access-control?

Contains the access control configuration for a standalone server.

Name	Type	Default	Description
provider		simple
use-identity-roles	boolean	false

role-mapping?

Contains the mapping of authenticated users to roles.

role*

An individual role definition.

Name	Type	Default	Description
name	string		The name of the role, this should either be one of the standard roles or a scoped role. A user is added to a role if any of the following are true: - 1 - The user is a member of a group listed in the includes element. 2 - The user is explicitly listed in the includes element. AND neither of the following are true: - 1 - The user is a member of a group listed in the excludes element. 2 - The user is explicitly listed in the groups element. i.e. Any excludes definition takes priority over any includes definition.
include-all	boolean	false	If set to true all authenticated users will be granted this role provided that they have not been matched to the exclude list.

include?

A list of users or groups to be included/excluded from the role containing this type.

user*

Representation of a single principal to indicate role assignment. If the realm attribute is specified then the realm used to authenticated the user will also be taken into account when performing the comparison.

Name	Type	Description
alias	string	If you are editing the XML configuration directly you do not need to be adding this attribute and in general you should not be adding this attribute. When the management tools are used to add include and exclude definitions for groups and users the name used in the address is an arbitrary String, this attribute is used when non-standard forms of the address are used so that it can be persisted and the model will be consistent when it is reloaded. But as in the first sentence, if you are questioning if you should use this attribute yourself - DON'T.
realm	string	The name of the realm the user used to authenticate. This attribute is deprecated and should not be used once management security is migrated to WildFly Elytron.
name	string	The name of the principal.

group*

Name	Type	Description
alias	string	If you are editing the XML configuration directly you do not need to be adding this attribute and in general you should not be adding this attribute. When the management tools are used to add include and exclude definitions for groups and users the name used in the address is an arbitrary String, this attribute is used when non-standard forms of the address are used so that it can be persisted and the model will be consistent when it is reloaded. But as in the first sentence, if you are questioning if you should use this attribute yourself - DON'T.
realm	string	The name of the realm the user used to authenticate. This attribute is deprecated and should not be used once management security is migrated to WildFly Elytron.
name	string	The name of the principal.

exclude?

A list of users or groups to be included/excluded from the role containing this type.

user*

Name	Type	Description
alias	string	If you are editing the XML configuration directly you do not need to be adding this attribute and in general you should not be adding this attribute. When the management tools are used to add include and exclude definitions for groups and users the name used in the address is an arbitrary String, this attribute is used when non-standard forms of the address are used so that it can be persisted and the model will be consistent when it is reloaded. But as in the first sentence, if you are questioning if you should use this attribute yourself - DON'T.
realm	string	The name of the realm the user used to authenticate. This attribute is deprecated and should not be used once management security is migrated to WildFly Elytron.
name	string	The name of the principal.

group*

Name	Type	Description
alias	string	If you are editing the XML configuration directly you do not need to be adding this attribute and in general you should not be adding this attribute. When the management tools are used to add include and exclude definitions for groups and users the name used in the address is an arbitrary String, this attribute is used when non-standard forms of the address are used so that it can be persisted and the model will be consistent when it is reloaded. But as in the first sentence, if you are questioning if you should use this attribute yourself - DON'T.
realm	string	The name of the realm the user used to authenticate. This attribute is deprecated and should not be used once management security is migrated to WildFly Elytron.
name	string	The name of the principal.

constraints?

Stores information about configured access constraints.

vault-expression-sensitivity?

Common configuration of a sensitivity constraint

Name	Type	Default	Description
requires-read	boolean		Configuration of if a classification's read is sensitive
requires-write	boolean		Configuration of if a classification's write is sensitive

sensitive-classifications?

Stores information about a configured sensitive classification

sensitive-classification

Stores information about a configured sensitive classification

Name	Type	Description
requires-addressable	boolean	Configuration of if a classification's addressability is sensitive
name	string	The name of the constraint, must be unique for each name
type	string	'core' or the name of the subsystem defining the constraint

Common configuration of a sensitivity constraint

Name	Type	Default	Description
requires-read	boolean		Configuration of if a classification's read is sensitive
requires-write	boolean		Configuration of if a classification's write is sensitive

application-classifications?

Stores information about a configured application classifications

application-classification

Stores information about a configured application classification

Name	Type	Description
name	string	The name of the constraint, must be unique for each name
type	string	'core' or the name of the subsystem defining the constraint
application	boolean

Domain-wide default configuration settings for the management of standalone servers and a Host Controller.

configuration-changes?

Configuration for the history of configuration changes.

Name	Type	Default	Description
max-history	integer	10	Number of configuration changes that are available in history.

identity?

Definition of the security domain to use to obtain the current identity from.

Name	Type	Default	Description
security-domain	string		Reference to the security domain to use to obtain the current identity.

security-realms?

security-realm+

Configuration of a security realm for securing access to the management interfaces.

Name	Type	Default	Description
name	string		The name of this security-realm, each security-realm must be assigned a unique name.

plug-ins?

List of modules to be searched for supported security realm plug-ins.

plug-in

Name	Type	Default	Description
module	string		The name of the module.

server-identities?

Configuration of the identities that represent the server.

ssl?

Configuration of the SSL identity of this server.

Name	Type	Default	Description
protocol	string	TLS	The protocol to use when creating the SSLContext. Note: This is separate from the enabled protocols on the underlying SSLEngine, to configure those add the engine specific configuration.

engine?

Configuration options specific to the unlerlying SSLEngine created for request handling.

Name	Type	Default	Description
enabled-protocols		TLSv1 TLSv1.1 TLSv1.2	A space separated list of protocols that may be enabled on the SSLEngine handling requests. At runtime the intersection of the available protocols and the protocols specified here will be used, if that results in an empy list an error will be reported.
enabled-cipher-suites			A space separated list of cipher suites that may be enabled on the SSLEngine handling requests. At runtime the intersection of the available suites and the suites specified here will be used, if that results in an empy list an error will be reported.

keystore

An extension of keyStoreType used by realms.

Name	Type	Default	Description
provider	string	JKS	The provider for the store, the default is a file based JKS store.
path	string		The path of the keystore, this is required if the provider is JKS otherwise it will be ignored.
relative-to	string		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.

This is a more complex keystore definition which also allows for an alias and key password to be specified.

Name	Type	Description
alias	string	The alias of the entry to use from the keystore, if specified all remaining entries in the keystore will be ignored. Note: The use of aliases is only available for JKS based stores, for other store types this will be ignored.
key-password	string	The password to use when loading keys from the keystore.
generate-self-signed-certificate-host	string	If this is set and the key store does not exist then a new keystore will be created and a self signed certificate will be generated. The host name for the self signed certificate will be the value of this attribute. This is not intended for production use.

key-password-credential-reference?

Credential reference to be used by as protection parameter when loading keys from the keystore.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

The keystore configuration for the server.

Name	Type	Default	Description
keystore-password	string		The password to open the keystore.

keystore-password-credential-reference?

Credential reference to be used by as protection parameter for the Keystore.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

secret?

Configuration of the secret/password-based identity of this server.

Name	Type	Default	Description
value	string		The secret / password - Base64 Encoded

credential-reference?

Credential to be used by as protection parameter for the Credential Store.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

kerberos?

Configuration of a servers Kerberos identity.

keytab

Name	Type	Description
path	string	The path of the keytab.
relative-to	string	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.
principal	string	The name of the principal represented by the keytab.
for-hosts		A space separated list of the host names this keytab can be used for. Can also be set to '*' if applicable for all hosts if a better match is not found. If multiple keytabs are defined as handling the same host which one is selected is undefined and subject to change, for predictability you should ensure that no more than one keytab is defined per host.

authentication?

truststore?

Configuration of a keystore to use to create a trust manager to verify clients.

An extension of keyStoreType used by realms.

Name	Type	Default	Description
provider	string	JKS	The provider for the store, the default is a file based JKS store.
path	string		The path of the keystore, this is required if the provider is JKS otherwise it will be ignored.
relative-to	string		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 keystore configuration for the server.

Name	Type	Default	Description
keystore-password	string		The password to open the keystore.

keystore-password-credential-reference?

Credential reference to be used by as protection parameter for the Keystore.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

local?

Configuration to enable the local authentication mechanism, if this element is omitted then local authentication will be disabled.

This type definition is used to control the local authentication mechanism.

Name	Type	Default	Description
default-user	string		When using the local mechanism it is optional for the client side to send an authentication user name - this attribute specifies the user name to be assumed if the remote client does not send one.
allowed-users	string		A comma separated list of users that can be specified by the client when connecting using the local authentication mechanism. If a default user has been specified then that user is automatically added to the allowed list. If both default-user and allowed-users are omitted despite the mechanism being enabled no incoming connection attemps using the mechanism will succeed. If any user name should be accepted the value should be set to "*".
skip-group-loading	boolean	false	After authentication has occurred the username of the authenticated user is then passed to the configured authorization mechanism to load the group membership information for the authenticated user. As the local authenitication mechanism is a special case with an artificial identifier for the authenticated user this can cause problems during group loading where a user with the same name does not exist. Setting this attribute to 'false' will disable the loading of groups for the local user.

kerberos?

Configuration to enable Kerberos authentication.

Definition to enable Kerberos for authentication.

Name	Type	Default	Description
remove-realm	boolean	false	When a user is authenticated using Kerberos typically their identity will be represented in the form username@REALM, setting this option to true will strip the @REALM part of the name. This may be desired to bring the names in-line with username/password based authentication if used in parallel.

jaas?

Definition to use a JAAS based configuration for authentication.

Name	Type	Default	Description
name	string		The name identifying the jaas configuration of LoginModules.
assign-groups	boolean	false	When JAAS is delegated to for authentication a user is also assigned a set of roles, if this attribute is set to true then those roles will be assigned to the user a groups.

ldap?

Definition to use LDAP as the user repository.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search for the user.
recursive	boolean	false	Should the search be recursive.
user-dn	string	dn	The name of the attribute which is the users distinguished name.
username-load	string		This attribute is independent of the filtering configuration, if this attribute is set then after the users entry in LDAP is identified this attribute will be read to discover the users actual username. This is optional but could be useful in a few scenarios e.g. authenticate with an e-mail address but be identified by a username, correcting the case of an entered username or even in the future ensuring consistency after a different authentication approach. Note: This value will become the username used for any subsequent group loading.
allow-empty-passwords	boolean	false	Should users be allowed to supply an empty password? Some LDAP servers will allow an anonymous bind so an empty password could appear as a successful authentication even though no password was sent to verify.

cache?

Name	Type	Default	Description
type		by-search-time	The type of cache, by-search-time and the entries are evicted based on search time and search order, by-access-time and the entires are evicted based on the time they were last accessed.
eviction-time	int	900	The time until an entry is evicted from the cache in seconds, a time of <=0 means no eviction based on time. If items are not going to be evicted based on time then max-cache-size should be set otherwise the cache could grow without restriction. Note: The eviction time is handled on a best-efforts basis, during times of many concurrent authentications there could be small delay before the evictions fire.
cache-failures	boolean	false	Should non IO failures be cached? e.g. should searches for a non-existent user be cached to avoid repeating the same search.
max-cache-size	int	0	The maximum number of items to hold in the cache before items are evicted, or <=0 where the size of the cache is unlimited. This value should be higher than the anticipated cache size for current users otherwise items will be continually evicted.

username-filter

Name	Type	Default	Description
attribute	string		The name of the attribute to search for the user, this filter will then perform a simple search where the username entered by the user matches the attribute specified here.

advanced-filter

Name	Type	Default	Description
filter	string		The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.

The base type used for LDAP authentication and authorization definitions.

Name	Type	Default	Description
connection	string		The name of the connection to use to connect to LDAP.

properties?

Declaration of users stored within properties files. The entries within the properties file are username={credentials} with each user being specified on it's own line.

Name	Type	Default	Description
plain-text	boolean	false	Are the credentials within the properties file stored in plain text, if not the {credential} is expected to be the hex encoded Digest hash of 'username : realm : password'.

Declaration of a location of a properties file.

Name	Type	Default	Description
relative-to	string		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.
path	string		The path of the properties file.

users?

A set of users

user+

A single user.

Name	Type	Default	Description
username	string		The users username.

password

plug-in?

This type defines which plug in will be used to handle either the loading of the authentication data or authorization data during the authentication process.

Name

Type

Default

Description

name

string

The short name of the plug-in as already dynamically registered by being referenced in the plug-ins element.

mechanism

DIGEST
PLAIN

DIGEST

By default plug-ins will be assumed to be used with the DIGEST authentication mechanism, this attribute can override the plug-in for use with the PLAIN mechanism.

properties?

The properties to be made available to the plug-in.

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

authorization?

Name	Type	Default	Description
map-groups-to-roles	boolean	true	The membership information loaded is the authenticated identities group membership, commonly there is a 1:1 mapping between group membership and the applicable roles, this attribute allows for the mapping to be performed automatically.

properties?

Declaration of a location of a properties file.

Name	Type	Default	Description
relative-to	string		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.
path	string		The path of the properties file.

plug-in?

This type defines which plug in will be used to handle either the loading of the authentication data or authorization data during the authentication process.

Name

Type

Default

Description

name

string

The short name of the plug-in as already dynamically registered by being referenced in the plug-ins element.

mechanism

DIGEST
PLAIN

DIGEST

By default plug-ins will be assumed to be used with the DIGEST authentication mechanism, this attribute can override the plug-in for use with the PLAIN mechanism.

properties?

The properties to be made available to the plug-in.

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

ldap?

username-to-dn?

Search definition to locate a user from the supplied username.

Name	Type	Default	Description
force	boolean	false	If the username was already converted to a distinguished name during authentication this attribute forces the search to be repeated before loading group information. This would most likely be required if a different LDAP server was being used to load group information as was used for authentication.

cache?

Name	Type	Default	Description
type		by-search-time	The type of cache, by-search-time and the entries are evicted based on search time and search order, by-access-time and the entires are evicted based on the time they were last accessed.
eviction-time	int	900	The time until an entry is evicted from the cache in seconds, a time of <=0 means no eviction based on time. If items are not going to be evicted based on time then max-cache-size should be set otherwise the cache could grow without restriction. Note: The eviction time is handled on a best-efforts basis, during times of many concurrent authentications there could be small delay before the evictions fire.
cache-failures	boolean	false	Should non IO failures be cached? e.g. should searches for a non-existent user be cached to avoid repeating the same search.
max-cache-size	int	0	The maximum number of items to hold in the cache before items are evicted, or <=0 where the size of the cache is unlimited. This value should be higher than the anticipated cache size for current users otherwise items will be continually evicted.

username-is-dn

username-filter

Name	Type	Default	Description
user-dn-attribute	string	dn	The attribute on the user entry which is their distinguished name.
attribute	string	uid	The name of the attribute to search for the user, this filter will then perform a simple search where the username entered by the user matches the attribute specified here.

Base type of common attributes used for LDAP searches.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search.
recursive	boolean	false	Should the search be recursive.

advanced-filter

Name	Type	Default	Description
user-dn-attribute	string	dn	The attribute on the user entry which is their distinguished name.
filter	string		The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.

Base type of common attributes used for LDAP searches.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search.
recursive	boolean	false	Should the search be recursive.

group-search

Name	Type	Default	Description
group-name		SIMPLE	Defines the form the name of the group should take, either it's simple name or it's complete distringuished name.
iterative	boolean	false	Should any group searching be iterative, i.e. should additional searches be performed to identify the groups that the groups are members of.
group-dn-attribute	string	dn	On the group entry which of it's attributes is it's distingushed name.
group-name-attribute	string	uid	On the group entry which of it's attributes is it's simple name.

cache?

Name	Type	Default	Description
type		by-search-time	The type of cache, by-search-time and the entries are evicted based on search time and search order, by-access-time and the entires are evicted based on the time they were last accessed.
eviction-time	int	900	The time until an entry is evicted from the cache in seconds, a time of <=0 means no eviction based on time. If items are not going to be evicted based on time then max-cache-size should be set otherwise the cache could grow without restriction. Note: The eviction time is handled on a best-efforts basis, during times of many concurrent authentications there could be small delay before the evictions fire.
cache-failures	boolean	false	Should non IO failures be cached? e.g. should searches for a non-existent user be cached to avoid repeating the same search.
max-cache-size	int	0	The maximum number of items to hold in the cache before items are evicted, or <=0 where the size of the cache is unlimited. This value should be higher than the anticipated cache size for current users otherwise items will be continually evicted.

group-to-principal

Group search definition where an attribute on the group references the principal.

Name	Type	Default	Description
search-by		DISTINGUISHED_NAME	Should searching use the simple name or distinguished name of the principal.
prefer-original-connection	boolean	true	After a referral has been followed should the original LDAP connection defined for group loading be used or should the connection from the last referral be used instead. By default each attempt to load a group will revert back to the original connection as defined in the configuration, however setting this attribute to false will cause subsequent searches to use the connection of the last referral.

membership-filter

Name	Type	Default	Description
principal-attribute	string	member	The attribute on the group entry that references the principal.

Base type of common attributes used for LDAP searches.

Name	Type	Default	Description
base-dn	string		The base distinguished name to commence the search.
recursive	boolean	false	Should the search be recursive.

principal-to-group

Group search definition where an attribute on the principal references the group.

Name	Type	Default	Description
group-attribute	string	memberOf	The name of the attribute on the principal that references the group.
prefer-original-connection	boolean	true	After a referral has been followed should the original LDAP connection defined for group loading be used or should the connection from the last referral be used instead. By default each attempt to load a group will revert back to the original connection as defined in the configuration, however setting this attribute to false will cause subsequent searches to use the connection of the last referral.
skip-missing-groups	boolean	false	If an entry references non-existent groups then authentication is aborted due to the inability to query a users complete set of groups, setting this option to true allows for non-existent groups to be silently ignored.
parse-group-name-from-dn	boolean	false	Extract the groupe name from the distinguished name instead of requesting it.

The base type used for LDAP authentication and authorization definitions.

Name	Type	Default	Description
connection	string		The name of the connection to use to connect to LDAP.

outbound-connections?

ldap

The LDAP connection definition.

Name

Type

Default

Description

name

string

The name of this connection.

url

string

The URL to connect to ldap.

search-dn

string

The distinguished name to use when connecting to LDAP to perform searches.

search-credential

string

The credential to use when connecting to perform a search.

security-realm

string

initial-context-factory

string

com.sun.jndi.ldap.LdapCtxFactory

The initial context factory to establish the LdapContext.

referrals

IGNORE
FOLLOW
THROW

IGNORE

handles-referrals-for

always-send-client-cert

boolean

false

properties?

property+

Name	Type	Default	Description
name	FIXME
value	FIXME

search-credential-reference?

The credential reference to use when connecting to perform a search.

Name	Type	Default	Description
clear-text	string		Credential/password in clear text. Use just for testing purpose. Otherwise use credential store to mask the actual credential from your configuration.

profile?

Contains a list of subsystems

interfaces?

A list of fully specified named network interfaces.

interface*

A named network interface, along with required criteria for determining the IP address to associate with that interface.

Name	Type	Default	Description
name	string

socket-binding-group?

Contains a list of socket configurations

Name	Type	Default	Description
name	string
default-interface	string		Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.
port-offset	int	0	Increment to apply to the base port values defined in the socket group to derive the values to use on this server.

socket-binding+

Configuration information for a socket.

Name	Type	Default	Description
name	string
interface	string		Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen. This should be one of the declared interfaces.
port	unsignedShort	0	Number of the port to which the socket should be bound.
fixed-port	boolean	false	Whether the port value should remain fixed even if numerically offsets are applied to the other sockets in the socket group..
multicast-address	string		Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.
multicast-port	positiveInteger		Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.

client-mapping*

Name	Type	Description
source-network	string	Source network the client connection binds on. This value is in the form of ip/netmask. A client should match this value against the desired client host network interface, and if matched the client should connect to the corresponding destination values. If omitted this mapping should match any interface.
destination-address	string	The destination address that a client should connect to if the source-network matches. This value can either be a hostname or an IP address.
destination-port	string	The destination port that a client should connect to if the source-network matches. If omitted this mapping will reuse the effective socket binding port.

outbound-socket-binding*

Configuration information for an outbound socket.

Name	Type	Default	Description
name	string		The name of the outbound socket binding
source-interface	string		The name of the interface that should be used for setting up the source address of the outbound socket. This should be one of the declared interfaces.
source-port	nonNegativeInteger		The port number that will be used for setting the source address of the outbound socket. If the source-interface attribute has been specified and the source-port attribute equals 0 or is absent, then the system uses an ephemeral port while binding the socket to a source address.
fixed-source-port	boolean	false	Whether the source-port value should remain fixed even if the socket binding group specifies a port offset

remote-destination

Name	Type	Default	Description
host	string		The remote server address to which the outbound socket has to be connect. The address can be either an IP address of the host server of the hostname of the server
port	positiveInteger		The remote port to which the outbound socket has to connect.

local-destination

Name	Type	Default	Description
socket-binding-ref	string		The reference to a socket binding that has to be used as the destination for the outbound socket binding. This socket binding name should belong to the same socket binding group to which this local destination client socket belongs.

deployments?

Contains a list of deployments that have been mapped to a server.

deployment+

A deployment that has been mapped to a server.

Name	Type	Default	Description
enabled	boolean	true	Whether the deployment deploy automatically when the server starts up.

content

Name	Type	Default	Description
sha1	FIXME		The checksum of the content

fs-archive

Archived content found on the filesystem

Name	Type	Default	Description
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.
relative-to	string		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.dir - 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.config.dir - directory in which server configuration files are stored. 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.temp.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

fs-exploded

Exploded content found on the filesystem

Name	Type	Default	Description
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.
relative-to	string		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.dir - 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.config.dir - directory in which server configuration files are stored. 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.temp.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

Name	Type	Default	Description
name	FIXME		Unique identifier of the deployment. Must be unique across all deployments.
runtime-name	FIXME		Name by which the deployment will be known within a running server.of the deployment. Does not need to be unique across all deployments in the domain, although it must be unique within an individual server. For example, two different deployments running on different servers in the domain could both have a 'runtime-name' of 'example.war', with one having a 'name' of 'example.war_v1' and another with an 'name' of 'example.war_v2'.

deployment-overlays?

Stores information about deployment overlays that can be used to override deployment content.

deployment-overlay*

Name	Type	Default	Description
name	token

content*

Name	Type	Default	Description
path	token
content	token

deployment*

Name	Type	Default	Description
name	string

Name	Type	Default	Description
name	string
base-role	string		The name of the standard role upon which the scoped role is based.

Name	Type	Description
name	string	Unique identifier for this particular configuration.
active-server-groups	string	A space-delimited list of server-group names specifying all the server groups that have servers running on the target hosts. These are the groups used by the host's servers. For these groups, the server-group resource and related profile, socket-binding-group and deployment resources will not be hidden; all other server-group, profile, socket-binding-group and deployment resources will be hidden. NOTE: For any host, the Domain Controller only applies this setting if, when the host registers with the Domain Controller, it does not inform the Domain Controller that it is configured to "ignore-unused-configuration". The host.xml "ignore-unused-configuration" setting provides similar functionality and takes precedence over this domain-wide setting. The primary expecuted use case for this setting is for managing hosts running releases prior to the introduction of the host.xml "ignore-unused-configuration" setting.
active-socket-binding-groups	string	A space-delimited list of socket-binding-group names specifying all the socket binding groups that are used by servers running on the target hosts. Only used if 'active-server-groups' is set; otherwise ignored. Only needs to be set if the socket binding groups specified in the configuration of the server groups listed in 'active-server-groups' isn't the complete set of socket binding groups used on the servers (i.e. some other socket binding groups are specified in the target hosts' 'server-config' resources.) NOTE: For any host, the Domain Controller only applies this setting if, when the host registers with the Domain Controller, it does not inform the Domain Controller that it is configured to "ignore-unused-configuration". The host.xml "ignore-unused-configuration" setting provides similar functionality and takes precedence over this domain-wide setting. The primary expecuted use case for this setting is for managing hosts running releases prior to the introduction of the host.xml "ignore-unused-configuration" setting.

Name	Type	Description
major-version	int	The kernel management API major version used by the host.
minor-version	int	The kernel management API minor version used by the host.
micro-version	int	The kernel management API micro version. If unspecified, the enclosing host-ignore configuration applies to all releases of the given major + minor version, excluding any for which a different configuration with a micro version also specified is present.

urn:jboss:domain:10.0

domain

extensions?

extension+

system-properties?

property+

paths?

path*

management?

access-control?

server-group-scoped-roles?

role+

host-scoped-roles?

role+

role-mapping?

role*

include?

user*

group*

exclude?

user*

group*

constraints?

vault-expression-sensitivity?

sensitive-classifications?

sensitive-classification

application-classifications?

application-classification

profiles?

profile+

interfaces?

interface*

socket-binding-groups?

socket-binding-group+

socket-binding+

client-mapping*

outbound-socket-binding*

remote-destination

local-destination

deployments?

deployment+

content

fs-archive

fs-exploded

deployment-overlays?

deployment-overlay*

content*

server-groups?

server-group*

jvm?

heap?

permgen?

stack?

agent-lib?

agent-path?

java-agent?

jvm-options?

option*

environment-variables?

variable+

launch-command?

socket-binding-group

deployments?

deployment+

deployment-overlays?

deployment-overlay*

deployment*

system-properties?

property+

host-excludes?

host-exclude*

host-release

host-api-version

excluded-extensions?

extension+

management-client-content?

rollout-plans?

host

extensions?

extension+