77c69da3ab019ab77b1f65315e5b5d85c9689ec8
[openafs.git] / doc / man-pages / pod1 / vos_partinfo.pod.in
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>>] >>> [B<-summary>]
12     S<<< [B<-cell> <I<cell name>>] >>>
13     [B<-noauth>] [B<-localauth>]
14     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
15     S<<< [B<-config> <I<config directory>>] >>>
16     [B<-help>]
17
18 B<vos p> S<<< B<-se> <I<machine name>> >>>
19     S<<< [B<-p> <I<partition name>>] >>> [B<-su>]
20     S<<< [B<-c> <I<cell name>>] >>>
21     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
22     S<<< [B<-co> <I<config directory>>] >>>
23     [B<-h>]
24
25 =for html
26 </div>
27
28 =head1 DESCRIPTION
29
30 The vos partinfo command reports the amount of space available and total
31 size on either all of the partitions on the indicated file server machine
32 (if the B<-partition> argument is omitted) or the specified partition on
33 that file server machine. The Volume Location Database (VLDB) is not
34 consulted.
35
36 =head1 CAUTIONS
37
38 =include fragments/volsize-caution.pod
39
40 =head1 OPTIONS
41
42 =over 4
43
44 =item B<-server> <I<server name>>
45
46 Identifies the file server machine for which to display partition
47 information. Provide the machine's IP address or its host name (either
48 fully qualified or using an unambiguous abbreviation). For details, see
49 L<vos(1)>.
50
51 =item B<-partition> <I<partition name>>
52
53 Identifies which partition on the file server machine specified by the
54 B<-server> argument for which to display information. Provide the
55 partition's complete name with preceding slash (for example, C</vicepa>)
56 or use one of the three acceptable abbreviated forms. For details, see
57 L<vos(1)>.
58
59 =item B<-summary>
60
61 Prints storage summary.
62
63 =item B<-cell> <I<cell name>>
64
65 Names the cell in which to run the command. Do not combine this argument
66 with the B<-localauth> flag. For more details, see L<vos(1)>.
67
68 =item B<-noauth>
69
70 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
71 combine this flag with the B<-localauth> flag. For more details, see
72 L<vos(1)>.
73
74 =item B<-localauth>
75
76 Constructs a server ticket using a key from the local
77 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
78 to the Volume Server and Volume Location Server during mutual
79 authentication. Do not combine this flag with the B<-cell> argument or
80 B<-noauth> flag. For more details, see L<vos(1)>.
81
82 =item B<-verbose>
83
84 Produces on the standard output stream a detailed trace of the command's
85 execution. If this argument is omitted, only warnings and error messages
86 appear.
87
88 =item B<-encrypt>
89
90 Encrypts the command so that the operation's results are not transmitted
91 across the network in clear text. This option is available in OpenAFS
92 versions 1.4.11 or later and 1.5.60 or later.
93
94 =item B<-noresolve>
95
96 Shows all servers as IP addresses instead of the DNS name. This is very
97 useful when the server address is registered as 127.0.0.1 or when dealing
98 with multi-homed servers. This option is available in OpenAFS
99 versions 1.4.8 or later and 1.5.35 or later.
100
101 =item B<-help>
102
103 Prints the online help for this command. All other valid options are
104 ignored.
105
106 =back
107
108 =head1 CAUTIONS
109
110 The partition-related statistics in this command's output do not always
111 agree with the corresponding values in the output of the standard UNIX
112 B<df> command. The statistics reported by this command can be up to five
113 minutes old, because the Cache Manager polls the File Server for partition
114 information at that frequency. Also, on some operating systems, the B<df>
115 command's report of partition size includes reserved space not included in
116 this command's calculation, and so is likely to be about 10% larger.
117
118 =head1 OUTPUT
119
120 The output reports the amount of space available and total space for each
121 specified partition.
122
123 =head1 EXAMPLES
124
125 The following command displays all partitions on the file server machine
126 C<fs2.example.com>.
127
128    % vos partinfo fs2.example.com
129    Free space on partition /vicepa: 27301 K blocks out of total 549197
130    Free space on partition /vicepb: 13646 K blocks out of total 69194
131    Free space on partition /vicepc: 31798 K blocks out of total 320315
132    Free space on partition /vicepd: 33302 K blocks out of total 494954
133
134 =head1 PRIVILEGE REQUIRED
135
136 None
137
138 =head1 SEE ALSO
139
140 L<vos(1)>,
141 L<vos_listpart(1)>
142
143 =head1 COPYRIGHT
144
145 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
146
147 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.