man-page-license-change-20071225
[openafs.git] / doc / man-pages / pod1 / vos_convertROtoRW.pod
1 =head1 NAME
2
3 vos_convertROtoRW - Converts a Read-Only volume into a Read/Write volume
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
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<-help>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 B<vos convertROtoRW> converts a Read-Only volume into a Read/Write volume
22 when the original Read/Write volume is no longer available.  It's normal use
23 is to recover the Read/Write volume from a replica after a failed disk,
24 failed server, or accidental deletion.
25
26 =head1 CAUTIONS
27
28 This command can only be used with namei AFS file servers.  If used on an
29 inode AFS file server, it will fail with an error.
30
31 The command name is case-sensitive.  It must be issued with the capital "RO"
32 and "RW".
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-server> <I<server name>>
39
40 Identifies the file server machine that houses the Read-Only volume which
41 will be converted.  Provide the machine's IP address or its host name
42 (either fully qualified or using an unambiguous abbreviation).  For details,
43 see L<vos(1)>.
44
45 =item B<-partition> <I<partition name>>
46
47 Identifies the partition on the file server machine that houses the
48 Read-Only volume which will be converted.  Provide the full partition name
49 (for, example, B</vicepa>) or one of the abbreviated forms described in
50 L<vos(1)>.
51
52 =item B<-id> <I<volume ID>>
53
54 Specifies either the complete name or volume ID number of a Read/Write
55 volume.
56
57 =item B<-force>
58
59 Don't ask for confirmation.
60
61 =item B<-cell> <I<cell name>>
62
63 Names the cell in which to run the command. Do not combine this argument
64 with the B<-localauth> flag. For more details, see L<vos(1)>.
65
66 =item B<-noauth>
67
68 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
69 combine this flag with the B<-localauth> flag. For more details, see
70 L<vos(1)>.
71
72 =item B<-localauth>
73
74 Constructs a server ticket using a key from the local
75 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
76 to the Volume Server and Volume Location Server during mutual
77 authentication. Do not combine this flag with the B<-cell> argument or
78 B<-noauth> flag. For more details, see L<vos(1)>.
79
80 =item B<-verbose>
81
82 Produces on the standard output stream a detailed trace of the command's
83 execution. If this argument is omitted, only warnings and error messages
84 appear.
85
86 =item B<-encrypt>
87
88 Encrypts the command so that the operation's results are not transmitted
89 across the network in clear text.
90
91 =item B<-help>
92
93 Prints the online help for this command. All other valid options are
94 ignored.
95
96 =back
97
98 =head1 EXAMPLES
99
100 The following example converts the read-only volume test3.readonly in
101 partition vicepb on server1 to a read-write volume:
102
103    % vos convertROtoRW server1 b test3.readonly
104
105 =head1 PRIVILEGE REQUIRED
106
107 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
108 machines specified with the B<-toserver> and B<-fromserver> arguments and
109 on each database server machine.  If the B<-localauth> flag is included,
110 the issuer must instead be logged on to a server machine as the local
111 superuser C<root>.
112
113 =head1 SEE ALSO
114
115 L<vos(1)>
116
117 =head1 COPYRIGHT
118
119 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
120
121 This documentation is covered by the BSD License as written in the
122 doc/LICENSE file. This man page was written by Jason Edgecombe for
123 OpenAFS.