openafs/doc/xml/AdminReference/sect1/vos_listpart.xml
Chas Williams 52557c982e xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first
2006-09-16 01:13:22 +00:00

131 lines
5.5 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="vos_listpart1">
<refmeta>
<refentrytitle>vos listpart</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>vos listpart</refname>
<refpurpose>Displays all AFS partitions on a file server machine</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para><emphasis role="bold">vos listpart</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
[<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
<para><emphasis role="bold">vos listp</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>]
[<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <emphasis role="bold">vos listpart</emphasis> command displays all of the valid AFS partitions on
the indicated file server machine, without consulting the Volume Location
Database (VLDB). The <emphasis role="bold">vos partinfo</emphasis> command reports the size of a
partition and the available space on that partition.</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">-server</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
<listitem>
<para>Identifies the file server machine for which to list the partitions.
Provide the machine's IP address or its host name (either fully qualified
or using an unambiguous abbreviation). For details, see <link linkend="vos1">vos(1)</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="vos1">vos(1)</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">-noauth</emphasis></term>
<listitem>
<para>Assigns the unprivileged identity anonymous to the issuer. Do not combine
this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">-localauth</emphasis></term>
<listitem>
<para>Constructs a server ticket using a key from the local
<emphasis role="bold">/usr/afs/etc/KeyFile</emphasis> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
to the Volume Server and Volume Location Server during mutual
authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
<emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">-verbose</emphasis></term>
<listitem>
<para>Produces on the standard output stream a detailed trace of the command's
execution. If this argument is omitted, only warnings and error messages
appear.</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 output consists of a list of partition names of the form
<replaceable>/vicep</replaceable><emphasis>xx</emphasis><replaceable></replaceable>, following the header:</para>
<programlisting>
The partitions on the server are:
</programlisting>
<para>The last line of the output reports the total number of partitions.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>The following command displays the partitions on <computeroutput>fs1.abc.com</computeroutput>:</para>
<programlisting>
% vos listpart fs1.abc.com
The partitions on the server are:
/vicepa /vicepb /vicepc /vicepd
Total: 4
</programlisting>
</refsect1>
<refsect1>
<title>Privilege Required</title>
<para>None</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para><link linkend="vos1">vos(1)</link>,
<link linkend="vos_partinfo1">vos_partinfo(1)</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>