-H

--host

The machine name where the domain administration server is running. The default value is localhost. 

-p

--port

The HTTP/S port for administration. This is the port to which you should point your browser in order to manage the domain. For example, http://localhost:4848. The default port number for Platform Edition is 4848.

-u

--user

The authorized domain administration server administrative username. If you have authenticated to a domain using the asadmin login command, then you need not specify the --user option on subsequent operations to this particular domain.

--passwordfile

The -‐passwordfile option specifies the name of a file containing the password entries in a specific format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in uppercase letters.

For example, to specify the domain administration server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_PASSWORD, AS_ADMIN_USERPASSWORD, and AS_ADMIN_ALIASPASSWORD, AS_ADMIN_MAPPEDPASSWORD.

All remote commands must specify the admin password to authenticate to the domain administration server, either through-‐passwordfile or asadmin login, or interactively on the command prompt. The asadmin login command can be used only to specify the admin password. For other passwords, that must be specified for remote commands, use the -‐passwordfile or enter them at the command prompt.

If you have authenticated to a domain using the asadmin login command, then you need not specify the admin password through the -‐passwordfile option on subsequent operations to this particular domain. However, this is applicable only to AS_ADMIN_PASSWORD option. You will still need to provide the other passwords, for example, AS_ADMIN_USERPASSWORD, as and when required by individual commands, such as update-file-user.

For security reasons, passwords specified as an environment variable will not be read by asadmin.

-s

--secure

If set to true, uses SSL/TLS to communicate with the domain administration server. 

-I

--interactive

If set to true (default), only the required password and user options are prompted. 

-t

--terse

Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false. 

-e

--echo

Setting to true will echo the command line statement on the standard output. Default is false. 

-h

--help

Displays the help text for the command. 

AS_ADMIN_PASSWORD=value
AS_ADMIN_ADMINPASSWORD=value
AS_ADMIN_USERPASSWORD=value
AS_ADMIN_MASTERPASSWORD=value

create-domain

Creates the configuration of a domain. A domain is an administrative namespace. Every domain has a configuration, which is stored in a set of files. Any number of domains, each of which has a distinct administrative identity, can be created in a given installation of the Application Server. A domain can exist independent of other domains. Any user who has access to the asadmin utility on a given system can create a domain and store its configuration in a folder of choice. By default, the domain configuration is created in the install_dir/domains directory. You can override this location to store the configuration elsewhere.

delete-domain

Deletes the named domain. The domain must already exist and must be stopped. 

start-domain

Starts a domain. If the domain directory is not specified, the domain in the default install_dir/domains directory is started. If there are two or more domains, the domain_name operand must be specified.

stop-domain

Stops the Domain Administration Server of the specified domain. 

restore-domain

Restores files under the domain from a backup directory. 

list-domains

Lists the domain. If the domain directory is not specified, the domain in the default install_dir/domains directory is listed. If there is more than one domain, the domain_name operand must be specified.

backup-domain

Backs up files under the named domain. 

list-backups

Displays the status information about all backups in the backup repository. 

shutdown

Gracefully brings down the administration server and all the running instances. You must manually start the administration server to bring it up again. 

Command 

Definition 

show-component-status

Gets the status of the deployed component. The status is a string representation returned by the server. The possible status strings include status of app-name is enabled or status of app-name is disabled.

list-components

Lists all deployed Java EE 5 components. If the --type option is not specified, all components are listed.

list-sub-components

Lists EJBs or Servlets in a deployed module or in a module of the deployed application. If a module is not identified, all modules are listed. 

deploy

Deploys an enterprise application, web application, EJB module, connector module, or application client module. If the component is already deployed or already exists, it is forcefully redeployed if the -‐force option is set to true.

deploydir

Deploys an application directly from a development directory. The appropriate directory hierarchy and deployment descriptors conforming to the Java EE specification must exist in the deployment directory. 

get-client-stubs

Gets the client stubs JAR file for an AppClient standalone module or an application containing the AppClient module, from the server machine to the local directory. The application or module should be deployed before executing this command. it is also possible to get the client stubs as part of the deploy command using --retrieve option.

undeploy

Removes the specified deployed component. 

create-jmsdest

