Management API Reference for root

Children (9)

• core-service
  • capability-registry
  • management
  • module-loading
  • platform-mbean
  • server-environment
  • service-container
• deployment
• deployment-overlay
• extension
• interface
• path
• socket-binding-group
• subsystem
  • batch-jberet
  • bean-validation
  • core-management
  • datasources
  • deployment-scanner
  • discovery
  • distributable-ejb
  • distributable-web
  • ee
  • ee-security
  • ejb3
  • elytron
  • elytron-oidc-client
  • health
  • iiop-openjdk
  • infinispan
  • io
  • jakarta-data
  • jaxrs
  • jca
  • jdr
  • jgroups
  • jmx
  • jpa
  • jsf
  • jsr77
  • logging
  • mail
  • messaging-activemq
  • metrics
  • micrometer
  • microprofile-config-smallrye
  • microprofile-fault-tolerance-smallrye
  • microprofile-health-smallrye
  • microprofile-jwt-smallrye
  • microprofile-lra-coordinator
  • microprofile-lra-participant
  • microprofile-metrics-smallrye
  • microprofile-openapi-smallrye
  • microprofile-opentracing-smallrye
  • microprofile-reactive-messaging-smallrye
  • microprofile-reactive-streams-operators-smallrye
  • microprofile-telemetry
  • modcluster
  • mvc-krazo
  • naming
  • opentelemetry
  • pojo
  • remoting
  • request-controller
  • resource-adapters
  • rts
  • sar
  • security
  • security-manager
  • singleton
  • transactions
  • undertow
  • webservices
  • weld
  • xts
• system-property

Provided Capabilities (16)

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.

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Allowed Values	DOMAIN STANDALONE EMBEDDED SELF_CONTAINED APPCLIENT
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : true, "nillable" : false, "allowed" : [ "DOMAIN", "STANDALONE", "EMBEDDED", "SELF_CONTAINED", "APPCLIENT" ], "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

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

  Type	INT
  Where is the attribute stored?	configuration
  Access Type	read-only
  Min	1
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The major version of the WildFly Core kernel management interface that is provided by this server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	INT
  Where is the attribute stored?	configuration
  Access Type	read-only
  Min	0
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The micro version of the WildFly Core kernel management interface that is provided by this server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	INT
  Where is the attribute stored?	configuration
  Access Type	read-only
  Min	0
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The minor version of the WildFly Core kernel management interface that is provided by this server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of this server. If not set, defaults to the runtime value of InetAddress.getLocalHost().getHostName().", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

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

  Type	OBJECT
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Map of namespaces used in the configuration XML document, where keys are namespace prefixes and values are schema URIs.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• organization - Identification of the current organization running this server.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Identification of the current organization running this server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

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

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of process represented by this root resource. Always has a value of \"Server\" for a server resource.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the WildFly Core based product that is being run by this server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The version of the WildFly Core based product release that is being run by this server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the server's configuration profile.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The codename of the WildFly Core release this server is running.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The version of the WildFly Core release this server is running.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

• 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.

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Allowed Values	ADMIN_ONLY NORMAL
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : true, "nillable" : false, "allowed" : [ "NORMAL", "ADMIN_ONLY" ], "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The current persistent configuration state, one of starting, ok, reload-required, restart-required, stopping or stopped.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• 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.

  Type	OBJECT
  Where is the attribute stored?	configuration
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "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.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }

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

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The current state of the server controller; either STARTING, RUNNING, RESTART_REQUIRED, RELOAD_REQUIRED or STOPPING.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• suspend-state - The suspend state of the server

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Allowed Values	SUSPENDING RUNNING SUSPENDED PRE_SUSPEND
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The suspend state of the server", "expressions-allowed" : false, "required" : true, "nillable" : false, "allowed" : [ "RUNNING", "PRE_SUSPEND", "SUSPENDING", "SUSPENDED" ], "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• uuid - Unique Id of this server instance.

  Type	STRING
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Unique Id of this server instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (48)

