JBoss EAP 6.0 Model Reference

  1. JBoss EAP 6.0

The root node of the server-level management model.

Children (8)

  • core-service Core services provided by the server.
    • management The management services used to control a standalone server or a host's host controller in a management domain.
    • 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, java.nio and java.util.logging 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.
  • 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 A list of socket bindings available for use on the server.
  • subsystem The subsystems that make up the server's profile.
    • cmp The configuration of the cmp subsystem.
    • configadmin The ConfigAdmin subsystem configuration.
    • datasources The data-sources subsystem, used to declare JDBC data-sources
    • deployment-scanner An individual deployment scanner that scans a particular location
    • ee The configuration of the EE subsystem.
    • ejb3 The configuration of the ejb3 subsystem.
    • infinispan The configuration of the infinispan subsystem
    • jacorb The JacORB subsystem configuration.
    • jaxr The configuration of the JAXR subsystem.
    • jaxrs The configuration of the JAX-RS subsystem.
    • jca The Java 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.
    • jsr77 The configuration of the JSR-77 subsystem.
    • logging The configuration of the logging subsystem.
    • mail The mail subsystem
    • messaging The messaging subsystem.
    • modcluster The configuration of the modcluster subsystem.
    • naming The configuration of the naming subsystem.
    • osgi The OSGi subsystem configuration
    • pojo Support JBoss5 and JBoss6 pojo configuration model.
    • remoting The configuration of the Remoting subsystem.
    • resource-adapters Configuration of the resource adapters 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.
    • threads The threading subsystem, used to declare manageable thread pools and resources.
    • transactions The configuration of the transaction subsystem.
    • web The configuration of the jboss.web 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.

Attributes (13)

  • 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
  • management-major-version The major version of the JBoss AS management interface that is provided by this server.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Min 1
    Storage configuration
    Access Type read-only
  • management-minor-version The minor version of the JBoss AS management interface that is provided by this server.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Min 1
    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 true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • 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 JBoss AS 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 JBoss AS 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 JBoss Application Server 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 JBoss Application Server release this server is running.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    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 true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • server-state The current state of the server controller; either STARTING, RUNNING or RESTART_REQUIRED
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only

Operations (31)

  • 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
    uri STRING true false The uri of the schema location to add
    schema-location STRING true false The location where the added schema can be found.
  • 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.
  • list-snapshots Lists the snapshots

    Reply properties

    type
    OBJECT
    Value Type
    {
    "directory" => {
        "type" => STRING,
        "description" => "The directory where the snapshots are stored"
    },
    "names" => {
        "type" => LIST,
        "value-type" => STRING,
        "description" => "The names of the snapshots within the snapshots directory"
    }
}
  • read-attribute Gets the value of an attribute for the selected resource
    Request Parameter Type Required Expressions Allowed Default value Description
    name STRING false 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-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 false false The name of the node under which to get the children names

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

    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

    The XML form of the persistent configuration.
    type
    STRING
  • read-operation-description Gets the details of an operation on the given resource
    Request Parameter Type Required Expressions Allowed Default value Description
    name STRING true false The description of the operation. Undefined if not found
    locale STRING false false The locale to get the operation description in. If null, the default locale will be used

    Reply properties

    The description of the operation. Undefined if not found
    type
    OBJECT
  • read-operation-names Gets the names of all the operations for the given resource

    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
    recursive BOOLEAN false 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.

    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 Whether to include descriptions of the resource's operations. Default is false
    inherited BOOLEAN false false 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.
    proxies BOOLEAN 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
    recursive-depth INT false false The depth to which information about child resources should be included.
    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 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.
  • 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.
  • 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 Default value Description
    name STRING true false The name of the new content.
    to-replace STRING true false The name of the content that is to be replaced.
    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'.
  • 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
  • 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 Default value Description
    any-address BOOLEAN false false Attribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic.
    any-ipv4-address BOOLEAN false false Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0).
    any-ipv6-address BOOLEAN false false Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::).
    inet-address STRING false true Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.
    link-local-address BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.
    loopback BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.
    loopback-address STRING false true Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.
    multicast BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.
    nic STRING false true Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.
    nic-match STRING false true Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.
    point-to-point BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection
    public-address BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection
    site-local-address BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection
    subnet-match STRING false true Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in "slash notation"; e.g. "192.168.0.0/16". An 'undefined' value means this attribute is not relevant to the IP address selection.
    up BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection
    virtual BOOLEAN false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection
    any OBJECT false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address meets at least one of a nested set of criteria, but not necessarily all of the nested criteria. The value of the attribute is a set of criteria. An 'undefined' value means this attribute is not relevant to the IP address selection.
    not OBJECT false false Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address *does not* meet any of a nested set of criteria. The value of the attribute is a set of criteria (e.g. 'loopback') whose normal meaning is reversed. An 'undefined' value means this attribute is not relevant to the IP address selection.

    Reply properties

    The IP address string in textual presentation.
    type
    STRING
  • server-set-restart-required Puts the server into a restart-required mode.
  • 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
  • take-snapshot Takes a snapshot of the current configuration

    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 false 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" => {
        "description" => "Indicates whether a resource with the address passed in as the argument exists.",
        "type" => BOOLEAN
    },
    "problem" => {
        "description" => "Is included only if the address is not valid and describes what's wrong with the address.",
        "type" => STRING
    }
}
  • 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.
  • write-attribute Sets the value of an attribute for the selected resource
    Request Parameter Type Required Expressions Allowed Default value Description
    name STRING false 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.