Creates a JMS physical destination. Along with the physical destination, you use the create-jms-resource command to create a JMS destination resource that has a Name property that specifies the physical destination.

delete-jmsdest

Removes the specified JMS destination. 

flush-jmsdest

Purges the messages from a physical destination in the specified target's JMS Service configuration.  

list-jmsdest

Lists the JMS physical destinations. 

jms-ping

Checks if the JMS service (also known as the JMS provider) is up and running. When you start the Application Server, the JMS service starts by default. Additionally, it pings only the default JMS host within the JMS service. It displays an error message when it is unable to ping a built-in JMS service. 

create-jdbc-connection-pool

Registers a new JDBC connection pool with the specified JDBC connection pool name. 

delete-jdbc-connection-pool

Deletes a JDBC connection pool. The operand identifies the JDBC connection pool to be deleted. 

list-jdbc-connection-pools

Gets the JDBC connection pools that have been created. 

create-jdbc-resource

Creates a new JDBC resource. 

delete-jdbc-resource

Removes a JDBC resource with the specified JNDI name. 

list-jdbc-resources

Displays a list of JDBC resources that have been created. 

create-jms-resource

Creates a Java Message Service (JMS) connection factory resource or a JMS destination resource. 

delete-jms-resource

Removes the specified JMS resource. 

list-jms-resources

Lists the existing JMS resources (destination and connection factory resources). 

create-jndi-resource

Registers a JNDI resource. 

delete-jndi-resource

Removes the JNDI resource with the specified JNDI name. 

list-jndi-resources

Identifies all the existing JNDI resources. 

list-jndi-entries

Browses and queries the JNDI tree. 

create-javamail-resource

Creates a JavaMail session resource. 

delete-javamail-resource

Removes the specified JavaMail session resource. 

list-javamail-resources

Lists the existing JavaMail session resources. 

create-persistence-resource

Registers a persistence resource. 

delete-persistence-resource

Removes a persistence resource. When you delete a persistence resource, the command also removes the JDBC resource if it was created using the create-persistence-resource command.

list-persistence-resources

Displays all the persistence resources. 

create-custom-resource

Creates a custom resource. A custom resource specifies a custom server-wide resource object factory that implements the javax.naming.spi.ObjectFactory interface.

delete-custom-resource

Removes a custom resource. 

list-custom-resources

Lists the custom resources. 

create-connector-connection-pool

Adds a new connector connection pool with the specified connection pool name. 

delete-connector-connection-pool

Removes the connector connection pool specified using the operand connector_connection_pool_name.

list-connector-connection-pools

Lists the connector connection pools that have been created. 

create-connector-resource

Registers the connector resource with the specified JNDI name. 

delete-connector-resource

Removes the connector resource with the specified JNDI name. 

list-connector-resources

Gets all the connector resources. 

create-admin-object

Adds the administered object that has the specified JNDI name. 

delete-admin-object

Removes the administered object with the specified JNDI name. 

list-admin-objects

Lists all the administered objects. 

create-resource-adapter-config

Creates configuration information for the connector module. 

delete-resource-adapter-config

Deletes the configuration information created in domain.xml for the connector module.

list-resource-adapter-configs

Lists the configuration information in the domain.xml for the connector module

add-resources

Creates the resources named in the specified XML file. The xml_file_path is the path to the XML file containing the resources to be created. The DOCTYPE should be specified as install_dir/lib/dtds/sun-resources_1_2.dtd in the resources.xml file.

ping-connection-pool

Tests if a connection pool is usable for both JDBC connection pools and connector connection pools. For example, if you create a new JDBC connection pool for an application that is expected to be deployed later, the JDBC pool is tested with this command before deploying the application. Before pinging a connection pool, you must create the connection pool with authentication and ensure that the Application Server or database is started. 

Command 

Definition 

enable

Enables the specified component. If the component is already enabled, then it is re-enabled. The component must have been deployed in order to be enabled. If it has not been deployed, then an error message is returned. 

disable

Immediately disables the named component. The component must have been deployed. If the component has not been deployed, an error message is returned. 

export

Marks a variable name for automatic export to the environment of subsequent commands. All subsequent commands use the variable name value as specified unless you unset them or exit multimode.

get

Gets the names and values of attributes. 

