2.3 List of subcommands of asadmin command to be used in the Java EE server : Hitachi Application Server V10 Command Reference Guide (For UNIX Systems)

Commands used for domain administration

Command Name	Classification	Summary
backup-domain	Creates a backup of the domain	Creates a backup of the files in a named domain.
change-admin-password	Changes the administrator password	Changes the administrator password.
create-domain	Creates Java EE Server domain	Creates Java EE Server domain.
create-service	Configures the starting of the DAS or server instance	Configures the starting of the DAS or server instance on an unattended boot on OS.
delete-domain	Deletes a domain	Deletes the specified domain.
list-backups	Lists all the backups	Displays information about the domain backups.
list-domains	Lists the domains in the specified directory	Lists the domains in the specified domains directory.
restart-domain	Restarts the DAS of the specified domain	Stops and then restarts the DAS of the specified domain.
restore-domain	Restores files from the backup	Restores files under the domain from a backup directory.
start-domain	Starts the DAS of the specified domain	Starts the DAS of the specified domain.
stop-domain	Stops the DAS of the specified domain	Stops the DAS of the specified domain.

Commands used for node administration

Command Name	Classification	Summary
create-node-config	Creates a node that is not enabled for remote communication	Creates a node that is not enabled for remote communication.
create-node-ssh	Creates a node that is enabled for communication over SSH	Creates a node that is enabled for communication over SSH.
delete-node-config	Deletes a node that is not enabled for remote communication	Deletes a node that is not enabled for remote communication.
delete-node-ssh	Deletes a node that is enabled for communication over SSH	Deletes a node that is enabled for communication over SSH from the domain.
list-nodes	Lists all Java EE Server nodes in a domain	Lists all Java EE Server nodes in a domain.
list-nodes-config	Lists all Java EE Server nodes that do not support remote communication in a domain	Lists all Java EE Server nodes that do not support remote communication in a domain.
list-nodes-ssh	Lists all Java EE Server nodes that support communication over SSH in a domain	Lists all Java EE Server nodes that support communication over SSH in a domain.
ping-node-ssh	Tests nodes enabled for communication over SSH to determine if they are usable	Validates the node to determine if the `asadmin` utility can run on the host which the node represents.
setup-ssh	Sets up an SSH key on specified hosts	Sets up an SSH key on specified hosts.
update-node-config	Updates the configuration data of a node	Updates the configuration data of a node. This subcommand does not require the SSH to be configured to update the node.
update-node-ssh	Updates the configuration data of a node	Updates the configuration data of a node. This subcommand requires SSH to be configured on the machine where the DAS is running and on the machine where the node resides.

Commands used for server administration

Command Name	Classification	Summary
cleanup-prf	Cleaning PRF environment	Stops the PRF servers that were created on the host running the subcommand, and removes (cleans up) the PRF environment.
cleanup-webserver	Cleaning web server environment	Stops a web server that was set up on the host running the subcommand. This subcommand removes (cleans up) the web server environment.
copy-config	Copies an existing named configuration to create another configuration	Creates a configuration in the DAS by copying an existing configuration.
create-cluster	Creates Java EE Server cluster	Creates Java EE Server cluster.
create-instance	Creates a server instance	Creates a server instance.
create-prf	Creating PRF server in domain	Creates a PRF server in the domain.
create-webserver	Creating web server	Creates a web server in the domain.
delete-cluster	Deletes Java EE Server cluster	Deletes Java EE Server cluster.
delete-config	Deletes an existing named configuration	Deletes an existing named configuration from the configuration of the DAS.
delete-instance	Deletes a server instance	Deletes a server instance.
delete-prf	Deleting PRF server	Deletes the specified PRF server from the domain.
delete-webserver	Deleting web server	Deletes the specified web server from the domain.
export-sync-bundle	Exports the configuration data of a cluster or standalone instance to an archive file	Exports the configuration data of a cluster or standalone instance to an archive file.
get-health	Provides information on the cluster health	Gets information about the health of the cluster.
import-sync-bundle	Imports the configuration data of a clustered instance or standalone instance from an archive file	Imports the configuration data of a clustered instance or standalone instance from an archive file that was created by the `export-sync-bundle` subcommand.
list-clusters	Lists existing clusters in a domain	Lists existing clusters in a domain.
list-instances	Lists the server instances	Lists the server instances in a domain.
list-prfs	Listing PRF servers	Lists the PRF (Performance Tracer) servers that have been set up in the domain.
list-webservers	Listing all web servers	Lists all the web servers that have been set up in the domain.
start-cluster	Starts a cluster	Starts a cluster by starting all the server instances in the cluster that are not already running.
start-instance	Starts a server instance	Starts a server instance.
start-prf	Starting PRF server	Starts the specified PRF server.
start-servers	Starting all the servers in batch	Starts, in a batch, all the servers in the domain.
start-webserver	Starting web server	Starts the specified web server.
stop-cluster	Stops Java EE Server cluster	Stops Java EE Server cluster by stopping all running server instances in the cluster.
stop-instance	Stops a running server instance	Stops a running server instance.
stop-prf	Stopping PRF server	Stops the specified PRF server.
stop-servers	Stopping all the servers in batch	Stops, in a batch, all the servers in the domain.
stop-webserver	Stopping web server	Stops the specified web server.
validate-multicast	Validates that the multicast transport is available for clusters	Validates that the multicast transport is available for clusters.

