<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY meta-info SYSTEM "meta-info.sgm">
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY copyright "Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved">
<!ENTITY Date "2005Q1">
<!ENTITY ERROR-CODES "ERROR CODES">
<!ENTITY SectDesc "User Commands">
<!ENTITY Software "J2EE SDK 1.4">
<!ENTITY arch "generic">
<!ENTITY exam-tt "EXAMPLES">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY sjsas "Sun Java System Application Server">
<!ENTITY attr-tt "ATTRIBUTES">
<!ENTITY opts-tt "OPTIONS">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip
 laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen ne>
<?Pub Inc>
<refentry id="help-1">
<refmeta><refentrytitle>help</refentrytitle><manvolnum>1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="help">help &mdash; displays the asadmin
utility commands</primary></indexterm><indexterm><primary sortas="displays the asadmin utility commands">
displays the asadmin utility commands &mdash; help</primary></indexterm><refname>
help</refname><refpurpose>displays the asadmin utility commands</refpurpose>
</refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>help</command><arg choice="opt"><replaceable>command_name
</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis><command><replaceable>command_name</replaceable></command><arg
choice="opt">&Dash;&Dash;help | &Dash;?</arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</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 manpage of each command, use the syntax: <command>
asadmin</command> <replaceable>command_name</replaceable> &Dash;&Dash;help
| <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="xtrawide">
<varlistentry><term>add-resources</term><listitem><para>registers the resource
in the specified XML file</para>
</listitem></varlistentry>
<varlistentry><term>backup-domain</term><listitem><para>performs a backup
on the domain</para>
</listitem></varlistentry>
<varlistentry><term>change-admin-password</term><listitem><para>changes the
administrator password</para>
</listitem></varlistentry>
<varlistentry><term>change-master-password</term><listitem><para>changes the
master password</para>
</listitem></varlistentry>
<varlistentry><term>configure-webservice-management</term><listitem><para>
sets the monitoring or maxhistory or attributes of a deployed webservice</para>
</listitem></varlistentry>
<varlistentry><term>create-admin-object</term><listitem><para>adds the administered
object with the specified JNDI name</para>
</listitem></varlistentry>
<varlistentry><term>create-audit-module</term><listitem><para>creates an audit
module for the optional plugin module</para>
</listitem></varlistentry>
<varlistentry><term>create-auth-realm</term><listitem><para>adds the named
authorized realm</para>
</listitem></varlistentry>
<varlistentry><term>create-connector-connection-pool</term><listitem><para>
adds a a new connector connection pool with the specified connection pool
name</para>
</listitem></varlistentry>
<varlistentry><term>create-connector-resource</term><listitem><para>registers
the resource with the specified JNDI name</para>
</listitem></varlistentry>
<varlistentry><term>create-connector-security-map</term><listitem><para>creates
or modifies a security map for the named connector connection pool</para>
</listitem></varlistentry>
<varlistentry><term>create-custom-resource</term><listitem><para>registers
the custom resource</para>
</listitem></varlistentry>
<varlistentry><term>create-domain</term><listitem><para>creates a domain with
the specified name</para>
</listitem></varlistentry>
<varlistentry><term>create-file-user</term><listitem><para>creates a new file
user</para>
</listitem></varlistentry>
<varlistentry><term>create-http-listener</term><listitem><para>adds a new
HTTP listener socket</para>
</listitem></varlistentry>
<varlistentry><term>create-iiop-listener</term><listitem><para>adds the IIOP
listener</para>
</listitem></varlistentry>
<varlistentry><term>create-javamail-resource</term><listitem><para>registers
the Javamail resource</para>
</listitem></varlistentry>
<varlistentry><term>create-jdbc-connection-pool</term><listitem><para>registers
the JDBC connection pool</para>
</listitem></varlistentry>
<varlistentry><term>create-jdbc-resource</term><listitem><para>registers the
JDBC resource</para>
</listitem></varlistentry>
<varlistentry><term>create-jms-resource</term><listitem><para>registers the
JMS resource</para>
</listitem></varlistentry>
<varlistentry><term>create-jmsdest</term><listitem><para>adds the named destination
</para>
</listitem></varlistentry>
<varlistentry><term>create-jndi-resource</term><listitem><para>registers the
JNDI resource</para>
</listitem></varlistentry>
<varlistentry><term>create-jvm-options</term><listitem><para>creates the JVM
options from the Java configuration or profiler elements</para>
</listitem></varlistentry>
<varlistentry><term>create-lifecycle-module</term><listitem><para>adds a lifecycle
module</para>
</listitem></varlistentry>
<varlistentry><term>create-management-rule</term><listitem><para>creates a
new management rule</para>
</listitem></varlistentry>
<varlistentry><term>create-mbean</term><listitem><para>creates and registers
a custom MBean</para>
</listitem></varlistentry>
<varlistentry><term>create-message-security-provider</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>create-password-alias</term><listitem><para>creates a
password alias</para>
</listitem></varlistentry>
<varlistentry><term>create-persistence-resource</term><listitem><para>registers
the persistence resource</para>
</listitem></varlistentry>
<varlistentry><term>create-profiler</term><listitem><para>creates the profiler
element</para>
</listitem></varlistentry>
<varlistentry><term>create-resource-adapter-config</term><listitem><para>
creates the resource adapter Java bean</para>
</listitem></varlistentry>
<varlistentry><term>create-service</term><listitem><para>configures the starting
of a DAS or node agent on an unattended boot</para>
</listitem></varlistentry>
<varlistentry><term>create-ssl</term><listitem><para>creates the SSL element
in the HTTP listener or IIOP listener</para>
</listitem></varlistentry>
<varlistentry><term>create-threadpool</term><listitem><para>creates the thread
pool</para>
</listitem></varlistentry>
<varlistentry><term>create-transformation-rule</term><listitem><para>creates
transformation rule for a deployed web service</para>
</listitem></varlistentry>
<varlistentry><term>create-virtual-server</term><listitem><para>adds the named
virtual server</para>
</listitem></varlistentry>
<varlistentry><term>delete-admin-object</term><listitem><para>removes the
administered object with the specified JNDI name</para>
</listitem></varlistentry>
<varlistentry><term>delete-audit-module</term><listitem><para>deletes the
audit-module for the optional plugin module</para>
</listitem></varlistentry>
<varlistentry><term>delete-auth-realm</term><listitem><para>removes the named
authorized realm</para>
</listitem></varlistentry>
<varlistentry><term>delete-connector-connection-pool</term><listitem><para>
removes the specified connection pool</para>
</listitem></varlistentry>
<varlistentry><term>delete-connector-resource</term><listitem><para>removes
the named resource connector</para>
</listitem></varlistentry>
<varlistentry><term>delete-connector-security-map</term><listitem><para>deletes
the named security map</para>
</listitem></varlistentry>
<varlistentry><term>delete-custom-resource</term><listitem><para>removes the
custom resource</para>
</listitem></varlistentry>
<varlistentry><term>delete-domain</term><listitem><para>deletes the given
domain</para>
</listitem></varlistentry>
<varlistentry><term>delete-file-user</term><listitem><para>removes the named
file user</para>
</listitem></varlistentry>
<varlistentry><term>delete-http-listener</term><listitem><para>removes the
HTTP listener</para>
</listitem></varlistentry>
<varlistentry><term>delete-iiop-listener</term><listitem><para>removes the
IIOP listener</para>
</listitem></varlistentry>
<varlistentry><term>delete-javamail-resource</term><listitem><para>removes
the Javamail resource</para>
</listitem></varlistentry>
<varlistentry><term>delete-jdbc-connection-pool</term><listitem><para>removes
the JDBC connection pool</para>
</listitem></varlistentry>
<varlistentry><term>delete-jdbc-resource</term><listitem><para>removes the
JDBC resource</para>
</listitem></varlistentry>
<varlistentry><term>delete-jms-resource</term><listitem><para>removes the
JMS resource</para>
</listitem></varlistentry>
<varlistentry><term>delete-jmsdest</term><listitem><para>destroys the named
destination</para>
</listitem></varlistentry>
<varlistentry><term>delete-jndi-resource</term><listitem><para>removes the
JNDI resource</para>
</listitem></varlistentry>
<varlistentry><term>delete-jvm-options</term><listitem><para>deletes the JVM
options from the Java configuration or profiler elements</para>
</listitem></varlistentry>
<varlistentry><term>delete-lifecycle-module</term><listitem><para>removes
the lifecycle module</para>
</listitem></varlistentry>
<varlistentry><term>delete-management-rule</term><listitem><para>deletes a
specified management rule</para>
</listitem></varlistentry>
<varlistentry><term>delete-mbean</term><listitem><para>deletes a custom MBean
</para>
</listitem></varlistentry>
<varlistentry><term>delete-message-security-provider</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>delete-password-alias</term><listitem><para>deletes a
password alias</para>
</listitem></varlistentry>
<varlistentry><term>delete-persistence-resource</term><listitem><para>removes
the persistence resource</para>
</listitem></varlistentry>
<varlistentry><term>delete-profiler</term><listitem><para>deletes the profiler
element</para>
</listitem></varlistentry>
<varlistentry><term>delete-resource-adapter-config</term><listitem><para>
deletes the resource adapter Java bean</para>
</listitem></varlistentry>
<varlistentry><term>delete-ssl</term><listitem><para>deletes the ssl element
from the HTTP listener or IIOP listener</para>
</listitem></varlistentry>
<varlistentry><term>delete-threadpool</term><listitem><para>deletes the thread
pool</para>
</listitem></varlistentry>
<varlistentry><term>delete-transformation-rule</term><listitem><para>deletes
the transformation rule of a given web service</para>
</listitem></varlistentry>
<varlistentry><term>delete-virtual-server</term><listitem><para>deletes the
virtual server with the named virtual server ID</para>
</listitem></varlistentry>
<varlistentry><term>deploy</term><listitem><para>deploys the specified component
</para>
</listitem></varlistentry>
<varlistentry><term>deploydir</term><listitem><para>deploys the component
that is in the specified directory, located in the domain application server
</para>
</listitem></varlistentry>
<varlistentry><term>disable</term><listitem><para>stops the specified, deployed
component</para>
</listitem></varlistentry>
<varlistentry><term>display-error-distribution</term><listitem><para>displays
distribution of errors from instance server.log at module level</para>
</listitem></varlistentry>
<varlistentry><term>display-error-statistics</term><listitem><para>displays
a summary list of severities and warnings</para>
</listitem></varlistentry>
<varlistentry><term>display-log-records</term><listitem><para>displays all
the error messages for a given module at a given timestamp</para>
</listitem></varlistentry>
<varlistentry><term>enable</term><listitem><para>runs the specified, deployed
component</para>
</listitem></varlistentry>
<varlistentry><term>export</term><listitem><para>marks a variable name for
automatic export to the environment of subsequent commands in multimode</para>
</listitem></varlistentry>
<varlistentry><term>flush-jmsdest</term><listitem><para>purges the messages
in a JMS destination</para>
</listitem></varlistentry>
<varlistentry><term>freeze-transaction-service</term><listitem><para>immobilizes
the named transaction service</para>
</listitem></varlistentry>
<varlistentry><term>generate-diagnostic-report</term><listitem><para>generates
reports that can help diagnose application server malfunctioning</para>
</listitem></varlistentry>
<varlistentry><term>generate-jvm-report</term><listitem><para>shows the threads,
classes and memory for a given target instance</para>
</listitem></varlistentry>
<varlistentry><term>get-client-stubs</term><listitem><para>gets the stubs
of the client</para>
</listitem></varlistentry>
<varlistentry><term>get</term><listitem><para>gets the values of the monitorable
or configurable attributes</para>
</listitem></varlistentry>
<varlistentry><term>help</term><listitem><para>displays a list of all the
commands available in the Command-line interface</para>
</listitem></varlistentry>
<varlistentry><term>jms-ping</term><listitem><para>checks to see if the JMS
provider is running</para>
</listitem></varlistentry>
<varlistentry><term>list-admin-objects</term><listitem><para>lists all the
administered objects</para>
</listitem></varlistentry>
<varlistentry><term>list-audit-modules</term><listitem><para>lists the audit
modules</para>
</listitem></varlistentry>
<varlistentry><term>list-auth-realms</term><listitem><para>lists the authorized
realms</para>
</listitem></varlistentry>
<varlistentry><term>list-backups</term><listitem><para>lists all backups</para>
</listitem></varlistentry>
<varlistentry><term>list-components</term><listitem><para>lists deployed components
</para>
</listitem></varlistentry>
<varlistentry><term>list-connector-connection-pools</term><listitem><para>
gets all the connection pools</para>
</listitem></varlistentry>
<varlistentry><term>list-connector-resources</term><listitem><para>gets all
the connector resources</para>
</listitem></varlistentry>
<varlistentry><term>list-connector-security-maps</term><listitem><para>lists
the security maps for the connector connection pool</para>
</listitem></varlistentry>
<varlistentry><term>list-custom-resources</term><listitem><para>gets all the
custom resources</para>
</listitem></varlistentry>
<varlistentry><term>list-domains</term><listitem><para>lists the domains in
the given domains directory</para>
</listitem></varlistentry>
<varlistentry><term>list-file-groups</term><listitem><para>lists the file
groups</para>
</listitem></varlistentry>
<varlistentry><term>list-file-users</term><listitem><para>lists the file users
</para>
</listitem></varlistentry>
<varlistentry><term>list-http-listeners</term><listitem><para>gets the HTTP
listeners</para>
</listitem></varlistentry>
<varlistentry><term>list-iiop-listeners</term><listitem><para>gets the IIOP
listeners</para>
</listitem></varlistentry>
<varlistentry><term>list-javamail-resources</term><listitem><para>gets all
the Javamail resources</para>
</listitem></varlistentry>
<varlistentry><term>list-jdbc-connection-pools</term><listitem><para>registers
the JDBC connection pool</para>
</listitem></varlistentry>
<varlistentry><term>list-jdbc-resources</term><listitem><para>lists all the
JDBC resources</para>
</listitem></varlistentry>
<varlistentry><term>list-jms-resources</term><listitem><para>lists the JMS
resources</para>
</listitem></varlistentry>
<varlistentry><term>list-jmsdest</term><listitem><para>gets all the named
destinations</para>
</listitem></varlistentry>
<varlistentry><term>list-jndi-entries</term><listitem><para>gets all the named
destinations ,browses and queries the JNDI tree</para>
</listitem></varlistentry>
<varlistentry><term>list-jndi-resources</term><listitem><para>gets all the
JNDI resources</para>
</listitem></varlistentry>
<varlistentry><term>list-lifecycle-modules</term><listitem><para>gets the
lifecycle modules</para>
</listitem></varlistentry>
<varlistentry><term>list-management-rules</term><listitem><para>lists the
management rules created using the <command>create-management-rule</command>
command</para>
</listitem></varlistentry>
<varlistentry><term>list-mbeans</term><listitem><para>lists the custom mbeans
for a given target server instance</para>
</listitem></varlistentry>
<varlistentry><term>list-message-security-providers</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>list-password-aliases</term><listitem><para>lists all
password aliases</para>
</listitem></varlistentry>
<varlistentry><term>list-persistence-resources</term><listitem><para>gets
all the persistence resources</para>
</listitem></varlistentry>
<varlistentry><term>list-registry-locations</term><listitem><para>returns
list of configured web service registry access points</para>
</listitem></varlistentry>
<varlistentry><term>list-resource-adapter-configs</term><listitem><para>lists
the resource adapters configured in an instance</para>
</listitem></varlistentry>
<varlistentry><term>list-sub-components</term><listitem><para>lists EJBs or
Servlets in a deployed module or in a module of a deployed application</para>
</listitem></varlistentry>
<varlistentry><term>list-threadpools</term><listitem><para>lists the thread
pools</para>
</listitem></varlistentry>
<varlistentry><term>list-timers</term><listitem><para>lists all of the timers
owned by server instance(s) </para>
</listitem></varlistentry>
<varlistentry><term>list-transformation-rules</term><listitem><para>lists
all the transformation rules of a given webservice</para>
</listitem></varlistentry>
<varlistentry><term>list-virtual-servers</term><listitem><para>gets the virtual
servers</para>
</listitem></varlistentry>
<varlistentry><term>list</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<?Pub Caret></para>
</listitem></varlistentry>
<varlistentry><term>multimode</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>ping-connection-pool</term><listitem><para>tests if a
connection pool is usable</para>
</listitem></varlistentry>
<varlistentry><term>publish-to-registry</term><listitem><para>publishes all
the web service artifacts to registries</para>
</listitem></varlistentry>
<varlistentry><term>recover-transactions</term><listitem><para>manually recovers
pending transactions</para>
</listitem></varlistentry>
<varlistentry><term>restore-domain</term><listitem><para>restores files from
backup</para>
</listitem></varlistentry>
<varlistentry><term>rollback-transaction</term><listitem><para>rolls back
the named transaction</para>
</listitem></varlistentry>
<varlistentry><term>set</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>show-component-status</term><listitem><para>displays the
status of the deployed component</para>
</listitem></varlistentry>
<varlistentry><term>start-appserv</term><listitem><para>starts the domains
in the specified domains directory</para>
</listitem></varlistentry>
<varlistentry><term>start-callflow-monitoring</term><listitem><para>provides
the complete callflow/path of a request</para>
</listitem></varlistentry>
<varlistentry><term>start-database</term><listitem><para>starts the bundled
Java DB database</para>
</listitem></varlistentry>
<varlistentry><term>start-domain</term><listitem><para>starts the given domain<?Pub _newline>
</para>
</listitem></varlistentry>
<varlistentry><term>stop-appserv</term><listitem><para>stops the domains in
the specified domains directory</para>
</listitem></varlistentry>
<varlistentry><term>stop-callflow-monitoring</term><listitem><para>disables
collection of callflow information of a request</para>
</listitem></varlistentry>
<varlistentry><term>stop-database</term><listitem><para>stops the bundled
Java DB database</para>
</listitem></varlistentry>
<varlistentry><term>stop-domain</term><listitem><para>stops the given domain
</para>
</listitem></varlistentry>
<varlistentry><term>undeploy</term><listitem><para>removes a component in
the domain application server</para>
</listitem></varlistentry>
<varlistentry><term>unfreeze-transaction-service</term><listitem><para>mobilizes
the named transaction service</para>
</listitem></varlistentry>
<varlistentry><term>unpublish-from-registry</term><listitem><para>unpublishes
the web service artifacts from the registries</para>
</listitem></varlistentry>
<varlistentry><term>unset</term><listitem><para>removes one or more variables
from the multimode environment</para>
</listitem></varlistentry>
<varlistentry><term>update-connector-security-map</term><listitem><para>creates
or modifies a security map for the specified connector connection pool</para>
</listitem></varlistentry>
<varlistentry><term>update-file-user</term><listitem><para>updates a current
file user as specified</para>
</listitem></varlistentry>
<varlistentry><term>update-password-alias</term><listitem><para>updates a
password alias</para>
</listitem></varlistentry>
<varlistentry><term>verify-domain-xml</term><listitem><para>verifies the content
of the <filename>domain.xml</filename></para>
</listitem></varlistentry>
<varlistentry><term>version</term><listitem><para>displays the version information
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</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><title>&also-tt;</title>
<para><link linkend="asadmin-1"><citerefentry><refentrytitle>asadmin</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000023330>
