Commit | Line | Data |
---|---|---|
805e021f CE |
1 | =head1 NAME |
2 | ||
3 | vos_offline - Takes a volume offline | |
4 | ||
5 | =head1 SYNOPSIS | |
6 | ||
7 | =for html | |
8 | <div class="synopsis"> | |
9 | ||
10 | B<vos offline> 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<-sleep> <I<seconds to sleep>>] >>> | |
14 | [B<-busy>] S<<< [B<-cell> <I<cell name>>] >>> | |
15 | [B<-noauth>] B<-localauth>] | |
16 | [B<-verbose>] [B<-encrypt>] [B<-noresolve>] | |
17 | S<<< [B<-config> <I<config directory>>] >>> | |
18 | [B<-help>] | |
19 | ||
20 | B<vos of> S<<< B<-se> <I<machine name>> >>> | |
21 | S<<< B<-p> <I<partition name>> >>> | |
22 | S<<< B<-i> <I<volume name or ID>> >>> | |
23 | S<<< [B<-sl> <I<seconds to sleep>>] >>> | |
24 | [B<-b>] S<<< [B<-c> <I<cell name>>] >>> | |
25 | [B<-noa>] B<-l>] | |
26 | [B<-v>] [B<-e>] [B<-nor>] | |
27 | S<<< [B<-co> <I<config directory>>] >>> | |
28 | [B<-h>] | |
29 | ||
30 | =for html | |
31 | </div> | |
32 | ||
33 | =head1 DESCRIPTION | |
34 | ||
35 | The B<vos offline> command takes a volume offline on the | |
36 | B<fileserver>. | |
37 | ||
38 | =head1 CAUTIONS | |
39 | ||
40 | Taking a volume offline that has existing | |
41 | callbacks will result in those callbacks being broken | |
42 | and clients not being able to access the volume. | |
43 | ||
44 | =head1 OPTIONS | |
45 | ||
46 | =over 4 | |
47 | ||
48 | =item B<-server> <I<machine name>> | |
49 | ||
50 | Identifies the file server machine where the volume resides. | |
51 | Provide the machine's IP address or its host name (either fully | |
52 | qualified or using an unambiguous abbreviation). For details, see | |
53 | L<vos(1)>. | |
54 | ||
55 | =item B<-partition> <I<partition name>> | |
56 | ||
57 | Identifies the partition where the volume resides, on the | |
58 | file server machine named by the B<-server> argument. Provide the | |
59 | partition's complete name with preceding slash (for example, C</vicepa>) | |
60 | or use one of the three acceptable abbreviated forms. For details, see | |
61 | L<vos(1)>. | |
62 | ||
63 | =item B<-id> <I<volume name or ID>> | |
64 | ||
65 | Specifies either the complete name or volume ID number of the volume. | |
66 | ||
67 | =item B<-sleep> <I<seconds to sleep>> | |
68 | ||
69 | Specifies to sleep for a certain number of seconds after taking the | |
70 | volume offline before bringing it online again. If this option is | |
71 | specified, the volume will be online when B<vos offline> successfully | |
72 | completes. If this option is not specified, B<vos online> must be run to | |
73 | bring the volume online. | |
74 | ||
75 | =item B<-busy> | |
76 | ||
77 | Specifies to mark the volume as `busy' instead of `offline'. This | |
78 | means that a program trying to access this volume will receive a VBUSY | |
79 | error instead of a VOFFLINE error (until the volume is brought back | |
80 | online). | |
81 | ||
82 | Different programs may react differently when they see these two | |
83 | different states, but in general a `busy' volume is only unavailable | |
84 | for a short period of time and will become online soon. An `offline' | |
85 | volume, on the other hand, is typically unavailable for longer periods | |
86 | and may not come back online until an administrator intervenes. | |
87 | ||
88 | As an example of when these states occur normally, a volume can be | |
89 | `busy' when it is being cloned (perhaps as the result of a | |
90 | B<vos backup> or B<vos release> operation). A volume can be `offline' | |
91 | if a non-DAFS fileserver has detected a problem in the volume, and an | |
92 | administrator must manually schedule a salvage for that volume before | |
93 | it becomes available again. | |
94 | ||
95 | If B<-busy> is specified, the B<-sleep> option must also be specified, to | |
96 | indicate for how long to keep the volume busy. | |
97 | ||
98 | =include fragments/vos-common.pod | |
99 | ||
100 | =back | |
101 | ||
102 | =head1 EXAMPLES | |
103 | ||
104 | The following example takes an online volume offline: | |
105 | ||
106 | % vos offline -server sv7.example.org -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_online(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. |