openafs/doc/xml/AdminReference/sect8/backup_addvolset.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="backup_addvolset8">
  <refmeta>
    <refentrytitle>backup addvolset</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>backup addvolset</refname>
    <refpurpose>Creates a new (empty) volume set</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">backup addvolset</emphasis> <emphasis role="bold">-name</emphasis> &lt;<emphasis>volume set name</emphasis>&gt; [<emphasis role="bold">-temporary</emphasis>]
        [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>

    <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>]
        [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>

  </refsect1>
  <refsect1>
    <title>Description</title>
    <para>The <emphasis role="bold">backup addvolset</emphasis> command creates a new volume set, by default
    adding it to the Backup Database. It is best that the volume set's name
    indicate the volume set's contents; for example, define the volume entries
    in the <computeroutput>user</computeroutput> volume set to match all user volumes. The volume set name
    must be unique within the Backup Database of the local cell.</para>

    <para>After issuing this command, issue the <emphasis role="bold">backup addvolentry</emphasis> command to
    define the volume entries in the volume set.</para>

    <para>Sometimes it is convenient to create volume sets without recording them
    permanently in the Backup Database, for example when using the <emphasis role="bold">backup
    volsetrestore</emphasis> command to restore a group of volumes that were not
    necessarily backed up together. To create a <emphasis>temporary</emphasis> volume set,
    include the <emphasis role="bold">-temporary</emphasis> flag. A temporary volume set exists only during
    the lifetime of the current interactive session, so the flag is effective
    only when used during an interactive session (opened by issuing the
    <emphasis role="bold">backup interactive</emphasis> command). If it is included when the command is
    issued at the regular command shell prompt, the command appears to
    succeed, but the volume set is not created. As noted, a temporary volume
    set ceases to exist when the current interactive session ends, or use the
    <emphasis role="bold">backup delvolset</emphasis> command to delete it before that.</para>

    <para>One advantage of temporary volume sets is that the <emphasis role="bold">backup addvolset</emphasis>
    command, and any <emphasis role="bold">backup addvolentry</emphasis> commands subsequently used to add
    volume entries to it, complete more quickly than for regular volume sets,
    because no records are created in the Backup Database.</para>

  </refsect1>
  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">-name</emphasis> &lt;<emphasis>volume set name</emphasis>&gt;</term>
        <listitem>
          <para>Names the new volume set. The name can include up to 31 of any character
          other than the period. Avoid other metacharacters as well.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-temporary</emphasis></term>
        <listitem>
          <para>Creates a volume set that exists only within the context of the current
          interactive session. It is not added to the Backup Database.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-localauth</emphasis></term>
        <listitem>
          <para>Constructs a server ticket using a key from the local
          <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
          it to the Backup Server, Volume Server and VL Server during mutual
          authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
          more details, see <link linkend="backup8">backup(8)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
        <listitem>
          <para>Names the cell in which to run the command. Do not combine this argument
          with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-help</emphasis></term>
        <listitem>
          <para>Prints the online help for this command. All other valid options are
          ignored.</para>

        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>The following command creates a volume set called <computeroutput>sys</computeroutput>:</para>

<programlisting>
   % backup addvolset sys

</programlisting>
    </refsect1>
    <refsect1>
      <title>Privilege Required</title>
      <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on every
      machine where the Backup Server is running, or must be logged onto a
      server machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
      included.</para>

    </refsect1>
    <refsect1>
      <title>See Also</title>
      <para><link linkend="backup8">backup(8)</link>,
      <link linkend="backup_addvolentry8">backup_addvolentry(8)</link>,
      <link linkend="backup_delvolentry8">backup_delvolentry(8)</link>,
      <link linkend="backup_delvolset8">backup_delvolset(8)</link>,
      <link linkend="backup_listvolsets8">backup_listvolsets(8)</link>,
      <link linkend="backup_volsetrestore8">backup_volsetrestore(8)</link></para>

    </refsect1>
    <refsect1>
      <title>Copyright</title>
      <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>

      <para>This documentation is covered by the IBM Public License Version 1.0.  It was
      converted from HTML to POD by software written by Chas Williams and Russ
      Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>

    </refsect1>
  </refentry>