WildFly Full 20 Model Reference

The root node of the server-level management model.

Children (9)

core-service Core services provided by the server.

capability-registry Capability registry
management The management services used to control a server or a host's host controller.
module-loading The modular classloading system.
patching patch
platform-mbean Provides the management interface for monitoring and management of the Java virtual machine as well as the operating system on which the Java virtual machine is running. Exposes the JDK-provided JMX MBeans in the java.lang and java.nio JMX domains.
server-environment The server environment.
service-container The central container that manages all services in a running standalone server or in a host controller in a management domain.
vault Security Vault for attributes.

deployment A list of deployments available for use on the server.
deployment-overlay A list of deployment overlays available for use by the server
extension A list of extension modules.
interface A list of named network interfaces available for use on the server.
path A list of named filesystem paths.
socket-binding-group The socket binding group in use on the server.
subsystem The subsystems that make up the server's profile.

batch-jberet Batch Subsystem (JSR-352)
bean-validation Bean Validation subsystem
core-management The configuration of the core-management subsystem.
datasources The data-sources subsystem, used to declare JDBC data-sources
datasources-agroal Agroal subsystem
deployment-scanner An individual deployment scanner that scans a particular location
discovery The discovery subsystem
distributable-web The distributable-web subsystem
ee The configuration of the EE subsystem.
ee-security The configuration of the EE Security subsystem.
ejb3 The configuration of the ejb3 subsystem.
elytron The Elytron Subsystem
iiop-openjdk The iiop-openjdk subsystem configuration.
infinispan The configuration of the infinispan subsystem.
io IO subsystem
jaxrs The configuration of the JAX-RS subsystem.
jca The Jakarta EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters
jdr JBoss Diagnostic Reporter (JDR) Subsystem.
jgroups The configuration of the JGroups subsystem.
jmx The configuration of the JMX subsystem.
jpa The configuration of the JPA subsystem.
jsf The JSF subsystem
jsr77 The configuration of the JSR-77 subsystem.
logging The configuration of the logging subsystem.
mail The mail subsystem
messaging-activemq The messaging-activemq subsystem.
microprofile-config-smallrye WildFLy Extension for Eclipse MicroProfile Config With SmallRye
microprofile-health-smallrye WildFly Extension for Eclipse MicroProfile Health With SmallRye
microprofile-jwt-smallrye WildFly Extension for Eclipse MicroProfile JWT With SmallRye
microprofile-metrics-smallrye WildFly Extension for Eclipse MicroProfile Metrics With SmallRye
microprofile-opentracing-smallrye WildFly Extension for Eclipse MicroProfile OpenTracing With SmallRye.
modcluster Configuration and runtime operations for mod_cluster subsystem.
naming The configuration of the naming subsystem.
pojo Support JBoss5 and JBoss6 pojo configuration model.
remoting The configuration of the Remoting subsystem.
request-controller The request controller subsystem. Used for request limiting and graceful shutdown
resource-adapters Configuration of the resource adapters subsystem.
rts RTS subsystem
sar The SAR subsystem allowing you to deploy sar archives containing MBeans configured by META-INF/jboss-service.xml
security The configuration of the security subsystem.
security-manager Security Manager subsystem
singleton The configuration of the singleton subsystem
transactions The configuration of the transaction subsystem.
undertow Undertow subsystem
webservices The configuration of the web services subsystem.
weld The configuration of the weld subsystem.
xts The configuration of the XST subsystem.

system-property A list of system properties to set on the server.

Provided capabilities(15)

Name	Dynamic	Other provider points
org.wildfly.management.path.jboss.server.base.dir	false	none
org.wildfly.management.notification-handler-registry	false	none
org.wildfly.management.path.jboss.server.data.dir	false	none
org.wildfly.management.path-manager	false	none
org.wildfly.management.path.jboss.controller.temp.dir	false	none
org.wildfly.management.path.jboss.home.dir	false	none
org.wildfly.management.external-module	false	none
org.wildfly.management.path.jboss.server.log.dir	false	none
org.wildfly.management.executor	false	none
org.wildfly.server.suspend-controller	false	none
org.wildfly.management.model-controller-client-factory	false	none
org.wildfly.management.path.jboss.server.config.dir	false	none
org.wildfly.management.console-availability	false	none
org.wildfly.management.path.jboss.server.temp.dir	false	none
org.wildfly.management.process-state-notifier	false	none

Attributes (19)

