man-pages: add fs_getverify and fs_setverify
[openafs.git] / doc / man-pages / pod1 / vos_online.pod
1 =head1 NAME
2
3 vos_online - Brings a volume online
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos online> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-partition> <I<partition name>> >>> 
12     S<<< B<-id> <I<volume name or ID>> >>>
13     S<<< [B<-cell> <I<cell name>>] >>>
14     [B<-noauth>] B<-localauth>]
15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
16
17 B<vos on> S<<< B<-s> <I<machine name>> >>>
18     S<<< B<-p> <I<partition name>> >>> 
19     S<<< B<-i> <I<volume name or ID>> >>>
20     S<<< [B<-c> <I<cell name>>] >>>
21     [B<-noa>] B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
22
23 =for html
24 </div>
25
26 =head1 DESCRIPTION
27
28 The B<vos online> command brings an offline volume on line with the 
29 B<fileserver>.
30
31 =head1 CAUTIONS
32
33 None.
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-server> <I<machine name>>
40
41 Identifies the file server machine where the volume resides. 
42 Provide the machine's IP address or its host name (either fully
43 qualified or using an unambiguous abbreviation). For details, see
44 L<vos(1)>.
45
46 =item B<-partition> <I<partition name>>
47
48 Identifies the partition where the volume resides, on the
49 file server machine named by the B<-server> argument. Provide the
50 partition's complete name with preceding slash (for example, C</vicepa>)
51 or use one of the three acceptable abbreviated forms. For details, see
52 L<vos(1)>.
53
54 =item B<-id> <I<volume name or ID>>
55
56 Specifies either the complete name or volume ID number of the volume.
57
58 =item B<-cell> <I<cell name>>
59
60 Names the cell in which to run the command. Do not combine this argument
61 with the B<-localauth> flag. For more details, see L<vos(1)>.
62
63 =item B<-noauth>
64
65 Assigns the unprivileged identity anonymous to the issuer. Do not combine
66 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
67
68 =item B<-localauth>
69
70 Constructs a server ticket using a key from the local
71 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
72 to the Volume Server and Volume Location Server during mutual
73 authentication. Do not combine this flag with the B<-cell> argument or
74 B<-noauth> flag. For more details, see L<vos(1)>.
75
76 =item B<-verbose>
77
78 Produces on the standard output stream a detailed trace of the command's
79 execution. If this argument is omitted, only warnings and error messages
80 appear.
81
82 =item B<-encrypt>
83
84 Encrypts the command so that the operation's results are not transmitted
85 across the network in clear text. This option is available in OpenAFS
86 versions 1.4.11 or later and 1.5.60 or later.
87
88 =item B<-noresolve>
89
90 Shows all servers as IP addresses instead of the DNS name. This is very
91 useful when the server address is registered as 127.0.0.1 or when dealing
92 with multi-homed servers. This option is available in OpenAFS
93 versions 1.4.8 or later and 1.5.35 or later.
94
95 =item B<-help>
96
97 Prints the online help for this command. All other valid options are
98 ignored.
99
100 =back
101
102 =head1 EXAMPLES
103
104 The following example brings an offline volume online:
105
106    % vos online -server sv7.stateu.edu -partition /vicepb -id root.afs
107
108 =head1 PRIVILEGE REQUIRED
109
110 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
111 machine specified with the B<-server> argument and on each database server
112 machine. If the B<-localauth> flag is included, the issuer must instead be
113 logged on to a server machine as the local superuser C<root>.
114
115 =head1 SEE ALSO
116
117 L<vos(1)>,
118 L<vos_offline(1)>,
119 L<bos_salvage(8)>,
120
121 =head1 COPYRIGHT
122
123 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
124
125 This man page was created by Steven Jenkins.