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