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