<!--Arbortext, Inc., 1988-2007, 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 CX solbook(>
<refentry id="list-components-1"><?Pub Tag atict:info tracking="off" ref="2"><?Pub Tag
atict:user user="hl34125" fullname=""><?Pub Tag atict:user user="pmdavies"
fullname=""><?Pub Tag atict:user user="ah95648" fullname="">
<!-- @(#)list-components.1 1.10 07/04/25 SMI; -->
<refmeta><refentrytitle>list-components</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">30 Jan 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary>list-components</primary></indexterm><indexterm>
<primary>lists deployed components</primary></indexterm>
<refname>list-components</refname><refpurpose>lists deployed components</refpurpose>
</refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>list-components</command> &synopsis-common; [<option
role="double-dash">type</option> <replaceable>application|ejb|web|connector|webservice
</replaceable>]
 [target]</synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The command <command>list-components</command> lists all deployed Java
EE 5 components. If the <option role="double-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 role="options"><title></title>
<variablelist termlength="narrow">&options-common;
<varlistentry><term><option role="double-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 role="operands"><title></title>
<variablelist termlength="narrow">
<varlistentry><term><option>target</option></term>
<listitem><para>This is the name of the target upon which the command operates.
The valid values are:</para>
<itemizedlist>
<listitem><para><literal>server</literal>&hyphen; Specifies the default server
instance as the target.  <literal>server</literal> is the name of the default
server instance and is the default value.</para></listitem>
<listitem><para><replaceable>domain_name</replaceable>&hyphen; Specifies a
certain domain as the target.</para></listitem>
<listitem><para><replaceable>cluster_name</replaceable>&hyphen; Specifies
a certain cluster as the target.</para></listitem>
<listitem><para><replaceable>instance_name</replaceable>&hyphen; Specifies
a certain server instance as the target<?Pub Caret>.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></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 role="exit-status"><title></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 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="show-component-status-1">show-component-status(1)
</olink>, <olink targetdoc="asrefman" targetptr="list-sub-components-1">list-sub-components(1)
</olink></para>
</refsect1>
</refentry>
<?Pub *0000004121 0>
