d3b436c456a4a01790e0be360e0b5c61bf8ee7ef
[openafs.git] / doc / man-pages / pod1 / vos_partinfo.pod
1 =head1 NAME
2
3 vos_partinfo - Reports the available and total space on a partition
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos partinfo> S<<< B<-server> <I<machine name>> >>>
11     S<<< [B<-partition> <I<partition name>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
13
14 B<vos p> S<<< B<-s> <I<machine name>> >>> S<<< [B<-p> <I<partition name>>] >>>
15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The vos partinfo command reports the amount of space available and total
23 size on either all of the partitions on the indicated file server machine
24 (if the B<-partition> argument is omitted) or the specified partition on
25 that file server machine. The Volume Location Database (VLDB) is not
26 consulted.
27
28 =head1 CAUTIONS
29
30 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes)
31 and the maximum size of a /vicepX partition on a fileserver is also 2
32 terabytes. The fileserver will not report an error when it has access
33 to a partition larger than 2 terabytes, but it will probably fail if
34 the administrator attempts to use more than 2 terabytes of space. In
35 addition, there are reports of erroneous disk usage numbers when
36 B<vos partinfo> or other OpenAFS disk reporting tools are used with
37 partitions larger than 2 terabytes.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<-server> <I<server name>>
44
45 Identifies the file server machine for which to display partition
46 information. Provide the machine's IP address or its host name (either
47 fully qualified or using an unambiguous abbreviation). For details, see
48 L<vos(1)>.
49
50 =item B<-partition> <I<partition name>>
51
52 Identifies which partition on the file server machine specified by the
53 B<-server> argument for which to display information. Provide the
54 partition's complete name with preceding slash (for example, C</vicepa>)
55 or use one of the three acceptable abbreviated forms. For details, see
56 L<vos(1)>.
57
58 =item B<-cell> <I<cell name>>
59
60 Names the cell in which to run the command. Do not combine this argument
61 with the B<-localauth> flag. For more details, see L<vos(1)>.
62
63 =item B<-noauth>
64
65 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
66 combine this flag with the B<-localauth> flag. For more details, see
67 L<vos(1)>.
68
69 =item B<-localauth>
70
71 Constructs a server ticket using a key from the local
72 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
73 to the Volume Server and Volume Location Server during mutual
74 authentication. Do not combine this flag with the B<-cell> argument or
75 B<-noauth> flag. For more details, see L<vos(1)>.
76
77 =item B<-verbose>
78
79 Produces on the standard output stream a detailed trace of the command's
80 execution. If this argument is omitted, only warnings and error messages
81 appear.
82
83 =item B<-help>
84
85 Prints the online help for this command. All other valid options are
86 ignored.
87
88 =back
89
90 =head1 CAUTIONS
91
92 The partition-related statistics in this command's output do not always
93 agree with the corresponding values in the output of the standard UNIX
94 B<df> command. The statistics reported by this command can be up to five
95 minutes old, because the Cache Manager polls the File Server for partition
96 information at that frequency. Also, on some operating systems, the B<df>
97 command's report of partition size includes reserved space not included in
98 this command's calculation, and so is likely to be about 10% larger.
99
100 =head1 OUTPUT
101
102 The output reports the amount of space available and total space for each
103 specified partition.
104
105 =head1 EXAMPLES
106
107 The following command displays all partitions on the file server machine
108 C<fs2.abc.com>.
109
110    % vos partinfo fs2.abc.com
111    Free space on partition /vicepa: 27301 K blocks out of total 549197
112    Free space on partition /vicepb: 13646 K blocks out of total 69194
113    Free space on partition /vicepc: 31798 K blocks out of total 320315
114    Free space on partition /vicepd: 33302 K blocks out of total 494954
115
116 =head1 PRIVILEGE REQUIRED
117
118 None
119
120 =head1 SEE ALSO
121
122 L<vos(1)>,
123 L<vos_listpart(1)>
124
125 =head1 COPYRIGHT
126
127 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
128
129 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.