set

Sets the values of one or more configurable attribute. 

list

Lists the configurable element. On Solaris, quotes are needed when executing commands with * as the option value or operand.

unset

Removes one or more variables you set for the multimode environment. The variables and their associated values will no longer exist in the environment. 

create-http-listener

Adds a new HTTP listener. 

delete-http-listener

Removes the specified HTTP listener. 

list-http-listeners

Lists the existing HTTP listener. 

create-iiop-listener

Creates an IIOP listener. 

delete-iiop-listener

Removes the specified IIOP listener. 

list-iiop-listeners

Lists the existing IIOP listeners. 

create-ssl

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

Deletes the SSL element in the selected HTTP listener, IIOP listener, or IIOP service. 

create-lifecycle-module

Creates a lifecycle module. The lifecycle modules provide a means of running short or long duration Java-based tasks within the Application Server environment. 

delete-lifecycle-module

Removes the specified lifecycle module. 

list-lifecycle-modules

Lists the existing lifecycle module. 

create-audit-module

Adds the named audit module for the plug-in module that implements the audit capabilities. 

delete-audit-module

Removes the named audit module. 

list-audit-modules

Lists all the audit modules. 

create-profiler

Creates the profiler element. A server instance is tied to a particular profiler, by the profiler element in the Java configuration. Changing a profiler requires you to restart the server. 

delete-profiler

Deletes the profiler element you specify. A server instance is tied to a particular profiler by the profiler element in the Java configuration. Changing a profiler requires you to restart the server. 

create-jvm-option

Creates JVM options in the Java configuration or profiler elements of the domain.xml file. If JVM options are created for a profiler, they are used to record the settings needed to get a particular profiler going. You must restart the server for newly created JVM options to take effect.

delete-jvm-option

Removes JVM options from the Java configuration or profiler elements of the domain.xml file.

create-virtual-server

Creates the named virtual server. Virtualization in the Application Server allows multiple URL domains to be served by a single HTTP server process that is listening on multiple host addresses. If the application is available at two virtual servers, they still share the same physical resource pools. 

delete-virtual-server

Removes the virtual server with the specified virtual server ID. 

list-virtual-server

Lists the existing virtual servers. 

create-threadpool

Creates a threadpool with the specified name. You can specify maximum and minimum number of threads in the pool, the number of work queues, and the idle timeout of a thread. The created thread pool can be used for servicing IIOP requests and for resource adapters to service work management requests. A created thread pool can be used in multiple resource adapters. 

delete-threadpool

Removes the threadpool with the named ID. 

list-threadpools

Lists all the thread pools. 

freeze-transaction

Freezes the transaction subsystem during which time all the inflight transactions are suspended. Invoke this command before rolling back any inflight transactions. Invoking this command on an already frozen transaction subsystem has no effect. 

unfreeze-transaction

Resumes all the suspended inflight transactions. Invoke this command on an already frozen transaction. 

recover-transactions

Manually recovers pending transactions. 

rollback-transaction

Rolls back the named transaction. 

list-timers

Lists the timers owned by a specific server instance  

create-file-user

Creates an entry in the keyfile with the specified username, password, and groups. Multiple groups can be created by separating them with a colon (:).

delete-file-user

Deletes the entry in the keyfile with the specified username. 

update-file-user

Updates an existing entry in the keyfile using the specified user_name, user_password and groups. Multiple groups can be entered by separating them, with a colon (:).

list-file-users

Creates a list of file users supported by file realm authentication. 

list-file-groups

Lists the users and groups supported by the file realm authentication. This command lists available groups in the file user. 

start-callflow-monitoring

Collects and correlates data from Web container, EJB container and JDBC to provide a complete call flow/path of a request. Data is collected only if callflow-monitoring is ON.

stop-callflow-monitoring

Disables collection of call flow information of a request. 

start-database 

Starts the Java DB server that is available with the Application Server. Use this command only for working with applications deployed to the Application Server. 

stop-database 

Stops a process of the Java DB server. Java DB server is available with the Application Server. 

generate-diagnostic-report

Generates an HTML report that contains pointers or navigational links to an application server installation details such as configuration details, logging details, or process specific information for an application server instance. 

generate-jvm-report