Commands used for setting server relations

Command Name	Classification	Summary
create-relation	Creating relation between servers	Creates a relation between servers.
delete-relation	Deleting relation between servers	Deletes a relation between servers from the domain.
list-relations	Listing relations between servers	Lists the relations between servers.

Commands used for application administration

Command Name	Classification	Summary
create-application-ref	Creates the reference to an application	Creates a reference from a clustered or an unclustered server instance to a previously deployed application element.
delete-application-ref	Removes the reference to an application	Removes a reference from a cluster or an unclustered server instance to an application.
deploy	Deploys the specified component	Deploys applications to the server.
disable	Disables the component	Disables the specified deployed component.
enable	Enables the component	Enables the specified deployed component.
get-client-stubs	Retrieves the application JAR files needed to launch the application client	Copies the required JAR files for an AppClient standalone module or each AppClient module in an application from the server machine to the local directory.
list-application-refs	Lists the existing application references	Lists all the application references in a cluster or an unclustered server instance.
list-applications	Lists the deployed applications	Lists the deployed Java EE applications and the type of each application that is listed.
list-containers	Lists the application containers	Lists the application containers.
list-modules	Lists Java EE Server modules	Displays a list of modules that are accessible to Java EE Server module subsystem.
list-sub-components	Lists EJB or servlet components either in a deployed module or in the module of a deployed application	Lists the EJB or servlet components in a deployed module or in a module of a deployed application.
list-timers	Lists all the persistent timers owned by the server instance(s)	Lists the persistent timers owned by a specific server instance or a cluster of server instances.
list-web-context-param	Lists the servlet context-initialization parameters of a deployed Web application or module	Lists the servlet context-initialization parameters of a deployed Web application or module.
list-web-env-entry	Lists the environment entries for a deployed Web application or module	Lists the environment entries for a deployed Web application or module.
redeploy	Redeploys the specified component	Redeploys an enterprise application, Web application, module based on the Enterprise JavaBeans (EJB) specification (EJB module), connector module, or application client module that is already deployed or already exists.
set-web-context-param	Sets a servlet `context-initialization` parameter of a deployed Web application or module	Sets a servlet `context-initialization` parameter of a deployed Web application or module.
set-web-env-entry	Sets an environment entry for a deployed Web application or module	Sets an environment entry for a deployed Web application or module.
show-component-status	Displays the status of the deployed component	Gets the status (either enabled or disabled) of the deployed component.
undeploy	Removes a deployed component	Uninstalls a deployed application or module and removes it from the repository.
unset-web-context-param	Unsets a servlet context-initialization parameter of a deployed Web application or module	Unsets a servlet context-initialization parameter of a deployed Web application or module.
unset-web-env-entry	Unsets an environment entry for a deployed Web application or module	Unsets an environment entry for a deployed Web application or module.

Commands used for security administration

Command Name	Classification	Summary
change-master-password	Changes the master password	Changes the master password.
create-auth-realm	Adds the named authentication realm	Adds the named authentication realm.
create-file-user	Creates a new file user	Creates an entry in the keyfile
create-jacc-provider	Enables administrators to create a JACC provider that can be used by third-party authorization modules for applications running in Java EE Server	Creates a JSR-115-compliant Java Authorization Contract for Containers (JACC) provider that can be used for authorization of applications running in Java EE Server.
create-password-alias	Creates a password alias	Creates an alias for a password.
delete-auth-realm	Removes the named authentication realm	Removes the named authentication realm.
delete-file-user	Removes the named file user	Deletes the entry in the keyfile for the specified username.
delete-jacc-provider	Deletes JACC providers defined for a domain	Enables administrators to delete JACC providers defined for a domain.
delete-password-alias	Deletes a password alias	Deletes a password alias.
disable-secure-admin	Disables secure admin	Disables secure admin if it is already enabled.
enable-secure-admin	Enables secure admin	Enables secure admin if it is not already enabled.
list-auth-realms	Lists the authentication realms	Lists the authentication realms.
list-file-groups	Lists the file groups	Lists the file users and groups supported by the file realm authentication.
list-file-users	Lists the file users	Displays a list of file users supported by file realm authentication.
list-jacc-providers	Lists JACC providers defined for a domain	Enables administrators to list the JACC providers defined for a domain.
list-password-aliases	Lists all the password aliases	Lists all the existing password aliases.
list-supported-cipher-suites	Lists the cipher suites that are supported and made available to a specific Java EE Server target	Enables administrators to list the cipher suites that are supported and made available to a specified Java EE Server target.
update-file-user	Updates a current `file user` as specified	Updates an existing entry in the keyfile using the specified user name, password and groups.
update-password-alias	Updates a password alias	Updates the password alias IDs in the named target.

