Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / vos_convertROtoRW.pod.in
blobfad6545fb8d74b01139a522861dee2133d24dee2
1 =head1 NAME
3 vos_convertROtoRW - Converts a Read-Only volume into a Read/Write volume
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<vos convertROtoRW> S<<< [B<-server>] <I<machine name>> >>>
11    S<<< [B<-partition>] <I<partition name>> >>>
12    S<<< [B<-id>] <I<volume name or ID>> >>> [B<-force>]
13    S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
14    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
15    S<<< [B<-config> <I<config directory>>] >>>
16    [B<-help>]
18 B<vos con> S<<< [B<-s>] <I<machine name>> >>>
19    S<<< [B<-p>] <I<partition name>> >>>
20    S<<< [B<-i>] <I<volume name or ID>> >>> [B<-f>]
21    S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
22    [B<-v>] [B<-e>] [B<-nor>]
23    S<<< [B<-co> <I<config directory>>] >>>
24    [B<-h>]
26 =for html
27 </div>
29 =head1 DESCRIPTION
31 B<vos convertROtoRW> converts a Read-Only volume into a Read/Write volume
32 when the original Read/Write volume is no longer available.  It's normal use
33 is to recover the Read/Write volume from a replica after a failed disk,
34 failed server, or accidental deletion.
36 =head1 CAUTIONS
38 The command name is case-sensitive.  It must be issued with the capital "RO"
39 and "RW".
41 After running vos convertROtoRW, the old file server will still contain
42 the old Read/Write copy of the volume, even if the VLDB no longer
43 references it. You can view the old volume with B<vos listvol>, and you
44 should remove the old copy (for example, with B<vos zap>) so that the
45 original file server will match the VLDB.
47 =head1 OPTIONS
49 =over 4
51 =item B<-server> <I<server name>>
53 Identifies the file server machine that houses the Read-Only volume which
54 will be converted.  Provide the machine's IP address or its host name
55 (either fully qualified or using an unambiguous abbreviation).  For details,
56 see L<vos(1)>.
58 =item B<-partition> <I<partition name>>
60 Identifies the partition on the file server machine that houses the
61 Read-Only volume which will be converted.  Provide the full partition name
62 (for, example, B</vicepa>) or one of the abbreviated forms described in
63 L<vos(1)>.
65 =item B<-id> <I<volume ID>>
67 Specifies either the complete name or volume ID number of a Read/Write
68 volume.
70 =item B<-force>
72 Don't ask for confirmation.
74 =include fragments/vos-common.pod
76 =back
78 =head1 EXAMPLES
80 The following example converts the read-only volume test3.readonly in
81 partition vicepb on server1 to a read-write volume:
83    % vos convertROtoRW server1 b test3.readonly
85 =head1 PRIVILEGE REQUIRED
87 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
88 machine specified with the B<-server> argument and
89 on each database server machine.  If the B<-localauth> flag is included,
90 the issuer must instead be logged on to a server machine as the local
91 superuser C<root>.
93 =head1 SEE ALSO
95 L<vos(1)>
97 =head1 COPYRIGHT
99 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
101 This documentation is covered by the BSD License as written in the
102 doc/LICENSE file. This man page was written by Jason Edgecombe for
103 OpenAFS.