Displays the threads (dump of stack trace), classes and memory for a given target instance, including the Domain Administration Service. This command works only with the application server instance processes. This command replaces the traditional techniques like sending ctrl+break or kill -3 signals to application server processes. The command will not work if the target server instance is not running.

display-error-statistics

Displays a summary list of severities and warnings in server.log since the last server restart.

display-error-distribution

Displays distribution of errors from instance server.log at module level.™

display-log-records

Displays all the error messages for a given module at a given timestamp. 

configure-webservice-management

Configure the monitoring or the maxhistorysize attributes of a deployed web service endpoint.

create-transformation-rule

Creates an XSLT transformation rule that can be applied to a web service operation. The rule can be applied to a request, a response, or both. 

delete-transformation-rule

Deletes an XSLT transformation rule of a given web service. 

list-transformation-rules

Lists all the transformation rules of a given web service in the order they are applied. 

publish-to-registry

Publishes the web service artifacts to registry servers. 

unpublish-from-registry

Unpublishes the web service artifacts from the registry servers. 

list-registry-locations

Displays a list of configured web service entry access points. 

create-connector-security-map

Creates a security map for the specified connector connection pool. If the security map is not present, a new one is created. Also, use this command to map the caller identity of the application (principal or user group) to a suitable enterprise information system (EIS) principal in container-managed transaction-based scenarios. One or more named security maps may be associated with a connector connection pool. The connector security map configuration supports the use of the wild card asterisk (*) to indicate all users or all user groups. For this command to succeed, you must have first created a connector connection pool. The EIS is any system that holds the data of an organization. It can be a mainframe, a messaging system, a database system, or an application.

delete-connector-security-map

Deletes a security map for the specified connector connection pool. 

update-connector-security-map

Modifies a security map for the specified connector connection pool. 

list-connector-security-maps

Lists the security maps belonging to the specified connector connection pool. 

create-message-security-provider

Enables administrators to create a provider-config sub-element for the given message layer (message-security-config element of domain.xml, the file that specifies parameters and properties to the Application Server).

delete-message-security-provide

Enables administrators to delete a provider-config sub-element for the given message layer (message-security-config element of domain.xml, the file that specifies parameters and properties to the Application Server).

list-message-security-providers

Enables administrators to list all security message providers (provider-config sub-elements) for the given message layer (message-security-config element of domain.xml).

create-auth-realm

Adds the named authentication realm. 

delete-auth-realm

Removes the named authentication realm. 

list-auth-realms

Lists the existing authentication realms. 

create-password-alias

Creates an alias for a password and stores it in domain.xml. An alias is a token of the form ${ALIAS=password-alias-password}. The password corresponding to the alias name is stored in an encrypted form. This command takes both a secure interactive form (in which the user is prompted for all information) and a more script-friendly form, in which the password is propagated on the command line.

delete-password-alias

Deletes a password alias. 

update-password-alias

Updates the password alias IDs in the named target. 

list-password-aliases

Lists all password aliases. 

change-admin-password

This remote command modifies the admin password. This command is interactive in that the user is prompted for the old and new admin password (with confirmation). 

change-master-password

This local command is used to modify the master password. This command is interactive in that the user is prompted for the old and new master password. This command will not work unless the server is stopped. 

verify-domain-xml

Verifies the content of the domain.xml file.

login

Lets you log into a domain. If various application server domains are created on various machines (locally), asadmin invocation from any of these machines can manage the domains located elsewhere (remotely). This comes in handy especially when a particular machine is chosen as an administration client and it manages multiple domains and servers. asadmin commands that are used to manage domains located elsewhere are called remote commands. The asadmin login command eases the administration of such remote domains. The login command runs only in the interactive mode. It prompts you for the admin user name and password. On successful login, the file .asadminpass will be created in the user's home directory. This is the same file that is modified by the create-domain command while using the -‐savelogin option. The domain must be running for this command to run.

version

Displays the version information. If the command cannot communicate with the administration server with the given user/password and host/port, then the command will retrieve the version locally and display a warning message. 

help

Displays a list of all the asadmin utility commands. Specify the command to display the usage information for that command

install-license

Prevents unauthorized use of the Application Server. Allows you to install the license file.