<!--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;
]>
<!--Arbortext, Inc., 1988-2007, v.4002-->
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="backup-domain-1">
<!-- @(#)backup-domain.1 1.15 07/07/30 SMI; -->
<refmeta><refentrytitle>backup-domain</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>backup-domain</primary></indexterm><indexterm><primary>performs a backup on the domain</primary></indexterm>
<refname>backup-domain</refname><refpurpose>performs a backup on the domain</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>backup-domain</command>  [<option role="double-dash">domaindir</option> <replaceable>domain_directory</replaceable>]
 [<option role="double-dash">description</option> <replaceable>description</replaceable>] [<option role="double-dash">echo</option>={<literal>true | false</literal>}][<option role="double-dash">terse</option>={<literal>true | false</literal>}]
 [<option role="double-dash">verbose</option>=<replaceable>false</replaceable>] [<replaceable>domain_name</replaceable>]</synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <command>backup-domain</command> command backs up files under the named domain. This command is supported in local mode only.</para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">
<varlistentry><term><option role="double-dash">domaindir</option></term>
<listitem><para>This option specifies the parent directory of the domain upon which the command will operate. The default is <filename>install_dir/domains</filename>.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-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>e</option> <option role="double-dash">echo</option></term>
<listitem><para>Setting to true will echo the command line statement on the standard output. Default is false.</para>
</listitem>
</varlistentry>
<varlistentry><term><option>t</option> <option role="double-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>v</option> <option role="double-dash">verbose</option></term>
<listitem><para>Indicates that output data is displayed with detailed information. Default is false.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term><replaceable>domain_name</replaceable></term>
<listitem><para>This is the name of the domain to be backed up. If the domain is not specified and only one domain exists, it will be used automatically. If you have more than one domain, it is mandatory to specify a domain name.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using backup-domain</title>
<screen>asadmin> <userinput>backup-domain --domaindir /opt/SUNWappserver/mydomaindir domain1</userinput>
Successfully backed up the domain

Description: 1137030607263
Backup Filename: /opt/SUNWappserver/mydomaindir/domain1/backups/sjsas_backup_v00001.zip
Date and time backup was performed: Wed Jan 11 17:50:07 PST 2006
Domains Directory: /opt/SUNWappserver/mydomaindir
Domain Directory: /opt/SUNWappserver/mydomaindir/domain1
Domain Name: domain1
Name of the user that performed the backup: jondoe</screen>
</example>
</refsect1>
<refsect1 role="exit-status"><title></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 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="restore-domain-1">restore-domain(1)</olink>, <olink targetdoc="asrefman" targetptr="list-backups-1">list-backups(1)</olink></para>
</refsect1>
</refentry>
<?Pub *0000005039 0>
