openafs/doc/xml/AdminReference/sect8/backup_listvolsets.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="backup_listvolsets8">
  <refmeta>
    <refentrytitle>backup listvolsets</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>backup listvolsets</refname>
    <refpurpose>Lists volume set entries from the Backup Database</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">backup listvolsets</emphasis> [<emphasis role="bold">-name</emphasis> &lt;<emphasis>volume set name</emphasis>&gt;] [<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 listv</emphasis> [<emphasis role="bold">-n</emphasis> &lt;<emphasis>volume set name</emphasis>&gt;] [<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 listvolsets</emphasis> command displays the Backup Database records for
    either</para>

    <itemizedlist>
      <listitem>
        <para>All volume sets and their volume entries, if the <emphasis role="bold">-name</emphasis> argument is
        omitted.</para>

      </listitem>
      <listitem>
        <para>The volume set specified by the <emphasis role="bold">-name</emphasis> argument, along with its volume
        entries.</para>

      </listitem>
    </itemizedlist>
  </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 volume set to display. If this argument is omitted, the output
          lists all volume sets defined in 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>Output</title>
    <para>The entry for each volume set begins with the <computeroutput>Volume set</computeroutput> header and the
    volume set's name. A temporary volume set's name is followed by the string
    <computeroutput> (temporary)</computeroutput>. Each volume entry follows on a separate line, indicating
    the entry's index number and the server, partition, and volume names it
    matches. The output uses the metacharacter notation described on the
    <emphasis role="bold">backup addvolentry</emphasis> reference page. Use the index number to identify
    volume entries when deleting them with the <emphasis role="bold">backup delvolentry</emphasis> command.</para>

  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>The following example shows the volume entries in the three volume sets
    currently defined in the Backup Database:</para>

<programlisting>
   % backup listvolsets
   Volume set user:
       Entry   1: server .*, partition .*, volumes: user.*\.backup
   Volume set sun
       Entry   1: server .*, partition .*, volumes: sun4x_55\..*
       Entry   2: server .*, partition .*, volumes: sun4x_56\..*
   Volume set rs
       Entry   1: server .*, partition .*, volumes: rs_aix42\..*

</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_addvolset8">backup_addvolset(8)</link>,
      <link linkend="backup_delvolentry8">backup_delvolentry(8)</link>,
      <link linkend="backup_delvolset8">backup_delvolset(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>