Appendix A The `asadmin` Utility Commands

This appendix lists the asadmin commands that are included with this release of the Sun GlassFish^TM Enterprise Server v3 Prelude software.

Online help for the asadmin commands can be invoked on the command line, for example, asadmin create-domain --help. The Sun GlassFish Enterprise Server v3 Prelude Reference Manual also provides a collection of these help pages.

For general information on the asadmin utility, see Command-Line Utility for Administration (asadmin) or asadmin(1M).

Note –

The common options used with remote commands are described in the asadmin(1M) help page.

Basic Administration Commands

create-domain(1): Creates the configuration of a domain. A domain can exist independent of other domains. Any user who has access to the asadmin utility on a given host can create a domain and store its configuration in a location of choice. For procedural information in this guide, see To Create a Domain.
create-system-properties(1): The create-system-properties command creates or updates system properties. Supported in remote mode only. For procedural information in this guide, see To Create System Properties.
delete-domain(1): Deletes the specified domain. The domain must be stopped before it can be deleted. For procedural information in this guide, see To Delete a Domain.
delete-system-property(1): Deletes system properties of a domain or configuration. Supported in remote mode only. For procedural information in this guide, see To Delete a System Property.
get(1): Gets an attribute of an element in the domain.xml file. With the -m option, gets the names and values of the monitorable or configurable attributes. For procedural information in this guide, see Guidelines for Using the list and get Commands for Monitoring.
list(1): Lists the configurable element. On Solaris, quotes are needed when running commands with * as the option value or operand. For procedural information in this guide, see Guidelines for Using the list and get Commands for Monitoring.
list-commands(1): Lists all the asadmin commands, local commands first, then remote commands. You can specify that only remote commands or only local commands be displayed. Supported in remote mode only. For procedural information in this guide, see To List Commands.
list-containers(1): Lists application containers and the status of each container. Supported in remote mode only. For procedural information in this guide, see To List Containers.
list-domains(1): Lists the existing domains and their statuses. If the domain directory is not specified, the domains in the default as-install/domains directory is displayed. For procedural information in this guide, see To List Domains.
list-modules(1): Lists modules that are accessible to the Enterprise Server subsystem. The status of each module is included. Supported in remote mode only. For procedural information in this guide, see To List Modules.
list-system-properties(1): Lists the system properties of a domain or configuration. Supported in remote mode only. For procedural information in this guide, see To List System Properties.
login(1): Allows you to log in to the domain. For procedural information in this guide, see To Log In to a Domain (or Server)
monitor(1): Displays monitoring information for the common Enterprise Server resources. Supported in remote mode only. For procedural information in this guide, see To View Common Monitoring Data.
set(1): Sets the values of one or more configurable attributes. For procedural information in this guide, see Configuring Monitoring.
start-domain(1): Starts a domain. If the domain directory is not specified, the default domain1 in the default as-install/domains directory is started. If there are two or more domains, the domain_name operand must be specified. For procedural information in this guide, see To Start a Domain (or Server).
start-database(1): Starts the Java DB server. Use this command only for working with applications deployed to the Enterprise Server. For procedural information in this guide, see To Start the Database.
stop-database(1): Stops a process of the Java DB database server. For procedural information in this guide, see To Stop the Database.
stop-domain(1): Stops the domain administration server (DAS) of the specified domain. Supported in remote mode only. For procedural information in this guide, see To Stop a Domain (or Server).
uptime(1): Displays the length of time that the domain administration server (DAS) has been running since the last restart. Supported in remote mode only. For procedural information in this guide, see To Display Domain Uptime.
version(1): Displays the version information for the option specified in archive or folder format. 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. Supported in remote mode only. For procedural information in this guide, see To Display the Enterprise Server Version.

Deployment Commands

deploy(1): Deploys an enterprise application, web application, EJB module, connector module, or application client module. If the component is already deployed or already exists, you can forcefully redeploy if you set the --force option to true. Supported in remote mode only.
deploydir: This command is deprecated.
disable(1): Immediately disables the named component. If the component has not been deployed, an error message is returned. Supported in remote mode only.
enable(1): Enables the specified component. If the component has not been deployed, an error message is returned. If the component is already enabled, then it is re-enabled. Supported in remote mode only.
list-applications(1): Lists deployed Java^TM EE applications. If the --type option is not specified, all applications are listed. Supported in remote mode only.
list-components(1): Lists all deployed Java EE 5 components. If the --type option is not specified, all components are listed. Supported in remote mode only.
redeploy(1): Redeploys an application that is already deployed. Supported in remote mode only.
undeploy(1): Removes the specified deployed application. Supported in remote mode only.

HTTP Service Commands