launch-type The manner in which the server process was launched. Either "DOMAIN" for a domain mode server launched by a Host Controller, "STANDALONE" for a standalone server launched from the command line, or "EMBEDDED" for a standalone server launched as an embedded part of an application running in the same virtual machine.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only
Allowed Values	DOMAIN STANDALONE EMBEDDED SELF_CONTAINED APPCLIENT

management-major-version The major version of the WildFly Core kernel management interface that is provided by this server.

Attribute	Value
Type	INT
Nillable	false
Expressions Allowed	false
Min	1
Max	2,147,483,647
Storage	configuration
Access Type	read-only

management-micro-version The micro version of the WildFly Core kernel management interface that is provided by this server.

Attribute	Value
Type	INT
Nillable	false
Expressions Allowed	false
Min	0
Max	2,147,483,647
Storage	configuration
Access Type	read-only

management-minor-version The minor version of the WildFly Core kernel management interface that is provided by this server.

Attribute	Value
Type	INT
Nillable	false
Expressions Allowed	false
Min	0
Max	2,147,483,647
Storage	configuration
Access Type	read-only

name The name of this server. If not set, defaults to the runtime value of InetAddress.getLocalHost().getHostName().

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

namespaces Map of namespaces used in the configuration XML document, where keys are namespace prefixes and values are schema URIs.

Attribute	Value
Type	OBJECT
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-only

organization Identification of the current organization running this server.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

process-type The type of process represented by this root resource. Always has a value of "Server" for a server resource.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

product-name The name of the WildFly Core based product that is being run by this server.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-only

product-version The version of the WildFly Core based product release that is being run by this server.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-only

profile-name The name of the server's configuration profile.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-only

release-codename The codename of the WildFly Core release this server is running.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-only

release-version The version of the WildFly Core release this server is running.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-only

running-mode The current running mode of the server. Either NORMAL (normal operations) or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only
Allowed Values	NORMAL ADMIN_ONLY

runtime-configuration-state The current persistent configuration state, one of starting, ok, reload-required, restart-required, stopping or stopped.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

schema-locations Map of locations of XML schemas used in the configuration XML document, where keys are schema URIs and values are locations where the schema can be found.

Attribute	Value
Type	OBJECT
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-only

server-state The current state of the server controller; either STARTING, RUNNING, RESTART_REQUIRED, RELOAD_REQUIRED or STOPPING.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

suspend-state The suspend state of the server

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only
Allowed Values	RUNNING PRE_SUSPEND SUSPENDING SUSPENDED

uuid Unique Id of this server instance.

Attribute	Value
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	runtime
Access Type	read-only

Operations (47)

add-namespace Adds a namespace prefix mapping to the namespaces attribute's map.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
namespace	STRING	true	false		The prefix of the namespace to add
uri	STRING	true	false		The schema uri of the namespace to add.

add-schema-location Adds a schema location mapping to the schema-locations attribute's map.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
schema-location	STRING	true	false		The location where the added schema can be found.
uri	STRING	true	false		The uri of the schema location to add

clean-obsolete-content Clean contents that are not referenced anymore from the content repository.

Reply properties

Two lists of hashes of content items: those that were marked as obsolete and those that were removed from the repository.

type

OBJECT

Value Type

{
    "marked-contents" => {
        "type" => LIST,
        "description" => "List of hashes of content items that were marked as obsolete, making the eligible for future removal from the content repository",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 0L,
        "max-length" => 2147483647L,
        "value-type" => STRING
    },
    "deleted-contents" => {
        "type" => LIST,
        "description" => "List of hashes of content items that were removed from the content repository",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 0L,
        "max-length" => 2147483647L,
        "value-type" => STRING
    }
}

composite An operation that groups multiple operation requests into a single operation request.
Request Parameter Type Required Expressions Allowed Default value Description

steps LIST true false A list of the operation requests that constitute the composite request.
Reply properties
A composite operation response that consists of all the step results.
type

OBJECT

Value Type

OBJECT

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
steps	LIST	true	false		A list of the operation requests that constitute the composite request.

delete-snapshot Deletes a snapshot from the snapshots directory

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		The name of the snapshot to delete. The whole name is not needed, as long as what is passed in uniquely identifies a snapshot within the snapshots directory. If 'all' is used, all snapshots in the snapshot directory will be deleted.

