<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="list-components-1">
<refmeta><refentrytitle>list-components</refentrytitle><manvolnum>1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="list-components">list-components &mdash;
lists deployed components</primary></indexterm><indexterm><primary sortas="lists deployed components">
lists deployed components &mdash; list-components</primary></indexterm><refname>
list-components</refname><refpurpose>lists deployed components</refpurpose>
</refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command><command>list-components</command></command>&synopsis-common;
<arg choice="opt">&Dash;&Dash;type <replaceable>application|ejb|web|connector|webservice
</replaceable></arg><arg choice="opt">target</arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>The command <command>list-components</command> lists all deployed Java
EE 5 components. If the <option role="nodash">&Dash;&Dash;type</option> option
is not specified, all components are listed. The available type values are: <filename>
application</filename> (default), <filename>ejb</filename>, <filename>web
</filename>, <filename>connector</filename> and <filename>webservice</filename>.
This command is supported in remote mode only.</para>
</refsect1>
<refsect1><title>OPTIONS</title>
<variablelist termlength="narrow">&options-common;
<?Pub Caret>
<varlistentry><term><option role="nodash">&Dash;&Dash;type</option></term>
<listitem><para>This is the type of component to be listed. The options are
application, ejb, web, connector and webservice. If nothing is specified,
then all of the components are listed.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>OPERANDS</title>
<variablelist termlength="narrow">
<varlistentry><term><option role="nodash">target</option></term><listitem>
<para>This is the name of the target upon which the command operates. The
valid values are:<itemizedlist>
<listitem><para><literal>server</literal>, which lists the components for
the default server instance <literal>server</literal> and is the default value
</para>
</listitem>
<listitem><para><replaceable>domain_name</replaceable>, which lists the components
for the named domain</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>, which lists the components
for every server instance in the cluster</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>, which lists the
components for a particular server instance</para>
</listitem>
</itemizedlist></para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>Using <command>list-components</command> command</title>
<screen>asadmin> <userinput>list-components --user admin --passwordfile password.txt --type connector 
</userinput>
cciblackbox-tx <replaceable>connector-module</replaceable>
Command list-components executed successfully</screen>
<para>Note: <filename>cciblackbox-tx.rar</filename> was deployed.</para>
</example>
</refsect1>
<refsect1><title>EXIT STATUS</title>
<variablelist termlength="narrow">
<varlistentry><term>0</term><listitem><para>command executed successfully
</para>
</listitem></varlistentry>
<varlistentry><term>1</term><listitem><para>error in executing the command
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&also-tt;</title>
<para><link linkend="show-component-status-1"><citerefentry><refentrytitle>
show-component-status</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-sub-components-1"><citerefentry><refentrytitle>list-sub-components
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000004238>