Commands used for log administration

Command Name	Classification	Summary
collect-local-snapshot	Collecting system information when domain administration server stops	Collects system information when the domain administration server stops.
collect-snapshot	Collecting system information when domain administration server starts	Collects system information when the domain administration server starts.
list-log-attributes	Lists all the logging attributes defined for a specific target in a domain	Lists all the logging attributes currently defined for the specified Java EE Server domain or a target within a domain.
set-log-attributes	Sets the logging attributes for one or more loggers	Sets the logging attributes for one or more loggers.

Commands used for setting parameters

Command Name	Classification	Summary
create-jvm-options	Creates options for Java VM	Creates command-line options that are passed to Java VM when Java EE Server is started.
create-system-properties	Adds one or more system property elements that can be referenced elsewhere in the configuration	Adds or updates system properties that can be referenced elsewhere on the server.
delete-jvm-options	Removes one or more options for Java VM	Removes one or more command-line options for Java VM.
delete-system-property	Removes a system property of the domain, configuration, cluster, or server instance, one at a time	Deletes a system property of a domain, configuration, cluster, or server instance.
get	Retrieves the values of configurable attributes	Retrieves the values of configurable attributes.
list	Lists the configurable elements	Lists the configurable attributes of Java EE Server.
list-configs	Lists the named configurations in the configuration of the DAS	Lists named configurations in the configuration of the DAS.
list-jvm-options	Lists options for Java VM	Displays a list of command-line options that are passed to Java VM when the Java EE Server is started.
list-system-properties	Lists the system properties of the domain, configuration, cluster, or a server instance	Lists the system properties of a domain, configuration, cluster, or server instance.
set	Sets the values of configurable attributes	Sets the values of configurable attributes.

Commands used for system administration

Command Name	Classification	Summary
add-library	Adds one or more library JAR files to Java EE Server	Adds one or more library archive files to Java EE Server.
create-profiler	Creates the profiler element	Creates the profiler element.
delete-profiler	Removes the profiler element	Deletes the profiler element in the Java configuration.
list-commands	Lists the available commands	Lists the `asadmin` subcommands.
list-libraries	Lists the library archive files present on Java EE Server	Lists library archive files present on Java EE Server.
login	Logs you into a domain	Enables you to log into a particular domain, thus simplifying domain administration.
remove-library	Removes one or more library JAR files from Java EE Server	Removes one or more library JAR files from Java EE Server.
version	Displays the version information for Java EE Server	Displays the version information for Java EE Server.

Commands used for internet connection administration

Command Name	Classification	Summary
create-protocol	Adds a new protocol	Adds a new protocol.
create-ssl	Creates and configures the SSL element in the selected HTTP listener, IIOP listener, or IIOP service	Creates and configures the SSL element in the selected HTTP listener, IIOP listener, or IIOP service to enable secure communication on that listener/service.
delete-protocol	Removes a protocol	Removes the specified protocol.
delete-ssl	Deletes the SSL element in the selected HTTP listener, IIOP listener, or IIOP service	Deletes the SSL element in the selected HTTP listener, IIOP listener, or IIOP service.
list-network-listeners	Lists the existing network listeners	Lists the existing network listeners.
list-protocols	Lists the existing protocols	Lists the existing protocols.
list-transports	Lists the existing transports	Lists the existing transports.
list-virtual-servers	Lists the existing virtual servers	Lists the existing virtual servers.

Commands used for ORB administration

Command Name	Classification	Summary
create-iiop-listener	Adds an IIOP listener	Adds an IIOP listener.
delete-iiop-listener	Removes an IIOP listener	Removes an IIOP listener.
list-iiop-listeners	Lists the existing IIOP listeners	Lists the existing IIOP listeners.

Commands used for resource administration

