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