The following table lists management CLI operations that are available at the root level (/
). The actual available operations for a particular resource will vary per resource and also depend on the operating mode (standalone server or managed domain).
Operations are invoked using a colon (:
). The available operations for a resource can be exposed by using the read-operation-names
operation or by using tab completion after a colon. Operation descriptions can be displayed by using the read-operation-description
operation. For example:
Operation Name | Description |
---|---|
add-namespace | Adds a namespace prefix mapping to the namespaces attribute’s map. |
add-schema-location | Adds a schema location mapping to the schema-locations attribute’s map. |
clean-obsolete-content | Clean contents that are no longer referenced from the content repository. |
delete-snapshot | Deletes a snapshot of the server configuration from the snapshots directory. |
full-replace-deployment | Adds 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. |
list-add | Add an entry to a list attribute. |
list-clear | Clear all entries from a list attribute. |
list-get | Get an entry from a list attribute. |
list-remove | Remove an entry from a list attribute. |
list-snapshots | Lists the snapshots of server configurations saved in the snapshots directory. |
map-clear | Clear all entries from a map attribute. |
map-get | Get an entry from a map attribute. |
map-put | Add an entry to a map attribute. |
map-remove | Remove an entry from a map attribute. |
product-info | Returns a summary of the current server installation. |
query | Query a resource. |
read-attribute | Displays the value of an attribute for the selected resource. |
read-attribute-group | Displays the value of attributes for the selected group. |
read-attribute-group-names | Displays the names of all the attribute groups under the selected resource. |
read-children-names | Displays the names of all children under the selected resource with the given type. |
read-children-resources | Displays information about all of a resource’s children that are of a given type. |
read-children-types | Displays the type names of all the children under the selected resource. |
read-config-as-xml | Displays the current configuration in XML format. |
read-operation-description | Displays the details of an operation for the given resource. |
read-operation-names | Displays the names of all available operations for the given resource. |
read-resource | Displays a resource’s attribute values along with either basic or complete information about any child resources. |
read-resource-description | Displays the description of a resource’s attributes, types of children and operations. |
reload | Reloads the server by shutting all services down and restarting. |
reload-servers | Reloads all servers currently running in the domain. |
remove-namespace | Removes a namespace prefix mapping from the namespaces attribute map. |
remove-schema-location | Removes a schema location mapping from the schema-locations attribute map. |
replace-deployment | Replace existing content in the runtime with new content. The new content must have been previously uploaded to the deployment content repository. |
resolve-expression | 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. |
resolve-expression-on-domain | 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 on all servers in the domain. |
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. |
restart-servers | Restarts all servers currently running in the domain. |
resume | Resumes normal operations in a suspended server. |
resume-servers | Resumes processing on all servers in the domain. |
shutdown | Shuts down the server with a call to System.exit(0) . |
start-servers | Starts all configured servers in the managed domain that are not currently running. |
stop-servers | Stops all servers currently running in the managed domain. |
suspend | Suspends server operations gracefully. All current requests will complete normally, however no new requests will be accepted. |
suspend-servers | Suspends all servers in the domain. All current operations will finish and no new operations will be allowed. |
take-snapshot | Takes a snapshot of the server configuration and saves it to the snapshots directory. |
undefine-attribute | Sets the value of an attribute of the selected resource to undefined . |
upload-deployment-bytes | Indicates that the deployment content in the included byte array should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime. |
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. |
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. |
validate-address | Checks whether a resource with the specified address exists. |
validate-operation | Validates that an operation is valid according to its description. Any errors present will be shown in the operation’s failure-description . |
whoami | Returns the identity of the currently authenticated user. |
write-attribute | Sets the value of an attribute for the selected resource. |