man-page-more-fs-commands-20090517
[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>> >>> S<<< B<-partition> <I<partition name>> >>> 
11     S<<< B<-id> <I<volume name or ID>> >>> S<<< [B<-bless>] >>> S<<< [B<-cell> <I<cell name>>] >>> 
12     S<<< [B<-noauth>] | B<-localauth>] >>> S<<< [B<-verbose>] >>> S<<< [B<-encrypt>] >>> S<<< [B<-help>] >>>
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<vos online> command brings an offline volume on line with the 
20 B<fileserver>.
21
22 =head1 CAUTIONS
23
24 None.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-server> <I<machine name>>
31
32 Identifies the file server machine where the volume resides. 
33 Provide the machine's IP address or its host name (either fully
34 qualified or using an unambiguous abbreviation). For details, see
35 L<vos(1)>.
36
37 =item B<-partition> <I<partition name>>
38
39 Identifies the partition where the volume resides, on the
40 file server machine named by the B<-server> argument. Provide the
41 partition's complete name with preceding slash (for example, C</vicepa>)
42 or use one of the three acceptable abbreviated forms. For details, see
43 L<vos(1)>.
44
45 =item B<-id> <I<volume name or ID>>
46
47 Specifies either the complete name or volume ID number of the volume.
48
49 =item B<-bless>
50
51 If the volume resides on a fileserver running as a I<dafs> (Demand
52 Attach File Server), then the volume may be marked as I<blessed> or
53 I<unblessed>.  A I<dafs> server will not bring I<unblessed> volumes
54 online unless the B<-bless> option to L<vos_online> is specified.
55 See L<vos_offline(1)> for setting a volume to be I<unblessed>.
56
57 =item B<-cell> <I<cell name>>
58
59 Names the cell in which to run the command. Do not combine this argument
60 with the B<-localauth> flag. For more details, see L<vos(1)>.
61
62 =item B<-noauth>
63
64 Assigns the unprivileged identity anonymous to the issuer. Do not combine
65 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
66
67 =item B<-localauth>
68
69 Constructs a server ticket using a key from the local
70 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
71 to the Volume Server and Volume Location Server during mutual
72 authentication. Do not combine this flag with the B<-cell> argument or
73 B<-noauth> flag. For more details, see L<vos(1)>.
74
75 =item B<-verbose>
76
77 Produces on the standard output stream a detailed trace of the command's
78 execution. If this argument is omitted, only warnings and error messages
79 appear.
80
81 =item B<-encrypt>
82
83 Encrypts the command so that the operation's results are
84 not transmitted across the network in clear text.
85
86 =item B<-help>
87
88 Prints the online help for this command. All other valid options are
89 ignored.
90
91 =back
92
93 =head1 EXAMPLES
94
95 The following example brings an offline volume online:
96
97    % vos online -server sv7.stateu.edu -partition /vicepb -id root.afs
98
99 The following example brings an offline, unblessed volume online:
100
101    % vos online -server sv7.stateu.edu -partition /vicepb -id root.afs -bless
102
103 =head1 PRIVILEGE REQUIRED
104
105 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
106 machine specified with the B<-server> argument and on each database server
107 machine. If the B<-localauth> flag is included, the issuer must instead be
108 logged on to a server machine as the local superuser C<root>.
109
110 =head1 SEE ALSO
111
112 L<vos(1)>,
113 L<vos_offline(1)>,
114 L<bos_salvage(8)>,
115
116 =head1 COPYRIGHT
117
118 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
119
120 This man page was created by Steven Jenkins.