full-replace-deployment Add previously uploaded deployment content to the list of content available for use, replace existing content of the same name in the runtime, and remove the replaced content from the list of content available for use. This is equivalent to an 'add', 'undeploy', 'deploy', 'remove' sequence where the new content has the same name as the content being replaced. Precisely one of 'runtime-name', 'hash', 'input-stream-index', 'bytes' or 'url' must be specified.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Unique identifier of the deployment. Must be unique across all deployments.
runtime-name	STRING	false	false		Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.
content	LIST	true	false		List of pieces of content that comprise the deployment.
enabled	BOOLEAN	false	false	false	Boolean indicating whether the replacement deployment content should be deployed in the runtime (or should be deployed in the runtime the next time the server starts.) An undefined value indicates the state of the existing deployment should be retained.

list-add Add entry to list attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of list attribute to add entry to
value	STRING	false	false	Value to add to list
index	INT	false	false	Optional 0 based index where to insert value to

list-clear Clear all entries from list attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of list attribute
list-get Get entry from list attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of list attribute

index INT false false Index entry to get

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute
index	INT	false	false		Index entry to get

list-remove Remove entry from list attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of list attribute to remove entry from
value	STRING	false	false	Value remove from list
index	INT	false	false	Optional 0 based index to tell what element to remove

list-snapshots Lists the snapshots

Reply properties

type

OBJECT

Value Type

