543906428d9ae9a0793bb60c3647d34251117797
[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
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-server> <I<server name>>
37
38 Identifies the file server machine for which to display partition
39 information. Provide the machine's IP address or its host name (either
40 fully qualified or using an unambiguous abbreviation). For details, see
41 L<vos(1)>.
42
43 =item B<-partition> <I<partition name>>
44
45 Identifies which partition on the file server machine specified by the
46 B<-server> argument for which to display information. Provide the
47 partition's complete name with preceding slash (for example, C</vicepa>)
48 or use one of the three acceptable abbreviated forms. For details, see
49 L<vos(1)>.
50
51 =item B<-cell> <I<cell name>>
52
53 Names the cell in which to run the command. Do not combine this argument
54 with the B<-localauth> flag. For more details, see L<vos(1)>.
55
56 =item B<-noauth>
57
58 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
59 combine this flag with the B<-localauth> flag. For more details, see
60 L<vos(1)>.
61
62 =item B<-localauth>
63
64 Constructs a server ticket using a key from the local
65 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
66 to the Volume Server and Volume Location Server during mutual
67 authentication. Do not combine this flag with the B<-cell> argument or
68 B<-noauth> flag. For more details, see L<vos(1)>.
69
70 =item B<-verbose>
71
72 Produces on the standard output stream a detailed trace of the command's
73 execution. If this argument is omitted, only warnings and error messages
74 appear.
75
76 =item B<-help>
77
78 Prints the online help for this command. All other valid options are
79 ignored.
80
81 =back
82
83 =head1 CAUTIONS
84
85 The partition-related statistics in this command's output do not always
86 agree with the corresponding values in the output of the standard UNIX
87 B<df> command. The statistics reported by this command can be up to five
88 minutes old, because the Cache Manager polls the File Server for partition
89 information at that frequency. Also, on some operating systems, the B<df>
90 command's report of partition size includes reserved space not included in
91 this command's calculation, and so is likely to be about 10% larger.
92
93 =head1 OUTPUT
94
95 The output reports the amount of space available and total space for each
96 specified partition.
97
98 =head1 EXAMPLES
99
100 The following command displays all partitions on the file server machine
101 C<fs2.abc.com>.
102
103    % vos partinfo fs2.abc.com
104    Free space on partition /vicepa: 27301 K blocks out of total 549197
105    Free space on partition /vicepb: 13646 K blocks out of total 69194
106    Free space on partition /vicepc: 31798 K blocks out of total 320315
107    Free space on partition /vicepd: 33302 K blocks out of total 494954
108
109 =head1 PRIVILEGE REQUIRED
110
111 None
112
113 =head1 SEE ALSO
114
115 L<vos(1)>,
116 L<vos_listpart(1)>
117
118 =head1 COPYRIGHT
119
120 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
121
122 This documentation is covered by the IBM Public License Version 1.0.  It was
123 converted from HTML to POD by software written by Chas Williams and Russ
124 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.