doc/man-pages/pod1/vos_copy.pod

   1 =head1 NAME
   2
   3 vos_copy - Make a copy of a volume
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos copy> S<<< [B<-id>] <I<volume name or ID of source>> >>>
  11    S<<< [B<-fromserver>] <I<machine name for source>> >>>
  12    S<<< [B<-frompartition>] <I<partition name for source>> >>>
  13    S<<< [B<-toname>] <I<volume name for new copy>> >>>
  14    S<<< [B<-toserver>] <I<machine name for destination>> >>>
  15    S<<< [B<-topartition>] <I<partition name for destination>> >>>
  16    [B<-offline>] [B<-readonly>] [B<-live>] S<<< [B<-cell> <I<cell name>>] >>>
  17    [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-encrypt>] [B<-help>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos copy> command makes a copy of a volume with a new name.  It is
  25 equivalent to B<vos dump> followed by B<vos restore>, but doesn't require
  26 the volume be stored locally by the client.
  27
  28 =head1 CAUTIONS
  29
  30 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
  31
  32 =head1 OPTIONS
  33
  34 =over 4
  35
  36 =item [B<-id>] <I<volume name or ID>>
  37
  38 Specifies either the complete name or volume ID number of a read/write
  39 volume.
  40
  41 =item [B<-fromserver>] <I<machine name for source>>
  42
  43 Identifies the file server machine where the source volume resides. Provide
  44 the machine's IP address or its host name (either fully qualified or using
  45 an unambiguous abbreviation). For details, see L<vos(1)>.
  46
  47 =item [B<-frompartition>] <I<partition name for source>>
  48
  49 Names the partition where the source volume resides. Provide the full
  50 partition name (for, example, B</vicepa>) or one of the abbreviated forms
  51 described in L<vos(1)>.
  52
  53 =item [B<-toname>] <I<volume name for new copy>>
  54
  55 The complete name of the new volume to create.
  56
  57 =item [B<-toserver>] <I<machine name for destination>>
  58
  59 Identifies the file server machine to which to copy the volume.  Provide
  60 the machine's IP address or its host name (either fully qualified or using
  61 an unambiguous abbreviation). For details, see L<vos(1)>.
  62
  63 =item [B<-topartition>] <I<partition name for destination>>
  64
  65 Names the partition to which to copy the volume. Provide the full partition
  66 name (for, example, B</vicepa>) or one of the abbreviated forms described in
  67 L<vos(1)>.
  68
  69 =item B<-offline>
  70
  71 Leaves the new volume flagged as off-line in the volume database.
  72
  73 =item B<-readonly>
  74
  75 Flags the new volume as read-only in the volume database.
  76
  77 =item B<-live>
  78
  79 Copies the live volume without cloning.  This is normally not necessary and
  80 causes the volume to be kept locked for longer than the normal copy
  81 mechanism.
  82
  83 =item B<-localauth>
  84
  85 Constructs a server ticket using a key from the local
  86 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it to
  87 the Volume Server and Volume Location Server during mutual
  88 authentication. Do not combine this flag with the B<-cell> argument or
  89 B<-noauth> flag. For more details, see L<vos(1)>.
  90
  91 =item B<-verbose>
  92
  93 Produces on the standard output stream a detailed trace of the command's
  94 execution. If this argument is omitted, only warnings and error messages
  95 appear.
  96
  97 =item B<-encrypt>
  98
  99 Encrypts the command so that the operation's results are not transmitted
 100 across the network in clear text.
 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 OUTPUT
 110
 111 This command has no output unless C<-verbose> is specified or there is
 112 an error.
 113
 114 =head1 EXAMPLES
 115
 116 The following example makes a verbose copy of the C<test> volume named
 117 C<test2> in the cell C<localcell>. The volume and copy both reside on
 118 C</vicepa> of C<server1>.
 119
 120    % vos copy test server1  a test2 server1 a -cell localcell -verbose
 121    Starting transaction on source volume 536870921 ... done
 122    Allocating new volume id for clone of volume 536870921 ... done
 123    Allocating new volume id for copy of volume 536870921 ... done
 124    Cloning source volume 536870921 ... done
 125    Ending the transaction on the source volume 536870921 ... done
 126    Starting transaction on the cloned volume 536870926 ... done
 127    Setting flags on cloned volume 536870926 ... done
 128    Getting status of cloned volume 536870926 ... done
 129    Creating the destination volume 536870927 ... done
 130    Setting volume flags on destination volume 536870927 ... done
 131    Dumping from clone 536870926 on source to volume 536870927 on destination ... done
 132    Ending transaction on cloned volume 536870926 ... done
 133    Starting transaction on source volume 536870921 ... done
 134    Doing the incremental dump from source to destination for volume 536870921 ...  done
 135    Setting volume flags on destination volume 536870927 ... done
 136    Ending transaction on destination volume 536870927 ... done
 137    Ending transaction on source volume 536870921 ... done
 138    Starting transaction on the cloned volume 536870926 ... done
 139    Deleting the cloned volume 536870926 ... done
 140    Ending transaction on cloned volume 536870926 ... done
 141    Created the VLDB entry for the volume test2 536870927
 142    Volume 536870921 copied from server1 /vicepa to test2 on server1 /vicepa
 143
 144 =head1 PRIVILEGE REQUIRED
 145
 146 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 147 machine specified with the B<-server> argument and on each database server
 148 machine. If the B<-localauth> flag is included, the issuer must instead be
 149 logged on to a server machine as the local superuser C<root>.
 150
 151 =head1 SEE ALSO
 152
 153 L<vos(1)>,
 154 L<vos_clone(1)>,
 155 L<vos_move(1)>
 156
 157 =head1 COPYRIGHT
 158
 159 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
 160
 161 This documentation is covered by the BSD License as written in the
 162 doc/LICENSE file. This man page was written by Jason Edgecombe for
 163 OpenAFS.