{
    "directory" => {
        "type" => STRING,
        "description" => "The directory where the snapshots are stored",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "names" => {
        "type" => LIST,
        "description" => "The names of the snapshots within the snapshots directory",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 0L,
        "max-length" => 2147483647L,
        "value-type" => STRING
    }
}

map-clear Clear all entries from map attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of list attribute
map-get Get entry from map attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of map attribute

key STRING true false Key of entry to return

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of list attribute

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of map attribute
key	STRING	true	false		Key of entry to return

map-put Add entry to map attribute

Request Parameter	Type	Required	Expressions Allowed	Description
name	STRING	true	false	Name of map attribute to add entry to
key	STRING	true	false	Key under which value will be added
value	STRING	false	false	Value to be added

map-remove Remove entry from map attribute

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false Name of map attribute

key STRING true false Key of entry to remove

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of map attribute
key	STRING	true	false		Key of entry to remove

product-info Get product info report

Reply properties

type

LIST

Value Type

{"summary" => {
    "type" => OBJECT,
    "description" => "Summary of the current server installation.",
    "expressions-allowed" => false,
    "required" => false,
    "nillable" => true,
    "value-type" => {
        "node-name" => {
            "type" => STRING,
            "description" => "The name of the instance node.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "host-name" => {
            "type" => STRING,
            "description" => "The name to use for this host's host controller. Must be unique across the domain. If not set, defaults to the runtime value of InetAddress.getLocalHost().getHostName().",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "instance-identifier" => {
            "type" => STRING,
            "description" => "Unique Id of the server instance.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "product-name" => {
            "type" => STRING,
            "description" => "The name of the product that is being run by this server.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "product-community-identifier" => {
            "type" => STRING,
            "description" => "Indicates the type of distribution, if it is a Product or a Project.",
            "expressions-allowed" => false,
            "required" => true,
            "nillable" => false,
            "min-length" => 1L,
            "max-length" => 2147483647L,
            "allowed" => [
                "Product",
                "Project"
            ]
        },
        "product-version" => {
            "type" => STRING,
            "description" => "The version of the product release that is being run by this server.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "product-home" => {
            "type" => STRING,
            "description" => "Installation directory of the current server instance.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "installation-date" => {
            "type" => STRING,
            "description" => "Installation date of the current server instance.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "last-update-date" => {
            "type" => STRING,
            "description" => "Date of the last update of the current product.",
            "expressions-allowed" => false,
            "required" => false,
            "nillable" => true,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "host-operating-system" => {
            "type" => STRING,
            "description" => "The name of the Operating System.",
            "expressions-allowed" => false,
            "required" => true,
            "nillable" => false,
            "min-length" => 1L,
            "max-length" => 2147483647L
        },
        "jvm" => {
            "type" => OBJECT,
            "description" => "The JVM configuration for the server.",
            "expressions-allowed" => false,
            "required" => true,
            "nillable" => false,
            "value-type" => {
                "java-version" => {
                    "type" => STRING,
                    "description" => "The Java language version.",
                    "expressions-allowed" => false,
                    "required" => false,
                    "nillable" => true,
                    "min-length" => 1L,
                    "max-length" => 2147483647L
                },
                "jvm-version" => {
                    "type" => STRING,
                    "description" => "The complete build version of the JVM.",
                    "expressions-allowed" => false,
                    "required" => false,
                    "nillable" => true,
                    "min-length" => 1L,
                    "max-length" => 2147483647L
                },
                "jvm-vendor" => {
                    "type" => STRING,
                    "description" => "The vendor of the JVM.",
                    "expressions-allowed" => false,
                    "required" => false,
                    "nillable" => true,
                    "min-length" => 1L,
                    "max-length" => 2147483647L
                },
                "java-home" => {
                    "type" => STRING,
                    "description" => "The path to the JVM used by the server instance.",
                    "expressions-allowed" => false,
                    "required" => false,
                    "nillable" => true,
                    "min-length" => 1L,
                    "max-length" => 2147483647L
                }
            }
        },
        "host-cpu" => {
            "type" => OBJECT,
            "description" => "The description of the host CPU (as generated by JVM).",
            "expressions-allowed" => false,
            "required" => true,
            "nillable" => false,
            "value-type" => {
                "host-cpu-arch" => {
                    "type" => STRING,
                    "description" => "The CPU architecture of the host (as generated by JVM).",
                    "expressions-allowed" => false,
                    "required" => false,
                    "nillable" => true,
                    "min-length" => 1L,
                    "max-length" => 2147483647L
                },
                "host-core-count" => {
                    "type" => INT,
                    "description" => "The number of cores available on the host (as generated by JVM).",
                    "expressions-allowed" => false,
                    "required" => false,
                    "nillable" => true,
                    "default" => 1
                }
            }
        }
    }
}}

query query a resource

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
select	LIST	false	false		a list of attribute names to reduce to
where	OBJECT	false	true		a list of filter criteria tuples (i.e. 'running=true')

Reply properties

type

LIST

Value Type

OBJECT

read-attribute Gets the value of an attribute for the selected resource

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
resolve-expressions	BOOLEAN	false	false	false	Resolves expressions to current runtime values
name	STRING	true	false		The name of the attribute to get the value for under the selected resource
include-defaults	BOOLEAN	false	false	true	Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.

Reply properties

The value of the attribute. The type will be that of the attribute found

type: OBJECT

read-attribute-group Gets the value of attributes for the selected group

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of the group to get the attribute
resolve-expressions	BOOLEAN	false	false	false	Resolves expressions to current runtime values
include-runtime	BOOLEAN	false	false	false	Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.
include-defaults	BOOLEAN	false	false	true	Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.
include-aliases	BOOLEAN	false	false	false	If 'true' include attributes which are aliases.

Reply properties

The attributes

type

LIST

Value Type

PROPERTY

read-attribute-group-names Gets the names of all the attribute groups under the selected resource
Reply properties
type

LIST

Value Type

STRING

read-children-names Gets the names of all children under the selected resource with the given type

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
child-type	STRING	true	false		The name of the node under which to get the children names
include-singletons	BOOLEAN	false	false	false	If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.

Reply properties

The children names

type

LIST

Value Type

STRING

read-children-resources Reads information about all of a resource's children that are of a given type

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
child-type	STRING	true	false		The name of the resource under which to get the child resources
recursive	BOOLEAN	false	false		Whether to get the children recursively. If absent, false is the default
recursive-depth	INT	false	false		The depth to which information about child resources should be included.
proxies	BOOLEAN	false	false	false	Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default
include-runtime	BOOLEAN	false	false	false	Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.
include-defaults	BOOLEAN	false	false	true	Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.

Reply properties

The children resources

type

LIST

Value Type

OBJECT

read-children-types Gets the type names of all the children under the selected resource

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
include-aliases	BOOLEAN	false	false	false	If 'true' include children which are aliases.
include-singletons	BOOLEAN	false	false	false	If 'true' include the full key/value pair for any singleton registration.

Reply properties

The children types

type

LIST

Value Type

STRING

read-config-as-xml Reads the current configuration and returns it in XML format.

Reply properties

type

STRING

read-operation-description Gets description of given operation

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		Name of operation
locale	STRING	false	false		Locale in which to return description
access-control	BOOLEAN	false	false	false	Whether or not to include information about what rights the current user has on the operation.

Reply properties

type: OBJECT

read-operation-names Gets the names of all the operations for the given resource

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
access-control	BOOLEAN	false	false	false	If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.

Reply properties

The operation names

type

LIST

Value Type

STRING

read-resource Reads a model resource's attribute values along with either basic or complete information about any child resources

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
resolve-expressions	BOOLEAN	false	false	false	Resolves expressions to current runtime values
recursive	BOOLEAN	false	false		Whether to include complete information about child resources, recursively. If absent, false is the default
recursive-depth	INT	false	false		The depth to which information about child resources should be included.
proxies	BOOLEAN	false	false	false	Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.
include-runtime	BOOLEAN	false	false	false	Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.
include-defaults	BOOLEAN	false	false	true	Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.
attributes-only	BOOLEAN	false	false	false	Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.
include-aliases	BOOLEAN	false	false	false	If 'true' and recursive, include children which are aliases.

Reply properties

The resource's attribute values along with information about any child resources

type: OBJECT

read-resource-description Gets the description of a resource's attributes, types of children and, optionally, operations

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
operations	BOOLEAN	false	false	false	Whether to include descriptions of the resource's operations. Default is false
notifications	BOOLEAN	false	false	false	Whether to include descriptions of the resource's notifications. Default is false
inherited	BOOLEAN	false	false	true	If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.
recursive	BOOLEAN	false	false		Whether to include recursively descriptions of child resources. Default is false.
recursive-depth	INT	false	false		The depth to which information about child resources should be included.
proxies	BOOLEAN	false	false	false	Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default
include-aliases	BOOLEAN	false	false	false	If 'true' and recursive, include children which are aliases.
access-control	STRING	false	false	none	Include information about what rights the current user has on the actual resources, attributes and operations.
locale	STRING	false	false		The locale to get the resource description in. If null, the default locale will be used

Reply properties

The description of the resource

type: OBJECT

reload Reloads the server by shutting down all its services and starting again. The JVM itself is not restarted.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
admin-only	BOOLEAN	false	false	false	Whether the server should start in running mode ADMIN_ONLY when it restarts. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests.
use-current-server-config	BOOLEAN	false	false	true	Only has an effect if --read-only-server-config was specified when starting the server. In that case, if this parameter is set to false the reloaded server loads the original configuration version; if null or true the current runtime version of the model is used.
server-config	STRING	false	false		Use to override the name of the server config to use for the reloaded server. When making changes to the model after the reload, the changes will still be persisted to the original server configuration file that was first used to boot up the server. This parameter is resolved the same way as the --server-config command-line option.
start-mode	STRING	false	false	normal	Can be either normal, suspend or admin-only. If it is suspend the server will be started in suspended mode, if it is admin only the server will be started in admin-only mode.

remove-namespace Removes a namespace prefix mapping from the namespaces attribute's map.

Request Parameter Type Required Expressions Allowed Default value Description

namespace STRING true false The prefix of the namespace to remove.
remove-schema-location Removes a schema location mapping from the schema-locations attribute's map.

Request Parameter Type Required Expressions Allowed Default value Description

uri STRING true false The URI of the schema location to remove.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
namespace	STRING	true	false		The prefix of the namespace to remove.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
uri	STRING	true	false		The URI of the schema location to remove.

replace-deployment Replace existing content in the runtime with new content. The new content must have been previously uploaded to the deployment content repository.

Request Parameter	Type	Required	Expressions Allowed	Description
to-replace	STRING	true	false	The name of the content that is to be replaced.
name	STRING	true	false	The name of the new content.
runtime-name	STRING	false	false	Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.
content	LIST	false	false	List of pieces of content that comprise the deployment.

resolve-expression Operation that accepts an expression as input (or a string that can be parsed into an expression) and resolves it against the local system properties and environment variables.

Request Parameter Type Required Expressions Allowed Default value Description

expression STRING false true The expression to resolve.

Reply properties

The resolved expression, or the string form of the original input value if it did not represent an expression.

type

STRING

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
expression	STRING	false	true		The expression to resolve.

resolve-internet-address Takes a set of interface resolution criteria and finds an IP address on the local machine that matches the criteria, or fails if no matching IP address can be found.

Request Parameter	Type	Required	Expressions Allowed	Description
any-address	BOOLEAN	false	false	Any address
inet-address	STRING	false	true	Inet address
link-local-address	BOOLEAN	false	false	Link local address
loopback	BOOLEAN	false	false	Loopback
loopback-address	STRING	false	true	Loopback address
multicast	BOOLEAN	false	false	Multicast
nic	STRING	false	true	NIC
nic-match	STRING	false	true	NIC match
point-to-point	BOOLEAN	false	false	Point to point
public-address	BOOLEAN	false	false	Public address
site-local-address	BOOLEAN	false	false	Site local address
subnet-match	STRING	false	true	Subnet match
up	BOOLEAN	false	false	Up
virtual	BOOLEAN	false	false	Virtual
any	OBJECT	false	false	any
not	OBJECT	false	false	Not

Reply properties

type: STRING

resume Resumes normal operations on a suspended server.

shutdown Shuts down the server via a call to System.exit(0)

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
restart	BOOLEAN	false	false	false	If true, once shutdown the server will be restarted again
timeout	INT	false	false	0	If this timeout is set a graceful shutdown will be attempted. If this is zero (the default) then the server will shutdown immediately. A value larger than zero means the server will wait up to this many seconds for all active requests to finish. A value smaller than zero means that the server will wait indefinitely for all active requests to finish.
suspend-timeout	INT	false	false	0	The graceful shutdown timeout in seconds. If this is zero (the default) then the server will shutdown immediately. A value larger than zero means the server will wait up to this many seconds for all active requests to finish. A value smaller than zero means that the server will wait indefinitely for all active requests to finish.

suspend Suspends server operations gracefully. All current requests will complete normally, however no new requests will be accepted.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
timeout	INT	false	false	0	The timeout that a suspend operation will wait for the suspend operation to complete before returning. If this is zero the operation will return immediately, -1 means that it will wait indefinitely. Note that the operation will not roll back if the timeout is exceeded, it just means that not all current requests completed in the specified timeout.
suspend-timeout	INT	false	false	0	The suspend operation timeout in seconds. If this is zero (the default) the operation will return immediately. A value larger than zero means the operation will wait up to this many seconds to complete before returning. A value smaller than zero means that the operation will wait indefinitely for all active requests to finish. Note that the operation will not roll back if the timeout is exceeded, it just means that not all current requests completed in the specified timeout.

take-snapshot Takes a snapshot of the current configuration

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
comment	STRING	false	false		Comment on the snapshot being taken.
name	STRING	false	false		The name of the snapshot being taken.

Reply properties

The location of the file on the machine the configuration belongs

type: STRING

undefine-attribute Sets the value of an attribute of the selected resource to 'undefined'

Request Parameter Type Required Expressions Allowed Default value Description

name STRING true false The name of the attribute which should be set to 'undefined'

upload-deployment-bytes Indicates that the deployment content in the included byte array should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
bytes	BYTES	true	false		Byte array containing the deployment content that should uploaded to the domain's or standalone server's deployment content repository.

Reply properties

The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.

type: BYTES

upload-deployment-stream Indicates that the deployment content available at the included input stream index should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
input-stream-index	INT	true	false		The index into the operation's attached input streams of the input stream that contains deployment content that should be uploaded to the domain's or standalone server's deployment content repository.

Reply properties

The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.

type: BYTES

upload-deployment-url Indicates that the deployment content available at the included URL should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
url	STRING	true	false		The URL at which the deployment content is available for upload to the domain's or standalone server's deployment content repository.. Note that the URL must be accessible from the target of the operation (i.e. the Domain Controller or standalone server).

Reply properties

The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.

type: BYTES

validate-address Checks whether a resource with the address passed in as the argument exists.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
value	OBJECT	true	false		The address to check.

Reply properties

Report of checking the address.

type

OBJECT

Value Type

{
    "valid" => {
        "type" => BOOLEAN,
        "description" => "Indicates whether a resource with the address passed in as the argument exists.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "problem" => {
        "type" => STRING,
        "description" => "Is included only if the address is not valid and describes what's wrong with the address.",
        "expressions-allowed" => false,
        "required" => false,
        "nillable" => true,
        "min-length" => 1L,
        "max-length" => 2147483647L
    }
}

validate-operation Validates that an operation is valid according to its description. Any errors present will be shown in the operation's failure-description.

Request Parameter Type Required Expressions Allowed Default value Description

value OBJECT true false The operation to validate.
whoami Returns the identity of the currently authenticated user.

Request Parameter Type Required Expressions Allowed Default value Description

verbose BOOLEAN false false false If set to true whoami also returns the users roles.

Reply properties

The identify of the authenticated user and their roles if requested.

type

STRING

write-attribute Sets the value of an attribute for the selected resource

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		The name of the attribute to set the value for under the selected resource
value	STRING	false	false		The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.

write-config An operation to force the server to write its config file, without making any actual config change.