doc/xml/AdminReference/sect8/backup_addvolset.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_addvolset8">
   3   <refmeta>
   4     <refentrytitle>backup addvolset</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup addvolset</refname>
   9     <refpurpose>Creates a new (empty) volume set</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup addvolset</emphasis> <emphasis role="bold">-name</emphasis> &lt;<emphasis>volume set name</emphasis>&gt; [<emphasis role="bold">-temporary</emphasis>]
  14         [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">backup addvols</emphasis> <emphasis role="bold">-n</emphasis> &lt;<emphasis>volume set name</emphasis>&gt; [<emphasis role="bold">-t</emphasis>] [<emphasis role="bold">-l</emphasis>]
  17         [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">backup addvolset</emphasis> command creates a new volume set, by default
  23     adding it to the Backup Database. It is best that the volume set's name
  24     indicate the volume set's contents; for example, define the volume entries
  25     in the <computeroutput>user</computeroutput> volume set to match all user volumes. The volume set name
  26     must be unique within the Backup Database of the local cell.</para>
  27
  28     <para>After issuing this command, issue the <emphasis role="bold">backup addvolentry</emphasis> command to
  29     define the volume entries in the volume set.</para>
  30
  31     <para>Sometimes it is convenient to create volume sets without recording them
  32     permanently in the Backup Database, for example when using the <emphasis role="bold">backup
  33     volsetrestore</emphasis> command to restore a group of volumes that were not
  34     necessarily backed up together. To create a <emphasis>temporary</emphasis> volume set,
  35     include the <emphasis role="bold">-temporary</emphasis> flag. A temporary volume set exists only during
  36     the lifetime of the current interactive session, so the flag is effective
  37     only when used during an interactive session (opened by issuing the
  38     <emphasis role="bold">backup interactive</emphasis> command). If it is included when the command is
  39     issued at the regular command shell prompt, the command appears to
  40     succeed, but the volume set is not created. As noted, a temporary volume
  41     set ceases to exist when the current interactive session ends, or use the
  42     <emphasis role="bold">backup delvolset</emphasis> command to delete it before that.</para>
  43
  44     <para>One advantage of temporary volume sets is that the <emphasis role="bold">backup addvolset</emphasis>
  45     command, and any <emphasis role="bold">backup addvolentry</emphasis> commands subsequently used to add
  46     volume entries to it, complete more quickly than for regular volume sets,
  47     because no records are created in the Backup Database.</para>
  48
  49   </refsect1>
  50   <refsect1>
  51     <title>Options</title>
  52     <variablelist>
  53       <varlistentry>
  54         <term><emphasis role="bold">-name</emphasis> &lt;<emphasis>volume set name</emphasis>&gt;</term>
  55         <listitem>
  56           <para>Names the new volume set. The name can include up to 31 of any character
  57           other than the period. Avoid other metacharacters as well.</para>
  58
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term><emphasis role="bold">-temporary</emphasis></term>
  63         <listitem>
  64           <para>Creates a volume set that exists only within the context of the current
  65           interactive session. It is not added to the Backup Database.</para>
  66
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term><emphasis role="bold">-localauth</emphasis></term>
  71         <listitem>
  72           <para>Constructs a server ticket using a key from the local
  73           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
  74           it to the Backup Server, Volume Server and VL Server during mutual
  75           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
  76           more details, see <link linkend="backup8">backup(8)</link>.</para>
  77
  78         </listitem>
  79       </varlistentry>
  80       <varlistentry>
  81         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  82         <listitem>
  83           <para>Names the cell in which to run the command. Do not combine this argument
  84           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>
  85
  86         </listitem>
  87       </varlistentry>
  88       <varlistentry>
  89         <term><emphasis role="bold">-help</emphasis></term>
  90         <listitem>
  91           <para>Prints the online help for this command. All other valid options are
  92           ignored.</para>
  93
  94         </listitem>
  95       </varlistentry>
  96     </variablelist>
  97   </refsect1>
  98   <refsect1>
  99     <title>Examples</title>
 100     <para>The following command creates a volume set called <computeroutput>sys</computeroutput>:</para>
 101
 102 <programlisting>
 103    % backup addvolset sys
 104
 105 </programlisting>
 106     </refsect1>
 107     <refsect1>
 108       <title>Privilege Required</title>
 109       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
 110       machine where the Backup Server is running, or must be logged onto a
 111       server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 112       included.</para>
 113
 114     </refsect1>
 115     <refsect1>
 116       <title>See Also</title>
 117       <para><link linkend="backup8">backup(8)</link>,
 118       <link linkend="backup_addvolentry8">backup_addvolentry(8)</link>,
 119       <link linkend="backup_delvolentry8">backup_delvolentry(8)</link>,
 120       <link linkend="backup_delvolset8">backup_delvolset(8)</link>,
 121       <link linkend="backup_listvolsets8">backup_listvolsets(8)</link>,
 122       <link linkend="backup_volsetrestore8">backup_volsetrestore(8)</link></para>
 123
 124     </refsect1>
 125     <refsect1>
 126       <title>Copyright</title>
 127       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 128
 129       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 130       converted from HTML to POD by software written by Chas Williams and Russ
 131       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 132
 133     </refsect1>
 134   </refentry>