• 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.

  Raw DMR model

  { "operation-name" : "add-namespace", "description" : "Adds a namespace prefix mapping to the namespaces attribute's map.", "request-properties" : { "namespace" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The prefix of the namespace to add", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "uri" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The schema uri of the namespace to add.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "add-schema-location", "description" : "Adds a schema location mapping to the schema-locations attribute's map.", "request-properties" : { "schema-location" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The location where the added schema can be found.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "uri" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The uri of the schema location to add", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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" => 0,
          "max-length" => 2147483647,
          "stability" => "default",
          "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" => 0,
          "max-length" => 2147483647,
          "stability" => "default",
          "value-type" => STRING
      }
  }

  Raw DMR model

  { "operation-name" : "clean-obsolete-content", "description" : "Clean contents that are not referenced anymore from the content repository.", "request-properties" : {}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "value-type" : { "marked-contents" : { "type" : { "TYPE_MODEL_VALUE" : "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" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "deleted-contents" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of hashes of content items that were removed from the content repository", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } }, "description" : "Two lists of hashes of content items: those that were marked as obsolete and those that were removed from the repository." }, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "composite", "description" : "An operation that groups multiple operation requests into a single operation request.", "request-properties" : {"steps" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of the operation requests that constitute the composite request.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "OBJECT" } }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "value-type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A composite operation response that consists of all the step results." }, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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.

  Raw DMR model

  { "operation-name" : "delete-snapshot", "description" : "Deletes a snapshot from the snapshots directory", "request-properties" : {"name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }}, "reply-properties" : {}, "access-constraints" : {"sensitive" : {"snapshots" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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.

  Raw DMR model

  { "operation-name" : "full-replace-deployment", "description" : "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-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Unique identifier of the deployment. Must be unique across all deployments.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "runtime-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "content" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of pieces of content that comprise the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 1, "stability" : "default", "value-type" : { "input-stream-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "hash", "bytes", "url", "path", "relative-to", "empty" ], "min" : 1, "max" : 2147483647, "filesystem-path" : true, "attached-streams" : true, "stability" : "default" }, "hash" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url", "path", "relative-to", "empty" ], "min-length" : 20, "max-length" : 20, "stability" : "default" }, "bytes" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "Byte array containing the deployment content that should uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "url", "path", "relative-to", "empty" ], "stability" : "default" }, "url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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).", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "path", "relative-to", "empty" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path (relative or absolute) to unmanaged content that is part of the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "url", "empty" ], "requires" : ["archive"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "relative-to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of a system path to which the value of the 'path' is relative. If not set, the 'path' is considered to be absolute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "url", "empty" ], "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "archive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether unmanaged content is a zip archive (true) or exploded (false).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url" ], "requires" : [ "path", "hash", "empty" ], "stability" : "default" }, "empty" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates that the deployment to be added is empty - so without any content.", "expressions-allowed" : false, "required" : true, "nillable" : true, "default" : false, "alternatives" : [ "hash", "input-stream-index", "bytes", "url", "path", "relative-to" ], "stability" : "default" } } }, "enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : {}, "access-constraints" : {"application" : {"deployment" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• list-add - Add entry to list attribute

  Request Parameter	Type	Required	Expressions Allowed	Default value	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

  Raw DMR model

  { "operation-name" : "list-add", "description" : "Add entry to list attribute", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of list attribute to add entry to", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Value to add to list", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Optional 0 based index where to insert value to", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "list-clear", "description" : "Clear all entries from list attribute", "request-properties" : {"name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of list attribute", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "list-get", "description" : "Get entry from list attribute", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of list attribute", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Index entry to get", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : true, "runtime-only" : false }

• list-remove - Remove entry from list attribute

  Request Parameter	Type	Required	Expressions Allowed	Default value	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

  Raw DMR model

  { "operation-name" : "list-remove", "description" : "Remove entry from list attribute", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of list attribute to remove entry from", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Value remove from list", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Optional 0 based index to tell what element to remove", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      },
      "names" => {
          "type" => LIST,
          "description" => "The names of the snapshots within the snapshots directory",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 0,
          "max-length" => 2147483647,
          "stability" => "default",
          "value-type" => STRING
      }
  }

  Raw DMR model

  { "operation-name" : "list-snapshots", "description" : "Lists the snapshots", "request-properties" : {}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "value-type" : { "directory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The directory where the snapshots are stored", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "names" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The names of the snapshots within the snapshots directory", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } } }, "access-constraints" : {"sensitive" : {"snapshots" : {"type" : "core"}}}, "stability" : "default", "read-only" : true, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "map-clear", "description" : "Clear all entries from map attribute", "request-properties" : {"name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of list attribute", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "map-get", "description" : "Get entry from map attribute", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of map attribute", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Key of entry to return", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : true, "runtime-only" : false }

• map-put - Add entry to map attribute

  Request Parameter	Type	Required	Expressions Allowed	Default value	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

  Raw DMR model

  { "operation-name" : "map-put", "description" : "Add entry to map attribute", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of map attribute to add entry to", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Key under which value will be added", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Value to be added", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "map-remove", "description" : "Remove entry from map attribute", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of map attribute", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Key of entry to remove", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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,
      "stability" => "default",
      "value-type" => {
          "node-name" => {
              "type" => STRING,
              "description" => "The name of the instance node.",
              "expressions-allowed" => false,
              "required" => false,
              "nillable" => true,
              "min-length" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "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" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "instance-identifier" => {
              "type" => STRING,
              "description" => "Unique Id of the server instance.",
              "expressions-allowed" => false,
              "required" => false,
              "nillable" => true,
              "min-length" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "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" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "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" => 1,
              "max-length" => 2147483647,
              "allowed" => [
                  "Product",
                  "Project"
              ],
              "stability" => "default"
          },
          "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" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "product-home" => {
              "type" => STRING,
              "description" => "Installation directory of the current server instance.",
              "expressions-allowed" => false,
              "required" => false,
              "nillable" => true,
              "min-length" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "installation-date" => {
              "type" => STRING,
              "description" => "Installation date of the current server instance.",
              "expressions-allowed" => false,
              "required" => false,
              "nillable" => true,
              "min-length" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "last-update-date" => {
              "type" => STRING,
              "description" => "Date of the last update of the current product.",
              "expressions-allowed" => false,
              "required" => false,
              "nillable" => true,
              "min-length" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "host-operating-system" => {
              "type" => STRING,
              "description" => "The name of the Operating System.",
              "expressions-allowed" => false,
              "required" => true,
              "nillable" => false,
              "min-length" => 1,
              "max-length" => 2147483647,
              "stability" => "default"
          },
          "jvm" => {
              "type" => OBJECT,
              "description" => "The JVM configuration for the server.",
              "expressions-allowed" => false,
              "required" => true,
              "nillable" => false,
              "stability" => "default",
              "value-type" => {
                  "java-version" => {
                      "type" => STRING,
                      "description" => "The Java language version.",
                      "expressions-allowed" => false,
                      "required" => false,
                      "nillable" => true,
                      "min-length" => 1,
                      "max-length" => 2147483647,
                      "stability" => "default"
                  },
                  "jvm-version" => {
                      "type" => STRING,
                      "description" => "The complete build version of the JVM.",
                      "expressions-allowed" => false,
                      "required" => false,
                      "nillable" => true,
                      "min-length" => 1,
                      "max-length" => 2147483647,
                      "stability" => "default"
                  },
                  "jvm-vendor" => {
                      "type" => STRING,
                      "description" => "The vendor of the JVM.",
                      "expressions-allowed" => false,
                      "required" => false,
                      "nillable" => true,
                      "min-length" => 1,
                      "max-length" => 2147483647,
                      "stability" => "default"
                  },
                  "java-home" => {
                      "type" => STRING,
                      "description" => "The path to the JVM used by the server instance.",
                      "expressions-allowed" => false,
                      "required" => false,
                      "nillable" => true,
                      "min-length" => 1,
                      "max-length" => 2147483647,
                      "stability" => "default"
                  }
              }
          },
          "host-cpu" => {
              "type" => OBJECT,
              "description" => "The description of the host CPU (as generated by JVM).",
              "expressions-allowed" => false,
              "required" => true,
              "nillable" => false,
              "stability" => "default",
              "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" => 1,
                      "max-length" => 2147483647,
                      "stability" => "default"
                  },
                  "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,
                      "stability" => "default"
                  }
              }
          }
      }
  }}

  Raw DMR model

  { "operation-name" : "product-info", "description" : "Get product info report", "request-properties" : {}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : {"summary" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Summary of the current server installation.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "node-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the instance node.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "host-name" : { "type" : { "TYPE_MODEL_VALUE" : "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" : 1, "max-length" : 2147483647, "stability" : "default" }, "instance-identifier" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Unique Id of the server instance.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "product-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the product that is being run by this server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "product-community-identifier" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates the type of distribution, if it is a Product or a Project.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "Product", "Project" ], "stability" : "default" }, "product-version" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The version of the product release that is being run by this server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "product-home" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Installation directory of the current server instance.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "installation-date" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Installation date of the current server instance.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "last-update-date" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Date of the last update of the current product.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "host-operating-system" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the Operating System.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "jvm" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The JVM configuration for the server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "java-version" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Java language version.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "jvm-version" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The complete build version of the JVM.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "jvm-vendor" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The vendor of the JVM.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "java-home" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path to the JVM used by the server instance.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "host-cpu" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The description of the host CPU (as generated by JVM).", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "host-cpu-arch" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The CPU architecture of the host (as generated by JVM).", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "host-core-count" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of cores available on the host (as generated by JVM).", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : 1, "stability" : "default" } } } } }} }, "stability" : "default", "read-only" : true, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "query", "description" : "query a resource", "request-properties" : { "select" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "a list of attribute names to reduce to", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "where" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "OBJECT" } }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.
  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

  Raw DMR model

  { "operation-name" : "read-attribute", "description" : "Gets the value of an attribute for the selected resource", "request-properties" : { "resolve-expressions" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the attribute to get the value for under the selected resource", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "include-defaults" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The value of the attribute. The type will be that of the attribute found" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "read-attribute-group", "description" : "Gets the value of attributes for the selected group", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the group to get the attribute", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "resolve-expressions" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Resolves expressions to current runtime values", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-runtime" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-defaults" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "include-aliases" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' include attributes which are aliases.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "PROPERTY" }, "description" : "The attributes" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• read-attribute-group-names - Gets the names of all the attribute groups under the selected resource

  Reply properties

  Type

  LIST

  Value Type

  
  STRING

  Raw DMR model

  { "operation-name" : "read-attribute-group-names", "description" : "Gets the names of all the attribute groups under the selected resource", "request-properties" : {}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "read-children-names", "description" : "Gets the names of all children under the selected resource with the given type", "request-properties" : { "child-type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the node under which to get the children names", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "include-singletons" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The children names" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "read-children-resources", "description" : "Reads information about all of a resource's children that are of a given type", "request-properties" : { "child-type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the resource under which to get the child resources", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "recursive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "recursive-depth" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The depth to which information about child resources should be included.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min" : 0, "max" : 2147483647, "stability" : "default" }, "proxies" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-runtime" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-defaults" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The children resources" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "read-children-types", "description" : "Gets the type names of all the children under the selected resource", "request-properties" : { "include-aliases" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' include children which are aliases.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-singletons" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The children types" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

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

  Use the operation 'read-config-as-xml-file' instead.

  Reply properties

  Type

  STRING

  Raw DMR model

  { "operation-name" : "read-config-as-xml", "description" : "Reads the current configuration and returns it in XML format.", "request-properties" : {}, "reply-properties" : {"type" : { "TYPE_MODEL_VALUE" : "STRING" }}, "deprecated" : { "since" : "24.0.0", "reason" : "Use the operation 'read-config-as-xml-file' instead." }, "access-constraints" : {"sensitive" : {"read-whole-config" : {"type" : "core"}}}, "stability" : "default", "read-only" : true, "runtime-only" : true }

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

  Reply properties

  The uuid of the attachement for the file.

  Type

  STRING

  Raw DMR model

  { "operation-name" : "read-config-as-xml-file", "description" : "Reads the current configuration and returns it as a file in XML format.", "request-properties" : {}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The uuid of the attachement for the file.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "access-constraints" : {"sensitive" : {"read-whole-config" : {"type" : "core"}}}, "stability" : "default", "read-only" : true, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "read-operation-description", "description" : "Gets description of given operation", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of operation", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "locale" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Locale in which to return description", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "access-control" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : {"type" : { "TYPE_MODEL_VALUE" : "OBJECT" }}, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "read-operation-names", "description" : "Gets the names of all the operations for the given resource", "request-properties" : {"access-control" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The operation names" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.
  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

  Raw DMR model

  { "operation-name" : "read-resource", "description" : "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" : { "resolve-expressions" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "recursive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "recursive-depth" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The depth to which information about child resources should be included.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min" : 0, "max" : 2147483647, "stability" : "default" }, "proxies" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-runtime" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-defaults" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "attributes-only" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-aliases" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' and recursive, include children which are aliases.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The resource's attribute values along with information about any child resources" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "read-resource-description", "description" : "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" : { "operations" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "notifications" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "inherited" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "recursive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "recursive-depth" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The depth to which information about child resources should be included.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min" : 0, "max" : 2147483647, "stability" : "default" }, "proxies" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "include-aliases" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If 'true' and recursive, include children which are aliases.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "access-control" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "none", "allowed" : [ "none", "combined-descriptions", "trim-descriptions" ], "stability" : "default" }, "locale" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The description of the resource" }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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.

  Raw DMR model

  { "operation-name" : "reload", "description" : "Reloads the server by shutting down all its services and starting again. The JVM itself is not restarted.", "request-properties" : { "admin-only" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "alternatives" : ["start-mode"], "stability" : "default", "deprecated" : { "since" : "5.0.0", "reason" : "Use start-mode=admin-only instead." } }, "use-current-server-config" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "alternatives" : ["server-config"], "stability" : "default" }, "server-config" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["use-current-server-config"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "start-mode" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "normal", "alternatives" : ["admin-only"], "allowed" : [ "normal", "admin-only", "suspend" ], "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 🅲  reload-enhanced - Reloads the server by shutting down all its services and starting again. The JVM itself is not restarted. This is similar to the 'reload' operation, but exposes some more advanced options.

  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.
  stability	STRING	false	false		Set to change the stability level of the reloaded server.

  Raw DMR model

  { "operation-name" : "reload-enhanced", "description" : "Reloads the server by shutting down all its services and starting again. The JVM itself is not restarted. This is similar to the 'reload' operation, but exposes some more advanced options.", "request-properties" : { "admin-only" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "alternatives" : ["start-mode"], "stability" : "default", "deprecated" : { "since" : "5.0.0", "reason" : "Use start-mode=admin-only instead." } }, "use-current-server-config" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "alternatives" : ["server-config"], "stability" : "default" }, "server-config" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["use-current-server-config"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "start-mode" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "normal", "alternatives" : ["admin-only"], "allowed" : [ "normal", "admin-only", "suspend" ], "stability" : "default" }, "stability" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Set to change the stability level of the reloaded server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "allowed" : [ "default", "community", "preview", "experimental" ], "stability" : "community" } }, "reply-properties" : {}, "access-constraints" : {"sensitive" : {"reload-enhanced" : {"type" : "core"}}}, "stability" : "community", "read-only" : false, "runtime-only" : true }

• 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.

  Raw DMR model

  { "operation-name" : "remove-namespace", "description" : "Removes a namespace prefix mapping from the namespaces attribute's map.", "request-properties" : {"namespace" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The prefix of the namespace to remove.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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.

  Raw DMR model

  { "operation-name" : "remove-schema-location", "description" : "Removes a schema location mapping from the schema-locations attribute's map.", "request-properties" : {"uri" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The URI of the schema location to remove.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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
  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.

  Raw DMR model

  { "operation-name" : "replace-deployment", "description" : "Replace existing content in the runtime with new content. The new content must have been previously uploaded to the deployment content repository.", "request-properties" : { "to-replace" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the content that is to be replaced.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the new content.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "runtime-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "content" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of pieces of content that comprise the deployment.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 1, "stability" : "default", "value-type" : { "input-stream-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "hash", "bytes", "url", "path", "relative-to" ], "min" : 1, "max" : 2147483647, "filesystem-path" : true, "attached-streams" : true, "stability" : "default" }, "hash" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url", "path", "relative-to" ], "min-length" : 20, "max-length" : 20, "stability" : "default" }, "bytes" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "Byte array containing the deployment content that should uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "url", "path", "relative-to" ], "stability" : "default" }, "url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "path", "relative-to" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Path (relative or absolute) to unmanaged content that is part of the deployment.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "url" ], "requires" : ["archive"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "relative-to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of a system path to which the value of the 'path' is relative. If not set, the 'path' is considered to be absolute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "hash", "bytes", "url" ], "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "archive" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether unmanaged content is a zip archive (true) or exploded (false).", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "input-stream-index", "bytes", "url" ], "requires" : [ "path", "hash", "empty" ], "stability" : "default" } } } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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. Expressions requiring resolution using other sources will not be resolved.

  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 that could be resolved against the local system properties and environment variables.

  Type

  STRING

  Raw DMR model

  { "operation-name" : "resolve-expression", "description" : "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. Expressions requiring resolution using other sources will not be resolved.", "request-properties" : {"expression" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The expression to resolve.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The resolved expression, or the string form of the original input value if it did not represent an expression that could be resolved against the local system properties and environment variables.", "nillable" : true }, "access-constraints" : {"sensitive" : { "system-property" : {"type" : "core"}, "jvm" : {"type" : "core"} }}, "stability" : "default", "read-only" : true, "runtime-only" : true }

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

  Raw DMR model

  { "operation-name" : "resolve-internet-address", "description" : "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-properties" : { "any-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Any address", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : [ "inet-address", "link-local-address", "loopback", "loopback-address", "multicast", "nic", "nic-match", "point-to-point", "public-address", "site-local-address", "subnet-match", "up", "virtual", "any", "not" ], "stability" : "default" }, "inet-address" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Inet address", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "link-local-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Link local address", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "loopback" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Loopback", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "loopback-address" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Loopback address", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "multicast" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Multicast", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "nic" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "NIC", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "nic-match" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "NIC match", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "point-to-point" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Point to point", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "public-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Public address", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "site-local-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Site local address", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "subnet-match" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Subnet match", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "up" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Up", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "virtual" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Virtual", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default" }, "any" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "any", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default", "value-type" : { "inet-address" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Inet address", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "link-local-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Link local address", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "loopback" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Loopback", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "loopback-address" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Loopback address", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "multicast" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Multicast", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "nic" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "NIC", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "nic-match" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "NIC match", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "point-to-point" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Point to point", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "public-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Public address", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "site-local-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Site local address", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "subnet-match" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Subnet match", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "up" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Up", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "virtual" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Virtual", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } } }, "not" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Not", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["any-address"], "stability" : "default", "value-type" : { "inet-address" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Inet address", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "link-local-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Link local address", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "loopback" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Loopback", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "loopback-address" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Loopback address", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "multicast" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Multicast", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "nic" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "NIC", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "nic-match" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "NIC match", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "point-to-point" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Point to point", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "public-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Public address", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "site-local-address" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Site local address", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "subnet-match" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Subnet match", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "up" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Up", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "virtual" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Virtual", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } } } }, "reply-properties" : {"type" : { "TYPE_MODEL_VALUE" : "STRING" }}, "access-constraints" : {"sensitive" : {"socket-config" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• resume - Resumes normal operations on a suspended server.

  Raw DMR model

  { "operation-name" : "resume", "description" : "Resumes normal operations on a suspended server.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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.

  Raw DMR model

  { "operation-name" : "suspend", "description" : "Suspends server operations gracefully. All current requests will complete normally, however no new requests will be accepted.", "request-properties" : { "timeout" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : 0, "unit" : "SECONDS", "alternatives" : ["suspend-timeout"], "stability" : "default", "deprecated" : { "since" : "9.0.0", "reason" : "Use suspend-timeout instead." } }, "suspend-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : 0, "unit" : "SECONDS", "alternatives" : ["timeout"], "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "take-snapshot", "description" : "Takes a snapshot of the current configuration", "request-properties" : { "comment" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Comment on the snapshot being taken.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the snapshot being taken.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The location of the file on the machine the configuration belongs" }, "access-constraints" : {"sensitive" : {"snapshots" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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'

  Raw DMR model

  { "operation-name" : "undefine-attribute", "description" : "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" : {"name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the attribute which should be set to 'undefined'", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• 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

  Raw DMR model

  { "operation-name" : "upload-deployment-bytes", "description" : "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-properties" : {"bytes" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "Byte array containing the deployment content that should uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 20, "max-length" : 20, "stability" : "default" }, "access-constraints" : {"application" : {"deployment" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "upload-deployment-stream", "description" : "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-properties" : {"input-stream-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "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.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "filesystem-path" : true, "attached-streams" : true, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 20, "max-length" : 20, "stability" : "default" }, "access-constraints" : {"application" : {"deployment" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "upload-deployment-url", "description" : "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-properties" : {"url" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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).", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "web-url" : true, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "BYTES" }, "description" : "The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 20, "max-length" : 20, "stability" : "default" }, "access-constraints" : {"application" : {"deployment" : {"type" : "core"}}}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• 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,
          "stability" => "default"
      },
      "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" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      }
  }

  Raw DMR model

  { "operation-name" : "validate-address", "description" : "Checks whether a resource with the address passed in as the argument exists.", "request-properties" : {"value" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The address to check.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "value-type" : { "valid" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether a resource with the address passed in as the argument exists.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "problem" : { "type" : { "TYPE_MODEL_VALUE" : "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" : 1, "max-length" : 2147483647, "stability" : "default" } }, "description" : "Report of checking the address." }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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.

  Raw DMR model

  { "operation-name" : "validate-operation", "description" : "Validates that an operation is valid according to its description. Any errors present will be shown in the operation's failure-description.", "request-properties" : {"value" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The operation to validate.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : true, "runtime-only" : true }

• 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

  Raw DMR model

  { "operation-name" : "whoami", "description" : "Returns the identity of the currently authenticated user.", "request-properties" : {"verbose" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If set to true whoami also returns the users roles.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The identify of the authenticated user and their roles if requested." }, "stability" : "default", "read-only" : true, "runtime-only" : false }

• 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.

  Raw DMR model

  { "operation-name" : "write-attribute", "description" : "Sets the value of an attribute for the selected resource", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the attribute to set the value for under the selected resource", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "value" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

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

  Raw DMR model

  { "operation-name" : "write-config", "description" : "An operation to force the server to write its config file, without making any actual config change.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• server-root

          
  <feature spec="server-root">
    <param name="name" value="{value}"/>
    <param name="organization" value="{value}"/>
  <feature/>
          
        

  📋