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 Do NOT run the B<vos syncserv> or B<vos syncvldb> on any fileserver
  56 containing shadow volumes. This would update the VLDB to show all
  57 shadowed Read/Write volumes instead of the source volumes from which
  58 they were copied.
  59
  60 =include fragments/volsize-caution.pod
  61
  62 =head1 OPTIONS
  63
  64 =over 4
  65
  66 =item [B<-id>] <I<volume name or ID>>
  67
  68 Specifies either the complete name or volume ID number of a read/write
  69 volume.
  70
  71 =item [B<-fromserver>] <I<machine name for source>>
  72
  73 Identifies the file server machine where the source volume resides. Provide
  74 the machine's IP address or its host name (either fully qualified or using
  75 an unambiguous abbreviation). For details, see L<vos(1)>.
  76
  77 =item [B<-frompartition>] <I<partition name for source>>
  78
  79 Names the partition where the source volume resides. Provide the full
  80 partition name (for, example, B</vicepa>) or one of the abbreviated forms
  81 described in L<vos(1)>.
  82
  83 =item [B<-toserver>] <I<machine name for destination>>
  84
  85 Identifies the file server machine to which to copy the volume.  Provide
  86 the machine's IP address or its host name (either fully qualified or using
  87 an unambiguous abbreviation). For details, see L<vos(1)>.
  88
  89 =item [B<-topartition>] <I<partition name for destination>>
  90
  91 Names the partition to which to copy the volume. Provide the full partition
  92 name (for, example, B</vicepa>) or one of the abbreviated forms described in
  93 L<vos(1)>.
  94
  95 =item B<-toname> <I<volume name for new copy>>
  96
  97 The complete name of the new volume to create.
  98
  99 =item B<-offline>
 100
 101 Leaves the new volume flagged as off-line in the volume database.
 102
 103 =item B<-readonly>
 104
 105 Flags the new volume as read-only in the volume database.
 106
 107 =item B<-live>
 108
 109 Copies the live volume without cloning.  This is normally not necessary and
 110 causes the volume to be kept locked for longer than the normal copy
 111 mechanism.
 112
 113 =item B<-incremental>
 114
 115 Copy the changes from the source volume to a previously created shadow
 116 volume.
 117
 118 =item B<-cell> <I<cell name>>
 119
 120 Names the cell in which to run the command. Do not combine this argument
 121 with the B<-localauth> flag. For more details, see L<vos(1)>.
 122
 123 =item B<-noauth>
 124
 125 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 126 combine this flag with the B<-localauth> flag. For more details, see
 127 L<vos(1)>.
 128
 129 =item B<-localauth>
 130
 131 Constructs a server ticket using a key from the local
 132 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents
 133 it to the Volume Server and Volume Location Server during mutual
 134 authentication. Do not combine this flag with the B<-cell> argument or
 135 B<-noauth> flag. For more details, see L<vos(1)>.
 136
 137 =item B<-verbose>
 138
 139 Produces on the standard output stream a detailed trace of the command's
 140 execution. If this argument is omitted, only warnings and error messages
 141 appear.
 142
 143 =item B<-encrypt>
 144
 145 Encrypts the command so that the operation's results are not transmitted
 146 across the network in clear text. This option is available in OpenAFS
 147 versions 1.4.11 or later and 1.5.60 or later.
 148
 149 =item B<-noresolve>
 150
 151 Shows all servers as IP addresses instead of the DNS name. This is very
 152 useful when the server address is registered as 127.0.0.1 or when dealing
 153 with multi-homed servers. This option is available in OpenAFS
 154 versions 1.4.8 or later and 1.5.35 or later.
 155
 156 =item B<-help>
 157
 158 Prints the online help for this command. All other valid options are
 159 ignored.
 160
 161 =back
 162
 163 =head1 OUTPUT
 164
 165 This command has no output unless C<-verbose> is specified or there is
 166 an error.
 167
 168 =head1 PRIVILEGE REQUIRED
 169
 170 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 171 machines specified with the B<-toserver> and B<-fromserver> arguments and
 172 on each database server machine.  If the B<-localauth> flag is included,
 173 the issuer must instead be logged on to a server machine as the local
 174 superuser C<root>.
 175
 176 =head1 SEE ALSO
 177
 178 L<vos(1)>,
 179 L<vos_backup(1)>,
 180 L<vos_copy(1)>,
 181 L<vos_move(1)>
 182
 183 L<http://www.openafs.org/pipermail/openafs-info/2005-July/018469.html>
 184 discusses motivation for the creation of this command.
 185
 186 L<http://workshop.openafs.org/afsbpw06/talks/drh.scs.html> discusses
 187 one possible use for it.
 188
 189 =head1 COPYRIGHT
 190
 191 Copyright 2008 Jason Edgecombe <jason@rampaginggeek.com>
 192
 193 This documentation is covered by the BSD License as written in the
 194 doc/LICENSE file. This man page was written by Jason Edgecombe for
 195 OpenAFS.