doc/man-pages/pod1/vos_shadow.pod.in

   1 =head1 NAME
   2
   3 vos_shadow - Creates a shadow copy of a volume on a different server/partition
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos shadow> S<<< [B<-id>] <I<volume name or ID on source>> >>>
  11     S<<< [B<-fromserver>] <I<machine name on source>> >>>
  12     S<<< [B<-frompartition>] <I<partition name on source>> >>>
  13     S<<< [B<-toserver>] <I<machine name on destination>> >>>
  14     S<<< [B<-topartition>] <I<partition name on destination>> >>>
  15     S<<< [B<-toname> <I<volume name on destination>>] >>>
  16     S<<< [B<-toid> <I<volume ID on destination>>] >>>
  17     [B<-offline>] [B<-readonly>] [B<-live>] [B<-incremental>]
  18     S<<< [B<-cell> <I<cell name>>] >>>
  19     [B<-noauth>] [B<-localauth>]
  20     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  21
  22 B<vos sh> S<<< [B<-id>] <I<volume name or ID on source>> >>>
  23     S<<< [B<-froms>] <I<machine name on source>> >>>
  24     S<<< [B<-fromp>] <I<partition name on source>> >>>
  25     S<<< [B<-tos>] <I<machine name on destination>> >>>
  26     S<<< [B<-top>] <I<partition name on destination>> >>>
  27     S<<< [B<-ton> <I<volume name on destination>>] >>>
  28     S<<< [B<-toi> <I<volume ID on destination>>] >>>
  29     [B<-o>] [B<-r>] [B<-l>] [B<-in>]
  30     S<<< [B<-c> <I<cell name>>] >>>
  31     [B<-noa>] [B<-lo>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  32
  33 =for html
  34 </div>
  35
  36 =head1 DESCRIPTION
  37
  38 The B<vos shadow> command creates a shadow copy of a volume on a
  39 different partition or server.
  40
  41 A shadow volume is a copy of a volume that does not normally appear in
  42 the volume location database (VLDB). It is a primitive operation that
  43 is meant to be used in backup or disaster recovery situations.
  44
  45 =head1 CAUTIONS
  46
  47 This command is not used during normal OpenAFS administration and may
  48 have adverse effects on the VLDB if not used properly! This command
  49 should only be used by an expert.
  50
  51 Using this command on a volume when the source volume is not the same
  52 as parent volume used to create the shadow will leave the destination
  53 volume in a unknown state.
  54
  55 Running B<vos syncserv> or B<vos syncvldb> on a fileserver containing
  56 shadow volumes will not update the VLDB with the shadowed Read/Write
  57 volumes as long as the entries for the source volumes still exist. In
  58 a disaster recovery situation the VLDB entries for the corresponding
  59 source volumes need hence to be deleted first.
  60
  61 =include fragments/volsize-caution.pod
  62
  63 =head1 OPTIONS
  64
  65 =over 4
  66
  67 =item [B<-id>] <I<volume name or ID>>
  68
  69 Specifies either the complete name or volume ID number of a read/write
  70 volume.
  71
  72 =item [B<-fromserver>] <I<machine name for source>>
  73
  74 Identifies the file server machine where the source volume resides. Provide
  75 the machine's IP address or its host name (either fully qualified or using
  76 an unambiguous abbreviation). For details, see L<vos(1)>.
  77
  78 =item [B<-frompartition>] <I<partition name for source>>
  79
  80 Names the partition where the source volume resides. Provide the full
  81 partition name (for, example, B</vicepa>) or one of the abbreviated forms
  82 described in L<vos(1)>.
  83
  84 =item [B<-toserver>] <I<machine name for destination>>
  85
  86 Identifies the file server machine to which to copy the volume.  Provide
  87 the machine's IP address or its host name (either fully qualified or using
  88 an unambiguous abbreviation). For details, see L<vos(1)>.
  89
  90 =item [B<-topartition>] <I<partition name for destination>>
  91
  92 Names the partition to which to copy the volume. Provide the full partition
  93 name (for, example, B</vicepa>) or one of the abbreviated forms described in
  94 L<vos(1)>.
  95
  96 =item B<-toname> <I<volume name for new copy>>
  97
  98 The complete name of the new volume to create.
  99
 100 =item B<-offline>
 101
 102 Leaves the new volume flagged as off-line in the volume database.
 103
 104 =item B<-readonly>
 105
 106 Flags the new volume as read-only in the volume database.
 107
 108 =item B<-live>
 109
 110 Copies the live volume without cloning.  This is normally not necessary and
 111 causes the volume to be kept locked for longer than the normal copy
 112 mechanism.
 113
 114 =item B<-incremental>
 115
 116 Copy the changes from the source volume to a previously created shadow
 117 volume.
 118
 119 =item B<-cell> <I<cell name>>
 120
 121 Names the cell in which to run the command. Do not combine this argument
 122 with the B<-localauth> flag. For more details, see L<vos(1)>.
 123
 124 =item B<-noauth>
 125
 126 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 127 combine this flag with the B<-localauth> flag. For more details, see
 128 L<vos(1)>.
 129
 130 =item B<-localauth>
 131
 132 Constructs a server ticket using a key from the local
 133 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents
 134 it to the Volume Server and Volume Location Server during mutual
 135 authentication. Do not combine this flag with the B<-cell> argument or
 136 B<-noauth> flag. For more details, see L<vos(1)>.
 137
 138 =item B<-verbose>
 139
 140 Produces on the standard output stream a detailed trace of the command's
 141 execution. If this argument is omitted, only warnings and error messages
 142 appear.
 143
 144 =item B<-encrypt>
 145
 146 Encrypts the command so that the operation's results are not transmitted
 147 across the network in clear text. This option is available in OpenAFS
 148 versions 1.4.11 or later and 1.5.60 or later.
 149
 150 =item B<-noresolve>
 151
 152 Shows all servers as IP addresses instead of the DNS name. This is very
 153 useful when the server address is registered as 127.0.0.1 or when dealing
 154 with multi-homed servers. This option is available in OpenAFS
 155 versions 1.4.8 or later and 1.5.35 or later.
 156
 157 =item B<-help>
 158
 159 Prints the online help for this command. All other valid options are
 160 ignored.
 161
 162 =back
 163
 164 =head1 OUTPUT
 165
 166 This command has no output unless C<-verbose> is specified or there is
 167 an error.
 168
 169 =head1 PRIVILEGE REQUIRED
 170
 171 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 172 machines specified with the B<-toserver> and B<-fromserver> arguments and
 173 on each database server machine.  If the B<-localauth> flag is included,
 174 the issuer must instead be logged on to a server machine as the local
 175 superuser C<root>.
 176
 177 =head1 SEE ALSO
 178
 179 L<vos(1)>,
 180 L<vos_backup(1)>,
 181 L<vos_copy(1)>,
 182 L<vos_move(1)>
 183
 184 L<http://www.openafs.org/pipermail/openafs-info/2005-July/018469.html>
 185 discusses motivation for the creation of this command.
 186
 187 L<http://workshop.openafs.org/afsbpw06/talks/drh.scs.html> discusses
 188 one possible use for it.
 189
 190 =head1 COPYRIGHT
 191
 192 Copyright 2008 Jason Edgecombe <jason@rampaginggeek.com>
 193
 194 This documentation is covered by the BSD License as written in the
 195 doc/LICENSE file. This man page was written by Jason Edgecombe for
 196 OpenAFS.