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