<!--Arbortext, Inc., 1988-2008, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="help-1"><?Pub Tag atict:info tracking="off" ref="2"><?Pub Tag atict:user
user="hl34125" fullname="Hanan Lang"><?Pub Tag atict:user user="pmdavies"
fullname="Paul M Davies"><?Pub Tag atict:user user="ah95648" fullname="">
<!-- @(#)help.1 1.16 08/03/18 SMI; -->
<refmeta><refentrytitle>help</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">Oct 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright 2008, Sun Microsystems, Inc. All
Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary>help</primary></indexterm><indexterm><primary>displays
the asadmin utility commands</primary></indexterm>
<refname>help</refname><refpurpose>displays the asadmin utility commands</refpurpose>
</refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>help</command>  [<replaceable>command_name</replaceable>]</synopsis>
<synopsis><command><replaceable>command_name</replaceable></command>  [<option
role="double-dash">help</option> | &ndash;?]</synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The help command displays a list of all the <command>asadmin</command> utility
commands. Specify the command to display the usage information for that command.
To display the man page of each command, use the syntax: <command>asadmin</command> <replaceable>
command_name</replaceable> <option role="double-dash">help</option> | <option>?</option> or <command>
asadmin help</command> <replaceable>command_name</replaceable></para>
<para>The following is a list of all the <command>asadmin</command> utility
commands:</para>
<variablelist termlength="wholeline">
<varlistentry><term><command>add-resources</command></term>
<listitem><para>registers the resource in the specified XML file</para>
</listitem>
</varlistentry>
<varlistentry><term><command>apply-http-lb-changes</command></term>
<listitem><para>applies load balancer configuration changes to the load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>backup-domain</command></term>
<listitem><para>performs a backup on the domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>change-admin-password</command></term>
<listitem><para>changes the administrator password</para>
</listitem>
</varlistentry>
<varlistentry><term><command>change-master-password</command></term>
<listitem><para>changes the master password</para>
</listitem>
</varlistentry>
<varlistentry><term><command>clear-ha-store</command></term>
<listitem><para>deletes tables in the HA database</para>
</listitem>
</varlistentry>
<varlistentry><term><command>configure-ha-cluster</command></term>
<listitem><para>configures an existing cluster to be High Availability</para>
</listitem>
</varlistentry>
<varlistentry><term><command>configure-ha-persistence</command></term>
<listitem><para>enables configuration of parameters related to session persistence
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>configure-lb-weight</command></term>
<listitem><para>sets load balancing weights for clustered instances</para>
</listitem>
</varlistentry>
<varlistentry><term><command>configure-webservice-management</command></term>
<listitem><para> sets the monitoring or maxhistory or attributes of a deployed
webservice</para>
</listitem>
</varlistentry>
<varlistentry><term><command>copy-config</command></term>
<listitem><para>copies an existing configuration to create a new configuration</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-admin-object</command></term>
<listitem><para>adds the administered object with the specified JNDI name</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-application-ref</command></term>
<listitem><para>creates a reference to an application</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-audit-module</command></term>
<listitem><para>creates an audit module for the optional plugin module</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-auth-realm</command></term>
<listitem><para>adds the named authorized realm</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-cluster</command></term>
<listitem><para>creates a cluster</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-connector-connection-pool</command></term>
<listitem><para>adds a connection pool with the specified connection pool
name</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-connector-resource</command></term>
<listitem><para>registers the resource with the specified JNDI name</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-connector-security-map</command></term>
<listitem><para>creates or modifies a security map for the named connector
connection pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-converged-lb</command></term>
<listitem><para>creates a converged load balancer. </para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>create-converged-lb-config</command></term>
<listitem><para>creates a converged load balancer configuration.</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>create-converged-lb-ref</command></term>
<listitem><para>creates a converged load balancer reference. </para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem><?Pub Caret1>
</varlistentry>
<varlistentry><term><command>create-custom-resource</command></term>
<listitem><para>registers the custom resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-domain</command></term>
<listitem><para>creates a domain with the specified name</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-file-user</command></term>
<listitem><para>creates a new file user</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-ha-store</command></term>
<listitem><para>creates tables in HA database that are used by HA cluster</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-http-health-checker</command></term>
<listitem><para>creates a health-checker for a specified load balancer configuration
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-http-lb</command></term>
<listitem><para>creates a load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-http-lb-config</command></term>
<listitem><para>creates a configuration for the load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-http-lb-ref</command></term>
<listitem><para>add an existing cluster or server instance to an existing
load balancer configuration</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-http-listener</command></term>
<listitem><para>adds a new HTTP listener socket</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-iiop-listener</command></term>
<listitem><para>adds the IIOP listener</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-instance</command></term>
<listitem><para>creates an instance with the given name</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-javamail-resource</command></term>
<listitem><para>registers the Javamail resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jdbc-connection-pool</command></term>
<listitem><para>registers the JDBC connection pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jdbc-resource</command></term>
<listitem><para>registers the JDBC resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jms-host</command></term>
<listitem><para>creates a JMS host</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jms-resource</command></term>
<listitem><para>registers the JMS resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jmsdest</command></term>
<listitem><para>adds the named destination</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jndi-resource</command></term>
<listitem><para>registers the JNDI resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-jvm-options</command></term>
<listitem><para>creates the JVM options from the Java configuration or profiler
elements</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-lifecycle-module</command></term>
<listitem><para>adds a lifecycle module</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-management-rule</command></term>
<listitem><para>creates a new management rule</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-mbean</command></term>
<listitem><para>creates and registers a custom MBean</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-message-security-provider</command></term>
<listitem><para>enables administrators to create the <property>message-security-config
</property> and <property>provider-config</property> sub-elements for the
security service in <filename>domain.xml</filename></para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-node-agent-config</command></term>
<listitem><para>adds a new unbound node agent to a domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-node-agent</command></term>
<listitem><para>creates a node agent and its associated directory structure</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-password-alias</command></term>
<listitem><para>creates a password alias</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-persistence-resource</command></term>
<listitem><para>registers the persistence resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-profiler</command></term>
<listitem><para>creates the profiler element</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-resource-adapter-config</command></term>
<listitem><para> creates the resource adapter Java bean</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-resource-ref</command></term>
<listitem><para>creates a reference to a resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-service</command></term>
<listitem><para>configures the starting of a DAS or node agent on an unattended
boot</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-sip-listener</command></term>
<listitem><para>creates the SIP listener.</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>create-ssl</command></term>
<listitem><para>creates the SSL element in the HTTP listener or IIOP listener</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-system-properties</command></term>
<listitem><para>adds or updates one or more system properties of the domain,
configuration, cluster, or server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-threadpool</command></term>
<listitem><para>creates the thread pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-transformation-rule</command></term>
<listitem><para>creates transformation rule for a deployed web service</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-trust-config</command></term>
<listitem><para>creates a trust configuration.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-trusted-entity</command></term>
<listitem><para>creates a trusted entity.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>create-virtual-server</command></term>
<listitem><para>adds the named virtual server</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-admin-object</command></term>
<listitem><para>removes the administered object with the specified JNDI name</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-application-ref</command></term>
<listitem><para>removes a reference to an application</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-audit-module</command></term>
<listitem><para>deletes the audit-module for the optional plugin module</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-auth-realm</command></term>
<listitem><para>removes the named authorized realm</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-converged-lb</command></term>
<listitem><para>deletes the specified converged load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-converged-lb-config</command></term>
<listitem><para>deletes the specified converged load balancer configuration.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-converged-lb-ref</command></term>
<listitem><para>deletes the specified converged load balancer reference.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-cluster</command></term>
<listitem><para>deletes a cluster</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-config</command></term>
<listitem><para>deletes an existing configuration</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-connector-connection-pool</command></term>
<listitem><para>removes the specified connection pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-connector-resource</command></term>
<listitem><para>removes the named resource connector</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-connector-security-map</command></term>
<listitem><para>deletes the named security map</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-custom-resource</command></term>
<listitem><para>removes the custom resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-domain</command></term>
<listitem><para>deletes the given domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-file-user</command></term>
<listitem><para>removes the named file user</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-http-health-checker</command></term>
<listitem><para>deletes a health-checker for a specified load balancer configuration
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-http-lb</command></term>
<listitem><para>deletes a load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-http-lb-config</command></term>
<listitem><para>deletes a load balancer configuration</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-http-lb-ref</command></term>
<listitem><para>deletes the cluster or server instance from a load balancer
configuration</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-http-listener</command></term>
<listitem><para>removes the HTTP listener</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-iiop-listener</command></term>
<listitem><para>removes the IIOP listener</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-instance</command></term>
<listitem><para>deletes the instance that is not running</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-javamail-resource</command></term>
<listitem><para>removes the Javamail resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jdbc-connection-pool</command></term>
<listitem><para>removes the JDBC connection pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jdbc-resource</command></term>
<listitem><para>removes the JDBC resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jms-host</command></term>
<listitem><para>removes a JMS host</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jms-resource</command></term>
<listitem><para>removes the JMS resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jmsdest</command></term>
<listitem><para>destroys the named destination</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jndi-resource</command></term>
<listitem><para>removes the JNDI resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-jvm-options</command></term>
<listitem><para>deletes the JVM options from the Java configuration or profiler
elements</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-lifecycle-module</command></term>
<listitem><para>removes the lifecycle module</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-management-rule</command></term>
<listitem><para>deletes a specified management rule</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-mbean</command></term>
<listitem><para>deletes a custom MBean </para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-message-security-provider</command></term>
<listitem><para>enables administrators to delete a <property>provider-config</property> sub-element
for the given message layer (<property>message-security-config</property> element
of <filename>domain.xml</filename>)</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-node-agent-config</command></term>
<listitem><para>removes a node agent from a domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-node-agent</command></term>
<listitem><para>deletes the node agent and its associated directory structure</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-password-alias</command></term>
<listitem><para>deletes a password alias</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-persistence-resource</command></term>
<listitem><para>removes the persistence resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-profiler</command></term>
<listitem><para>deletes the profiler element</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-resource-adapter-config</command></term>
<listitem><para>deletes the resource adapter Java bean</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-resource-ref</command></term>
<listitem><para>removes a reference to a resource</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-sip-listener</command></term>
<listitem><para>deletes the specified SIP listener.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-ssl</command></term>
<listitem><para>deletes the ssl element from the HTTP listener or IIOP listener</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-system-property</command></term>
<listitem><para>removes one or more system properties of the domain, configuration,
cluster, or server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-threadpool</command></term>
<listitem><para>deletes the thread pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-transformation-rule</command></term>
<listitem><para>deletes the transformation rule of a given web service</para>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-trust-config</command></term>
<listitem><para>deletes the trust configuration.</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-trusted-entity</command></term>
<listitem><para>deletes the trusted entity</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>delete-virtual-server</command></term>
<listitem><para>deletes the virtual server with the named virtual server ID</para>
</listitem>
</varlistentry>
<varlistentry><term><command>deploy-jbi-service-assembly</command></term>
<listitem><para>deploys a service assembly into the JBI environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>deploy</command></term>
<listitem><para>deploys the specified component</para>
</listitem>
</varlistentry>
<varlistentry><term><command>deploydir</command></term>
<listitem><para>deploys the component that is in the specified directory,
located in the domain </para>
</listitem>
</varlistentry>
<varlistentry><term><command>disable-http-lb-server</command></term>
<listitem><para>disables a sever or cluster managed by a load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>disable-converged-lb-server</command></term>
<listitem><para>disables a sever or cluster managed by a converged load balancer</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>disable-http-lb-application</command></term>
<listitem><para>disables an application managed by a load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>disable</command></term>
<listitem><para>stops the specified, deployed component</para>
</listitem>
</varlistentry>
<varlistentry><term><command>display-error-distribution</command></term>
<listitem><para>displays distribution of errors from instance server.log at
module level</para>
</listitem>
</varlistentry>
<varlistentry><term><command>display-error-statistics</command></term>
<listitem><para>displays a summary list of severities and warnings</para>
</listitem>
</varlistentry>
<varlistentry><term><command>display-log-records</command></term>
<listitem><para>displays all the error messages for a given module at a given
timestamp</para>
</listitem>
</varlistentry>
<varlistentry><term><command>enable-converged-lb-server</command></term>
<listitem><para>enables a previously disabled sever or cluster managed by
a converged load balancer</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>enable-http-lb-application</command></term>
<listitem><para>enables a previously-disabled application managed by a load
balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>enable-http-lb-server</command></term>
<listitem><para>enables a previously disabled sever or cluster managed by
a load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>enable</command></term>
<listitem><para>runs the specified, deployed component</para>
</listitem>
</varlistentry>
<varlistentry><term><command>export-http-lb-config</command></term>
<listitem><para>exports the load balancer configuration to a file that can
be used by the load balancer</para>
</listitem>
</varlistentry>
<varlistentry><term><command>export</command></term>
<listitem><para>marks a variable name for automatic export to the environment
of subsequent commands in multimode</para>
</listitem>
</varlistentry>
<varlistentry><term><command>flush-jmsdest</command></term>
<listitem><para>purges the messages in a JMS destination</para>
</listitem>
</varlistentry>
<varlistentry><term><command>freeze-transaction-service</command></term>
<listitem><para>immobilizes the named transaction service</para>
</listitem>
</varlistentry>
<varlistentry><term><command>generate-diagnostic-report</command></term>
<listitem><para>generates reports that can help diagnose malfunctioning</para>
</listitem>
</varlistentry>
<varlistentry><term><command>generate-jvm-report</command></term>
<listitem><para>shows the threads, classes and memory for a given target instance
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>get-client-stubs</command></term>
<listitem><para>gets the stubs of the client</para>
</listitem>
</varlistentry>
<varlistentry><term><command>get</command></term>
<listitem><para>gets the values of the monitorable or configurable attributes</para>
</listitem>
</varlistentry>
<varlistentry><term><command>get-health</command></term>
<listitem><para>provides information on the cluster health</para>
</listitem>
</varlistentry>
<varlistentry><term><command>help</command></term>
<listitem><para>displays a list of all the commands available in the command-line
interface</para>
</listitem>
</varlistentry>
<varlistentry><term><command>install-jbi-component</command></term>
<listitem><para>installs a service engine or binding component into the JBI
environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>install-jbi-shared-library</command></term>
<listitem><para>installs a shared library into the JBI environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>jms-ping</command></term>
<listitem><para>checks to see if the JMS provider is running</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-admin-objects</command></term>
<listitem><para>lists all the administered objects</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-application-refs</command></term>
<listitem><para>lists all application references in a cluster or unclustered
server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-audit-modules</command></term>
<listitem><para>lists the audit modules</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-auth-realms</command></term>
<listitem><para>lists the authorized realms</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-backups</command></term>
<listitem><para>lists all backups and restores</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-clusters</command></term>
<listitem><para>lists the existing clusters</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-components</command></term>
<listitem><para>lists deployed components </para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-configs</command></term>
<listitem><para>lists all existing configurations</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-connector-connection-pools</command></term>
<listitem><para> gets all the connection pools</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-connector-resources</command></term>
<listitem><para>gets all the connector resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-connector-security-maps</command></term>
<listitem><para>lists the security maps for the connector connection pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-converged-lbs</command></term>
<listitem><para>lists all the converged load balancers.</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>list-converged-lb-configs</command></term>
<listitem><para>lists all the converged load balancer configurations.</para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>list-custom-resources</command></term>
<listitem><para>gets all the custom resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-domains</command></term>
<listitem><para>lists the domains in the given domains directory</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-file-groups</command></term>
<listitem><para>lists the file groups</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-file-users</command></term>
<listitem><para>lists the file users </para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-http-lb-configs</command></term>
<listitem><para>lists load balancer configurations</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-http-lbs</command></term>
<listitem><para>lists load balancers</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-http-listeners</command></term>
<listitem><para>gets the HTTP listeners</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-iiop-listeners</command></term>
<listitem><para>gets the IIOP listeners</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-instances</command></term>
<listitem><para>lists all the instances in the server</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-javamail-resources</command></term>
<listitem><para>gets all the Javamail resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jdbc-connection-pools</command></term>
<listitem><para>registers the JDBC connection pool</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jdbc-resources</command></term>
<listitem><para>gets all the JDBC resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jbi-binding-components</command></term>
<listitem><para>lists the binding components installed on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jbi-service-assemblies</command></term>
<listitem><para>lists the service assemblies installed into the JBI environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jbi-service-engines</command></term>
<listitem><para>lists the service engines installed on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jbi-shared-libraries</command></term>
<listitem><para>lists the JBI shared libraries that are installed into the
JBI environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jms-hosts</command></term>
<listitem><para>lists the existing JMS hosts</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jms-resources</command></term>
<listitem><para>gets all the JMS resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jmsdest</command></term>
<listitem><para>gets all the named destinations</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jndi-entries</command></term>
<listitem><para>gets all the named destinations, browses and queries the JNDI
tree</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-jndi-resources</command></term>
<listitem><para>gets all the JNDI resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-lifecycle-modules</command></term>
<listitem><para>gets the lifecycle modules</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-management-rules</command></term>
<listitem><para>lists the management rules created using the <command>create-management-rule
</command> command</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-mbeans</command></term>
<listitem><para>lists the custom mbeans for a given target server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-message-security-providers</command></term>
<listitem><para>enables administrators to list all security message providers
(<property>provider-config</property> sub-elements) for the given message
layer (<property>message-security-config</property> element of <filename>domain.xml
</filename>) </para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-node-agents</command></term>
<listitem><para>lists the node agents along with their status</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-password-aliases</command></term>
<listitem><para>lists all password aliases</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-persistence-resources</command></term>
<listitem><para>gets all the persistence resources</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-registry-locations</command></term>
<listitem><para>returns list of configured web service registry access points</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-resource-adapter-configs</command></term>
<listitem><para>lists the resource adapters configured in an instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-resource-refs</command></term>
<listitem><para>lists the existing resource references</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-sub-components</command></term>
<listitem><para>lists EJBs or Servlets in a deployed module or in a module
of a deployed application</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-system-properties</command></term>
<listitem><para>lists the system properties of the domain, configuration,
cluster, or server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-threadpools</command></term>
<listitem><para>lists the thread pools</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-timers</command></term>
<listitem><para>lists all of the timers owned by server instance(s) </para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-transformation-rules</command></term>
<listitem><para>lists all the transformation rules of a given webservice</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-trust-configs</command></term>
<listitem><para>lists all identity assertion trust configurations.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list-virtual-servers</command></term>
<listitem><para>gets the virtual servers</para>
</listitem>
</varlistentry>
<varlistentry><term><command>list</command></term>
<listitem><para>lists the configurable elements and provides the fully qualified
dotted names of the management components that have read-only or modifiable
attributes</para>
</listitem>
</varlistentry>
<varlistentry><term><command>login</command></term>
<listitem><para>lets you log in to a domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>migrate-timers</command></term>
<listitem><para>moves a timer when a server instance stops</para>
</listitem>
</varlistentry>
<varlistentry><term><command>monitor</command></term>
<listitem><para>displays monitoring data for commonly-used components</para>
</listitem>
</varlistentry>
<varlistentry><term><command>multimode</command></term>
<listitem><para>allows you to execute multiple commands while returning environment
settings and remaining in the <command>asadmin</command> utility</para>
</listitem>
</varlistentry>
<varlistentry><term><command>ping-connection-pool</command></term>
<listitem><para>tests if a connection pool is usable</para>
</listitem>
</varlistentry>
<varlistentry><term><command>publish-to-registry</command></term>
<listitem><para>publishes all the web service artifacts to registries</para>
</listitem>
</varlistentry>
<varlistentry><term><command>recover-transactions</command></term>
<listitem><para>manually recovers pending transactions</para>
</listitem>
</varlistentry>
<varlistentry><term><command>remove-ha-cluster</command></term>
<listitem><para>returns an HA cluster to non-HA status</para>
</listitem>
</varlistentry>
<varlistentry><term><command>restore-domain</command></term>
<listitem><para>restores files from backup</para>
</listitem>
</varlistentry>
<varlistentry><term><command>rollback-transaction</command></term>
<listitem><para>rolls back the named transaction</para>
</listitem>
</varlistentry>
<varlistentry><term><command>set</command></term>
<listitem><para>sets the values of attributes. Set command can be used to
modify default properties of a resource.</para>
</listitem>
</varlistentry>
<varlistentry><term><command>set-dcr-file</command></term>
<listitem><para>uploads the Data Centric Rule (DCR) file from the Domain Administration
Server (DAS). </para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>show-component-status</command></term>
<listitem><para>displays the status of the deployed component</para>
</listitem>
</varlistentry>
<varlistentry><term><command>show-jbi-binding-component</command></term>
<listitem><para>shows detailed information about the  specified binding component
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>show-jbi-service-assembly</command></term>
<listitem><para>shows detailed information about a specified service assembly</para>
</listitem>
</varlistentry>
<varlistentry><term><command>show-jbi-service-engine</command></term>
<listitem><para>shows detailed information about the  specified service engine</para>
</listitem>
</varlistentry>
<varlistentry><term><command>show-jbi-shared-library</command></term>
<listitem><para>shows detailed information about a specified shared library</para>
</listitem>
</varlistentry>
<varlistentry><term><command>shut-down-jbi-component</command></term>
<listitem><para>shuts down a service engine or a binding component on the
specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>shut-down-jbi-service-assembly</command></term>
<listitem><para>shuts down a JBI service assembly on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-appserv</command></term>
<listitem><para>starts the domains in the specified domains directory</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-callflow-monitoring</command></term>
<listitem><para>provides the complete callflow/path of a request</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-cluster</command></term>
<listitem><para>starts a cluster</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-database</command></term>
<listitem><para>starts the bundled Java DB database</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-domain</command></term>
<listitem><para>starts the given domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-instance</command></term>
<listitem><para>starts a server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-jbi-component</command></term>
<listitem><para>starts a service engine or a binding component on the specified
target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-jbi-service-assembly</command></term>
<listitem><para>starts a service assembly on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>start-node-agent</command></term>
<listitem><para>starts a node agent</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-appserv</command></term>
<listitem><para>stops the domains in the specified domains directory</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-callflow-monitoring</command></term>
<listitem><para>disables collection of callflow information of a request</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-cluster</command></term>
<listitem><para>stops a cluster</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-database</command></term>
<listitem><para>stops the bundled Java DB database</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-domain</command></term>
<listitem><para>stops the given domain </para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-instance</command></term>
<listitem><para>stops a server instance</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-jbi-component</command></term>
<listitem><para>stops a service engine or a binding component on the specified
target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-jbi-service-assembly</command></term>
<listitem><para>stops a service assembly on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>stop-node-agent</command></term>
<listitem><para>stops a node agent</para>
</listitem>
</varlistentry>
<varlistentry><term><command>undeploy-jbi-service-assembly</command></term>
<listitem><para>undeploys a service assembly on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>undeploy</command></term>
<listitem><para>removes a component in the domain</para>
</listitem>
</varlistentry>
<varlistentry><term><command>unfreeze-transaction-service</command></term>
<listitem><para>mobilizes the named transaction service</para>
</listitem>
</varlistentry>
<varlistentry><term><command>uninstall-jbi-component</command></term>
<listitem><para>uninstalls a service engine or binding component on the specified
target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>uninstall-jbi-shared-library</command></term>
<listitem><para>uninstalls a shared library on the specified target</para>
</listitem>
</varlistentry>
<varlistentry><term><command>unpublish-from-registry</command></term>
<listitem><para>unpublishes the web service artifacts from the registries</para>
</listitem>
</varlistentry>
<varlistentry><term><command>unset</command></term>
<listitem><para>removes one or more variables from the multimode environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>unset</command></term>
<listitem><para>removes one or more variables from the multimode environment</para>
</listitem>
</varlistentry>
<varlistentry><term><command>unset-dcr-file</command></term>
<listitem><para>removes the Data Centric Rule (DCR) file from the Domain Administration
Server (DAS). </para>
<note><para>This command is available if you have installed Sun GlassFish
Communications Server.</para></note>
</listitem>
</varlistentry>
<varlistentry><term><command>update-file-user</command></term>
<listitem><para>updates a current file user as specified</para>
</listitem>
</varlistentry>
<varlistentry><term><command>update-password-alias</command></term>
<listitem><para>updates a password alias</para>
</listitem>
</varlistentry>
<varlistentry><term><command>upgrade-jbi-component</command></term>
<listitem><para>upgrades a service engine or binding component</para>
</listitem>
</varlistentry>
<varlistentry><term><command>verify-domain-xml</command></term>
<listitem><para>verifies the content of the <filename>domain.xml</filename></para>
</listitem>
</varlistentry>
<varlistentry><term><command>version</command></term>
<listitem><para>displays the version information</para>
</listitem>
</varlistentry>
</variablelist>
<para>The following commands are deprecated:</para>
<itemizedlist>
<listitem><para><command>display-license</command></para></listitem>
<listitem><para><command>install-license</command></para></listitem>
<listitem><para><command>restart-instance</command></para></listitem>
<listitem><para><command>shutdown</command></para></listitem>
<listitem><para><command>create-acl</command></para></listitem>
<listitem><para><command>delete-acl</command></para></listitem>
<listitem><para><command>list-acls</command></para></listitem>
<listitem><para><command>start-appserv</command></para></listitem>
<listitem><para><command>stop-appserv</command></para></listitem>
</itemizedlist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using help</title>
<screen>asadmin> <userinput>help</userinput>
asadmin> <userinput>create-domain --help</userinput></screen>
<para>Where: <userinput>create-domain</userinput> is the command you wish
to view the usage for.</para>
</example>
</refsect1>
<refsect1 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="asadmin-1m">asadmin(1M)</olink></para>
</refsect1>
</refentry>
<?Pub *0000044298 0>
