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