<!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-backups-1">
<refmeta><refentrytitle>list-backups</refentrytitle><manvolnum>1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="list-backups">list-backups &mdash;
lists all backups</primary></indexterm><indexterm><primary sortas="lists all backups ">
lists all backups&mdash; list-backups</primary></indexterm><refname>list-backups
</refname><refpurpose>lists all backups</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>list-backups</command><arg choice="opt">&Dash;&Dash;domaindir <replaceable>
domain_directory</replaceable></arg><arg choice="opt">&Dash;&Dash;description <replaceable>
description</replaceable></arg><arg>&Dash;&Dash;terse=<replaceable>false</replaceable></arg>
<arg>&Dash;&Dash;verbose=<replaceable>false</replaceable></arg><arg choice="plain"><replaceable>
domain_name</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>This command displays the status information about all backups in the
backup respository. The <command>list&mdash;backups</command> command is supported
in local mode only.</para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><option role="nodash">&Dash;&Dash;domaindir</option></term>
<listitem><para>This option specifies the parent directory of the domain upon
which the command will operate. The default is <command>install_dir/domains
</command>.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;description</option></term>
<listitem><para>A description can contain any string to help identify the
particular backup. The description is displayed as part of the information
for any backup.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;t</option> <option role="nodash">&Dash;&Dash;terse
</option></term><listitem><para>Indicates that any output data must be very
concise, typically avoiding human-friendly sentences and favoring well-formatted
data for consumption by a script. Default is false.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;v</option> <option role="nodash">&Dash;&Dash;verbose
</option></term><listitem><para>Indicates that output data is displayed with
detailed information. Default is false.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>domain_name</replaceable></term><listitem>
<para>This is the name of the domain to list the backups from.  If the domain
is not specified and only one domain exists, it will be used automatically.
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>Using list-backups</title>
<screen>asadmin><userinput>list-backups --domaindir /usr/appserver90pe/domains/domain1 domain1
</userinput>
Description: 1137030607263
Backup Filename: /opt/SUNWappserver/nondefaultdomaindir/domain1<?Pub Caret>/backups/sjsas_backup_v00001.zip
Date and time backup was performed: Wed Jan 11 17:50:07 PST 2006
Domains Directory: /opt/SUNWappserver/nondefaultdomaindir
Domain Directory: /opt/SUNWappserver/nondefaultdomaindir/domain1
Domain Name: domain1
Name of the user that performed the backup: jondoe
The command list-backups executed successfully.

</screen>
</example>
</refsect1>
<refsect1><title>&exit-tt;</title>
<variablelist termlength="medium">
<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="backup-domain-1"><citerefentry><refentrytitle>backup-domain
</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend="restore-domain-1"><citerefentry>
<refentrytitle>restore-domain</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000004598>
