1498e9727b15d2cf5a185f2c941ebfd216f5840b
[openafs.git] / doc / man-pages / pod1 / vos_listpart.pod
1 =head1 NAME
2
3 vos listpart - Displays all AFS partitions on a file server machine
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos listpart> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
11     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
12
13 B<vos listp> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
14     [B<-l>] [B<-v>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<vos listpart> command displays all of the valid AFS partitions on
22 the indicated file server machine, without consulting the Volume Location
23 Database (VLDB). The B<vos partinfo> command reports the size of a
24 partition and the available space on that partition.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-server> <I<server name>>
31
32 Identifies the file server machine for which to list the partitions.
33 Provide the machine's IP address or its host name (either fully qualified
34 or using an unambiguous abbreviation). For details, see L<vos(1)>.
35
36 =item B<-cell> <I<cell name>>
37
38 Names the cell in which to run the command. Do not combine this argument
39 with the B<-localauth> flag. For more details, see L<vos(1)>.
40
41 =item B<-noauth>
42
43 Assigns the unprivileged identity anonymous to the issuer. Do not combine
44 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
45
46 =item B<-localauth>
47
48 Constructs a server ticket using a key from the local
49 B</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
50 to the Volume Server and Volume Location Server during mutual
51 authentication. Do not combine this flag with the B<-cell> argument or
52 B<-noauth> flag. For more details, see L<vos(1)>.
53
54 =item B<-verbose>
55
56 Produces on the standard output stream a detailed trace of the command's
57 execution. If this argument is omitted, only warnings and error messages
58 appear.
59
60 =item B<-help>
61
62 Prints the online help for this command. All other valid options are
63 ignored.
64
65 =back
66
67 =head1 OUTPUT
68
69 The output consists of a list of partition names of the form
70 F</vicepI<xx>>, following the header:
71
72    The partitions on the server are:
73
74 The last line of the output reports the total number of partitions.
75
76 =head1 EXAMPLES
77
78 The following command displays the partitions on C<fs1.abc.com>:
79
80    % vos listpart fs1.abc.com
81    The partitions on the server are:
82        /vicepa     /vicepb     /vicepc     /vicepd
83    Total:  4
84
85 =head1 PRIVILEGE REQUIRED
86
87 None
88
89 =head1 SEE ALSO
90
91 L<vos(1)>,
92 L<vos_partinfo(1)>
93
94 =head1 COPYRIGHT
95
96 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
97
98 This documentation is covered by the IBM Public License Version 1.0.  It was
99 converted from HTML to POD by software written by Chas Williams and Russ
100 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.