• NAME
• SYNOPSIS
• DESCRIPTION
• EXAMPLES
• INTERFACE EQUIVALENT
• SEE ALSO

NAME

 asadmin-help, help - displays a list of all the commands available in the Command-line interface

SYNOPSIS

 asadmin --help or asadmin command --help

DESCRIPTION

Use the help command to display a list of all the commands available in the Command-line interface. Specify the command to display the usage information for that command.

The commands marked (Enterprise Edition only) are available in the Enterprise edition release of the Sun Java System Application Server. All the other commands are part of both the Standard and Enterprise editions of the Sun Java System Application Server.

The following is a list of all the Command-line interface commands:

add-iiop-cluster-endpoint(Enterprise Edition only)	Adds an IIOP endpoint to the IIOP cluster.
add-resources	Adds one or more resources of type jdbc, jms, or javamail.
clear-session-store(Enterprise Edition only)	Clears the sessions for all application server instances from the HADB database.
configure-session-persistence(Enterprise Edition only)	Configures session persistence options for an application server instance.
create-acl	Creates an ACL (access control list).
create-authdb	Creates an authentication database.
create-auth-realm	Creates an authentication realm.
create-connection-pool	Creates a new connection group with the named group ID for the associated instance.
create-custom-resource	Creates a custom resource.
create-domain	Creates a domain.
create-file-user	Creates a file realm user in the keyfile.
create-http-listener	Creates an HTTP listener.
create-http-qos	Creates HTTP quality of service settings for the application server instance or virtual server.
create-iiop-listener	Creates an IIOP listener.
create-instance	Creates an application server instance.
create-javamail-resource	Creates a Java Mail resource.
create-jdbc-connection-pool	Creates a JDBC connection pool.
create-jdbc-resource	Creates a JDBC resource.
create-jmsdest	Creates a JMS (Java Message Service) destination.
create-jms-resource	Creates a JMS resource.
create-jndi-resource	Creates a JNDI resource.
create-jvm-options	Creates JVM options in java-config or profiler elements.
create-lifecycle-module	Creates a lifecycle module.
create-mime	Creates a MIME types file.
create-persistence-resource	Creates a persistence manager factory resource.
create-profiler	Creates a profiler for the JVM.
create-session-store(Enterprise Edition only)	Creates a session store for a cluster to store the session information.
create-ssl	Creates SSL settings for an HTTP listener, IIOP listener, or IIOP service.
create-virtual-server	Creates a virtual server.
delete-acl	Deletes an ACL.
delete-authdb	Deletes an authentication database.
delete-auth-realm	Deletes an authentication realm.
delete-connection-group	Deletes the connection group for the named instance.
delete-custom-resource	Deletes a custom resource.
delete-domain	Deletes a domain. This command can only be executed locally.
delete-file-user	Deletes a file realm user from the keyfile.
delete-http-listener	Deletes an HTTP listener.
delete-http-qos	Deletes HTTP quality of service settings for the application server instance or virtual server.
delete-iiop-cluster-endpoint(Enterprise Edition only)	Deletes IIOP endpoint from the IIOP cluster configuration.
delete-iiop-listener	Deletes an IIOP listener
delete-instance	Deletes an application server instance.
delete-javamail-resource	Deletes a Java Mail resource.
delete-jdbc-connection-pool	Deletes a JDBC connection pool.
delete-jdbc-resource	Deletes a JDBC resource.
delete-jmsdest	Deletes a JMS destination.
delete-jms-resource	Deletes a JMS resource.
delete-jndi-resource	Deletes a JNDI resource.
delete-jvm-options	Deletes JVM options in java-config or profiler elements.
delete-lifecycle-module	Deletes a lifecycle module.
delete-mime	Deletes a MIME types file.
delete-persistence-resource	Deletes a persistence manager factory resource.
delete-profiler	Deletes a JVM profiler.
delete-ssl	Deletes SSL settings for an HTTP listener, IIOP listener, or IIOP service.
delete-virtual server	Deletes a virtual server.
deploy	Deploys an EJB, WEB, connector, appclient, or application component to the application server instance.
deploydir	Deploys an EJB, WEB, connector, appclient, or application component that is in the directory to the application server instance.
disable	Disables a deployed component in the application server instance.
display-license	Displays license information. This command can only be executed locally.
enable	Enables (allows to run) a deployed component in the application server instance.
export	Exports the value of an asadmin environment variable so that it can be used by the subsequent asadmin commands.
get	Gets the value of an attribute.
help	Displays help (description, usage, syntax, examples) for a given command, or general help for asadmin.
install-license	Installs the license file. This command can only be executed locally.
jms-ping	Pings the JMS provider to see if it is running.
list	Lists the configurable elements.
list-acls	Lists ACLs for an application server instance.
list-authdbs	Lists authentication databases.
list-auth-realms	Lists authentication realms.
list-components	Lists the deployed components for a server instance.
list-connection-groups	Gets the connection groups for the named instance.
list-custom-resources	Lists custom resources in a server instance
list-domains	Lists domains.
list-file-groups	Lists all the groups for a specified file realm user. If you do not specify a user, lists all groups for a server instance.
list-file-users	Lists all the file realm users in a server instance.
list-http-listeners	Lists HTTP listeners for a server instance.
list-instances	Lists application server instances in the domain.
list-iiop-cluster-config(Enterprise Edition only)	Lists the IIOP cluster configuration.
list-iiop-listeners	Lists IIOP listeners for a server instance.
list-javamail-resources	Lists Java Mail resources for a server instance.
list-jdbc-connection-pools	Lists JDBC connection pools for a server instance.
list-jdbc-resources	Lists JDBC resources for a server instance.
list-jmsdest	Lists JMS destinations for a server instance.
list-jms-resources	Lists JMS resources for a server instance
list-jndi-resources	Lists JNDI resources for a server instance.
list-lifecycle-modules	Lists lifecycle modules for a server instance.
list-mimes	Lists MIME types files for a server instance.
list-persistence-resources	Lists persistence manager factory resources for a server instance.
list-profilers	Lists JVM profilers for a server instance.
list-sub-components	Lists one or more EJBs or Servlets in a deployed module or in a module of the deployed application.
list-virtual-servers	Lists virtual servers for a server instance.
multimode	Allows you to execute multiple command while retaining your environment settings and remaining within asadmin.
reconfig	Applies change to the server. Most changes do not take effect until they are applied.
restart-instance	Restarts the server instance.
set	Sets the value of an attribute.
show-component-status	Shows the status of a deployed component.
show-instance-status	Shows the status of a server instance (that is, whether it is running or not).
shutdown	Shuts down the Administration Server.
start-appserv	Starts the Administration Server and all the server instances. This command can only be executed locally.
start-domain	Starts all instances in the domain. This command can only be executed locally.
start-instance	Starts the server instance.
stop-appserv	Stops the Administration Server and all the server instances. This command can only be executed locally.
stop-domain	Stops all instances in the domain.
stop-instance	Stops the server instance.
undeploy	Removes the deployed component from the server instance.
unset	Unsets the exported environment variables for asadmin.
update-file-user	Updates an existing file realm user.
version	Displays version information for the Sun Java System Application Server.

EXAMPLES

Example 1. Using the help command

asadmin> help
asadmin> create-instance --help

Where: create-instance is the command you wish to view the usage for.

INTERFACE EQUIVALENT

The Help button on any screen in the Administration interface

SEE ALSO

asadmin-multimode(1as)