create-http-listener(1): Creates a new HTTP listener socket. Restart the server for the change to take effect. Supported in remote mode only. For procedural information in this guide, see To Create an HTTP Listener.
create-virtual-server(1): Creates the specified virtual server element. Restart the server for the change to take effect. Supported in remote mode only. For procedural information in this guide, see To Create a Virtual Server.
create-ssl(1): Creates and configures the SSL element in the selected HTTP listener to enable secure communication on that listener/service. Restart the server for the change to take effect. Supported in remote mode only. For procedural information in this guide, see To Configure an HTTP Listener for SSL.
delete-http-listener(1): Deletes the specified HTTP listener. Restart the server for the change to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete an HTTP Listener.
delete-ssl(1): Deletes the SSL element in the selected HTTP listener. Restart the server for the change to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete SSL From an HTTP Listener.
delete-virtual-server(1): Deletes the specified virtual server element. Restart the server for the change to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete a Virtual Server.
list-http-listeners(1): Lists the existing HTTP listeners. Supported in remote mode only. For procedural information in this guide, see To List HTTP Listeners.
list-virtual-servers(1): Lists the existing virtual servers. Supported in remote mode only. For procedural information in this guide, see To List Virtual Servers.

JVM Commands

create-jvm-options(1): Creates a JVM option in the Java configuration or profiler elements of the domain.xml file. If JVM options are created for a profiler, the options are used to record the settings needed to activate a particular profiler. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Create JVM Options.
create-profiler(1): Creates a profiler element. A server instance is tied to a particular profiler, by the profiler element in the Java configuration. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Create a Profiler.
delete-jvm-options(1): Deletes the specified JVM option from the Java configuration or profiler elements of the domain.xml file. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete JVM Options.
delete-profiler(1): Deletes the specified profiler element. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete a Profiler.
generate-jvm-report(1): Generates a report showing the threads, classes, and memory for the virtual machine that runs Enterprise Server. For procedural information in this guide, see To Generate a JVM Report.
list-jvm-options(1): Lists the command-line options that are passed to the Java application launcher when theEnterprise Server is started. Supported in remote mode only. For procedural information in this guide, see To List JVM Options.

Resource Management Commands

add-resources(1): Creates the resources named in the specified XML file. Supported in remote mode only. For procedural information in this guide, see To Add Resources.
create-jdbc-connection-pool(1): Registers a new JDBC connection pool with the specified JDBC connection pool name. Supported in remote mode only. For procedural information in this guide, see To Create a JDBC Connection Pool.
create-jdbc-resource(1): Creates a new JDBC resource. Supported in remote mode only. For procedural information in this guide, see To Create a JDBC Resource.
delete-jdbc-connection-pool(1): Deletes the specified JDBC connection pool. Supported in remote mode only. For procedural information in this guide, see To Delete a JDBC Connection Pool.
delete-jdbc-resource(1): Deletes a JDBC resource. The specified JNDI name identifies the resource to be deleted. Supported in remote mode only. For procedural information in this guide, see To Delete a JDBC Resource.
list-jdbc-connection-pools(1): Lists the existing JDBC connection pools. Supported in remote mode only. For procedural information in this guide, see To List JDBC Connection Pools.
list-jdbc-resources(1): Lists the existing JDBC resources. Supported in remote mode only. To List JDBC Resources.
ping-connection-pool(1): Tests if a JDBC connection pool is usable. Before you can ping a JDBC connection pool, you must create the connection pool with authentication and ensure that the server or database is started. Supported in remote mode only. For procedural information in this guide, see To Contact (Ping) a Connection Pool.

Security Commands

change-admin-password(1): Modifies the admin password. You are prompted for the old and new admin password (with confirmation). For procedural information in this guide, see To Change the Administration Password.
create-audit-module(1): Adds the named audit module for the plug-in that implements the audit capabilities. Supported in remote mode only. For procedural information in this guide, see To Create an Audit Module.
delete-audit-module(1): Removes the named audit module. Supported in remote mode only. For procedural information in this guide, see To Delete an Audit Module.
list-audit-modules(1): Lists all audit modules. Supported in remote mode only. For procedural information in this guide, see To List Audit Modules.

User Management Commands

create-auth-realm(1): Adds the specified authentication realm. Restart the server for the creation to take effect. Supported in remote mode only. For procedural information in this guide, see To Create an Authentication Realm.
create-file-user(1): Creates a file user in a given file-based authentication realm. An entry is added to the keyfile with the specified user name, password, and groups. Multiple groups can be created by separating each one with a colon (:). Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Create a File User.
delete-auth-realm(1): Deletes the specified authentication realm. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete an Authentication Realm.
delete-file-user(1): Deletes the specified user entry in the keyfile. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Delete a File User.
list-auth-realms(1): Lists the existing authentication realms. Supported in remote mode only. For procedural information in this guide, see To List Authentication Realms.
list-file-users(1): Lists the file users supported by the file realm authentication method. Supported in remote mode only. For procedural information in this guide, see To List File Users.
list-file-groups(1): Lists groups for a file user, or all groups if the --name option is not specified. For procedural information in this guide, see To List File Groups.
update-file-user(1): Updates an existing entry in the keyfile using the specified user name, password, and groups. Restart the server for changes to take effect. Supported in remote mode only. For procedural information in this guide, see To Update a File User.

Previous: Chapter 10 Monitoring the Enterprise Server

Appendix A The asadmin Utility Commands