<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!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="list-instances-1">
<refmeta><refentrytitle>list-instances</refentrytitle><manvolnum>1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="list-instances">list-instances &mdash;
lists all the instances along with their status</primary></indexterm><indexterm>
<primary sortas="lists all the instances along with their status">lists all
the instances along with their status &mdash; list-instances</primary></indexterm>
<refname>list-instances</refname><refpurpose>lists all the server instances
while indicating if they are running or not.</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>list-instances</command>&synopsis-common;
<arg choice="opt"><replaceable>target</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>Use the <command>list-instances</command> to list all the instances
in a server. The <command>list-instances</command> command can be run both
locally and remotely. To list remote instances, the named administration server
must be running on the hostname and port number specified. The user authenticates
using the password identified for the administration server.</para>
</refsect1>
<refsect1><title>OPTIONS</title>
<variablelist termlength="medium">&options-common;
</variablelist></refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>target</replaceable></term><listitem><para>
This is the name of the target domain associated with the instances you want
listed. Valid values are:</para>
<itemizedlist>
<listitem><para><literal>domain</literal>, which lists all server instances
in the domain. This is the default value.</para>
</listitem>
<listitem><para><replaceable>cluster_name</replaceable>, which lists all server
instances in the specified cluster</para>
</listitem>
<listitem><para><replaceable>instance_name</replaceable>, which lists the
specified server instance</para>
</listitem>
<listitem><para><replaceable>node_agent_name</replaceable>, which lists all
server instances in the named node-agent. </para>
</listitem>
</itemizedlist>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>Using list-instances in local mode</title>
<screen>asadmin> <userinput>list-instances --user admin --passwordfile passwords.txt instance1
</userinput>
Command list-instances executed successfully</screen>
<para>Where: <filename>instance1</filename> is listed.</para>
</example>
<example>
<title>Using list-instances in remote mode</title>
<screen>asadmin> <userinput>list-instances --user admin --passwordfile passwords.txt 
--host pigeon --port 4849</userinput>
remote_instance1 running
Command list-instances executed successfully</screen>
<para>Where: <filename>remote-instance1</filename> associates with user, passwordfile,
host, and port of the remote machine.</para>
</example>
</refsect1>
<refsect1><title>EXIT STATUS</title>
<variablelist termlength="medium"><?Pub Caret>
<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="create-instance-1"><citerefentry><refentrytitle>create-instance
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000004135>