Command Name	Classification	Summary
add-resources	Creates the resources named in a specified XML file	Creates the resources named in a specified XML file.
create-resource-ref	Creates a reference to a resource	Creates a reference from a cluster or an unclustered server instance to a previously created resource.
delete-resource-ref	Removes a reference to a resource	Removes from a cluster or an unclustered server instance a reference to a resource (for example, a JDBC resource).
list-resource-refs	Lists the existing resource references	Lists all the resource references in a cluster or an unclustered server instance.

Commands used for database connection administration

Command Name	Classification	Summary
create-jdbc-connection-pool	Registers a JDBC connection pool	Registers a new Java Database Connectivity ("JDBC") software connection pool with the specified JDBC connection pool name.
create-jdbc-resource	Creates a JDBC resource with the specified JNDI name	Creates a new JDBC resource.
delete-jdbc-connection-pool	Removes the specified JDBC connection pool	Deletes a JDBC connection pool.
delete-jdbc-resource	Removes a JDBC resource with the specified JNDI name	Removes a JDBC resource with the specified JNDI name.
list-jdbc-connection-pools	Lists all JDBC connection pools	Lists the current JDBC connection pools.
list-jdbc-resources	Lists all JDBC resources	Displays a list of all the existing JDBC resources.

Commands used for JavaMail service administration

Command Name	Classification	Summary
create-javamail-resource	Creates a JavaMail session resource	Creates a JavaMail session resource.
delete-javamail-resource	Removes a JavaMail session resource	Removes the specified JavaMail session resource.
list-javamail-resources	Lists the existing JavaMail session resources	Lists the existing JavaMail session resources.

Commands used for JNDI service administration

Command Name	Classification	Summary
create-custom-resource	Registers the connector resource with the specified JNDI name	Registers the connector resource with the specified JNDI name.
create-jndi-resource	Registers a JNDI resource	Registers a JNDI resource.
delete-custom-resource	Deletes a custom resource	Deletes a custom resource.
delete-jndi-resource	Removes a JNDI resource	Removes the specified JNDI resource.
list-custom-resources	Gets all the custom resources	Gets all the custom resources.
list-jndi-resources	Lists all the existing JNDI resources	Identifies all the existing JNDI resources.

Commands used for JMS administration

Command Name	Classification	Summary
create-jms-host	Creates a JMS host	Creates a Java Message Service (JMS) host within the JMS service.
create-jms-resource	Creates a JMS resource	Creates a Java Message Service (JMS) connection factory resource or a JMS destination resource.
create-jmsdest	Creates a JMS physical destination	Creates a Java Message Service (JMS) physical destination.
delete-jms-host	Removes a JMS host	Removes a JMS host.
delete-jms-resource	Removes a JMS resource	Removes a JMS resource.
delete-jmsdest	Removes a JMS physical destination	Removes a JMS physical destination.
flush-jmsdest	Purges messages in a JMS destination	Purges the messages from a physical destination in the server's Java Message Service (JMS) configuration.
list-jms-hosts	Lists the existing JMS hosts	Lists the existing Java Message Service (JMS) hosts for the JMS service.
list-jms-resources	Lists the JMS resources	Lists the existing Java Message Service (JMS) resources (destination and connection factory resources).
list-jmsdest	Lists the existing JMS physical destinations	Lists the Java Message Service (JMS) physical destinations.

Commands used for EIS connection administration

