xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect1 / vos_partinfo.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="vos_partinfo1">
3   <refmeta>
4     <refentrytitle>vos partinfo</refentrytitle>
5     <manvolnum>1</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>vos partinfo</refname>
9     <refpurpose>Reports the available and total space on a partition</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">vos partinfo</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;
14         [<emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
15         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
16
17     <para><emphasis role="bold">vos p</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-p</emphasis> &lt;<emphasis>partition name</emphasis>&gt;]
18         [<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>
19
20   </refsect1>
21   <refsect1>
22     <title>Description</title>
23     <para>The vos partinfo command reports the amount of space available and total
24     size on either all of the partitions on the indicated file server machine
25     (if the <emphasis role="bold">-partition</emphasis> argument is omitted) or the specified partition on
26     that file server machine. The Volume Location Database (VLDB) is not
27     consulted.</para>
28
29   </refsect1>
30   <refsect1>
31     <title>Options</title>
32     <variablelist>
33       <varlistentry>
34         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
35         <listitem>
36           <para>Identifies the file server machine for which to display partition
37           information. Provide the machine's IP address or its host name (either
38           fully qualified or using an unambiguous abbreviation). For details, see
39           <link linkend="vos1">vos(1)</link>.</para>
40
41         </listitem>
42       </varlistentry>
43       <varlistentry>
44         <term><emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;</term>
45         <listitem>
46           <para>Identifies which partition on the file server machine specified by the
47           <emphasis role="bold">-server</emphasis> argument for which to display information. Provide the
48           partition's complete name with preceding slash (for example, <computeroutput>/vicepa</computeroutput>)
49           or use one of the three acceptable abbreviated forms. For details, see
50           <link linkend="vos1">vos(1)</link>.</para>
51
52         </listitem>
53       </varlistentry>
54       <varlistentry>
55         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
56         <listitem>
57           <para>Names the cell in which to run the command. Do not combine this argument
58           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
59
60         </listitem>
61       </varlistentry>
62       <varlistentry>
63         <term><emphasis role="bold">-noauth</emphasis></term>
64         <listitem>
65           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
66           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
67           <link linkend="vos1">vos(1)</link>.</para>
68
69         </listitem>
70       </varlistentry>
71       <varlistentry>
72         <term><emphasis role="bold">-localauth</emphasis></term>
73         <listitem>
74           <para>Constructs a server ticket using a key from the local
75           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
76           to the Volume Server and Volume Location Server during mutual
77           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
78           <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
79
80         </listitem>
81       </varlistentry>
82       <varlistentry>
83         <term><emphasis role="bold">-verbose</emphasis></term>
84         <listitem>
85           <para>Produces on the standard output stream a detailed trace of the command's
86           execution. If this argument is omitted, only warnings and error messages
87           appear.</para>
88
89         </listitem>
90       </varlistentry>
91       <varlistentry>
92         <term><emphasis role="bold">-help</emphasis></term>
93         <listitem>
94           <para>Prints the online help for this command. All other valid options are
95           ignored.</para>
96
97         </listitem>
98       </varlistentry>
99     </variablelist>
100   </refsect1>
101   <refsect1>
102     <title>Cautions</title>
103     <para>The partition-related statistics in this command's output do not always
104     agree with the corresponding values in the output of the standard UNIX
105     <emphasis role="bold">df</emphasis> command. The statistics reported by this command can be up to five
106     minutes old, because the Cache Manager polls the File Server for partition
107     information at that frequency. Also, on some operating systems, the <emphasis role="bold">df</emphasis>
108     command's report of partition size includes reserved space not included in
109     this command's calculation, and so is likely to be about 10% larger.</para>
110
111   </refsect1>
112   <refsect1>
113     <title>Output</title>
114     <para>The output reports the amount of space available and total space for each
115     specified partition.</para>
116
117   </refsect1>
118   <refsect1>
119     <title>Examples</title>
120     <para>The following command displays all partitions on the file server machine
121     <computeroutput>fs2.abc.com</computeroutput>.</para>
122
123 <programlisting>
124    % vos partinfo fs2.abc.com
125    Free space on partition /vicepa: 27301 K blocks out of total 549197
126    Free space on partition /vicepb: 13646 K blocks out of total 69194
127    Free space on partition /vicepc: 31798 K blocks out of total 320315
128    Free space on partition /vicepd: 33302 K blocks out of total 494954
129
130 </programlisting>
131     </refsect1>
132     <refsect1>
133       <title>Privilege Required</title>
134       <para>None</para>
135
136     </refsect1>
137     <refsect1>
138       <title>See Also</title>
139       <para><link linkend="vos1">vos(1)</link>,
140       <link linkend="vos_listpart1">vos_listpart(1)</link></para>
141
142     </refsect1>
143     <refsect1>
144       <title>Copyright</title>
145       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
146
147       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
148       converted from HTML to POD by software written by Chas Williams and Russ
149       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
150
151     </refsect1>
152   </refentry>