Command Name	Classification	Summary
create-admin-object	Creates an administered object with the specified JNDI name for a resource adapter	Creates the administered object with the specified JNDI name and the interface definition for a resource adapter.
create-connector-connection-pool	Adds a connection pool with the specified connection pool name	Defines a pool of connections to an Enterprise Information System (EIS).
create-connector-resource	Registers the connector resource with the specified JNDI name	Registers the connector resource with the specified JNDI name.
create-connector-security-map	Creates a security map for the specified connector connection pool	Creates a security map for the specified connector connection pool.
create-connector-work-security-map	Creates a work security map for the specified resource adapter	Maps the caller identity of the work submitted by the resource adapter EIS principal or EIS user group to a suitable principal or user group in Java EE Server security domain.
create-resource-adapter-config	Creates the configuration information for the connector module	Creates configuration information for the connector module.
delete-admin-object	Removes the administered object with the specified JNDI name	Removes an administered object with the specified JNDI name.
delete-connector-connection-pool	Removes the specified connector connection pool	Removes the specified connector connection pool.
delete-connector-resource	Removes the connector resource for the specified JNDI name	Removes the connector resource with the specified JNDI name.
delete-connector-security-map	Deletes a security map for the specified connector connection pool	Deletes a security map for the specified connector connection pool.
delete-connector-work-security-map	Deletes a work security map for the specified resource adapter	Deletes a security map associated with the specified resource adapter.
delete-resource-adapter-config	Deletes the resource adapter configuration	Deletes the configuration information for the connector module.
flush-connection-pool	Reinitializes all connections established in the specified connection pool	Resets a JDBC connection pool or a connector connection pool to its initial state.
list-admin-objects	Gets all the administered objects	Lists all the administered objects.
list-connector-connection-pools	Lists the existing connector connection pools	Lists the connector connection pools that have been created.
list-connector-resources	Lists all connector resources	Lists all the connector resources.
list-connector-security-maps	Lists the security maps belonging to the specified connector connection pool	Lists the security maps belonging to the specified connector connection pool.
list-connector-work-security-maps	Lists the work security maps belonging to the specified resource adapter	Lists the work security maps belonging to the specified resource adapter.
list-resource-adapter-configs	Lists the names of the current resource adapter configurations	Lists the configuration information in the`domain.xml` for the connector module.
ping-connection-pool	Tests a connection pool to determine if it is usable	Tests if an existing JDBC or connector connection pool is usable.
update-connector-security-map	Modifies a security map for the specified connector connection pool	Modifies a security map for the specified connector connection pool.
update-connector-work-security-map	Modifies a work security map for the specified resource adapter	Modifies a security map for the specified resource adapter.

Commands used for thread pool administration

Command Name	Classification	Summary
create-threadpool	Creates a thread pool	Creates a thread pool with the specified name.
delete-threadpool	Removes a thread pool	Removes the thread pool with the specified ID.
list-threadpools	Lists all the thread pools	Lists Java EE Server thread pools.

Commands used for transaction administration

Command Name	Classification	Summary
recover-transactions	Recovers pending transactions manually	Recovers transactions after a server failure.

Commands used for batch job administration

Command Name	Classification	Summary
list-batch-job-executions	Lists the batch job executions and execution details	Lists the batch job executions and execution details.
list-batch-job-steps	Lists the steps for a specific batch job execution	Lists the steps for a specific batch job execution.
list-batch-jobs	Lists the batch jobs	Lists the batch jobs and job details.
list-batch-runtime-configuration	Displays the configuration of the batch runtime	Displays the configuration of the batch runtime.
set-batch-runtime-configuration	Configures the batch runtime	Configures the batch runtime.

Commands used for concurrent resource administration

Command Name	Classification	Summary
create-context-service	Creates a context service resource	Creates a context service resource.
create-managed-executor-service	Creates a managed executor service resource	Creates a managed executor service resource.
create-managed-scheduled-executor-service	Creates a managed scheduled executor service resource	Creates a managed scheduled executor service resource.
create-managed-thread-factory	Creates a managed thread factory resource	Creates a managed thread factory resource.
delete-context-service	Deletes a context service resource	Removes a context service resource with the specified JNDI name.
delete-managed-executor-service	Removes a managed executor service resource	Removes a managed executor service resource with the specified JNDI name.
delete-managed-scheduled-executor-service	Removes a managed scheduled executor service resource	Removes a managed scheduled executor service resource with the specified JNDI name.
delete-managed-thread-factory	Removes a managed thread factory resource	Removes a managed thread factory resource with the specified JNDI name.
list-context-services	Lists the context service resources	Lists the context service resources.
list-managed-executor-services	Lists the managed executor service resources	Lists the managed executor service resources.
list-managed-scheduled-executor-services	Lists the managed scheduled executor service resources	Lists the managed scheduled executor service resources.
list-managed-thread-factories	Lists the managed thread factory resources	Lists the managed thread factory resources.

Commands used for message security provider administration

Command Name	Classification	Summary
create-message-security-provider	Creates a message security provider	Creates a message security provider that specifies how SOAP messages will be secured.
delete-message-security-provider	Deletes a message security provider	Enables administrators to delete a message security provider.
list-message-security-providers	Lists all the security message providers for the given message layer	Enables administrators to list all security message providers (`provider-config` sub-elements) for the given message layer (`message-security-config` element of `domain.xml`).

Commands used to manage the event hook command

Command Name	Classification	Summary
create-event-hook	Registering event hook command	Registers an event hook command, which is executed automatically when an event occurs in the domain administration server.
delete-event-hook	Unregistering event hook command	Unregisters an event hook command.
list-event-hooks	Listing event hook commands	Lists the registered event hook commands.

Important note

Specify the value which can be specified by each command as the argument of a command. Operation is not guaranteed when other values are specified.
Even if a command is executed normally, errors may have occurred. Check the message log and stack trace log.