doc/man-pages/pod1/vos_clone.pod

   1 =head1 NAME
   2
   3 vos_clone - Creates a shared-space copy of a volume on a partition
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos clone> S<<< [B<-id>] <I<volume name or ID>> >>>
  11     S<<< [B<-server>] <I<server name>> >>>
  12     S<<< [B<-partition>] <I<partition name>> >>>
  13     S<<< [B<-toname> <I<volume name on destination>>] >>>
  14     S<<< [B<-toid> <I<volume ID on destination>>] >>>
  15     [B<-offline>] [B<-readonly>]
  16     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
  17     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  18
  19 B<vos cl> S<<< [B<-i>] <I<volume name or ID>> >>>
  20     S<<< [B<-s>] <I<server name>> >>>
  21     S<<< [B<-p>] <I<partition name>> >>>
  22     S<<< [B<-ton> <I<volume name on destination>>] >>>
  23     S<<< [B<-toi> <I<volume ID on destination>>] >>> [B<-o>] [B<-r>]
  24     S<<< [B<-c> <I<cell name>>] >>> [B<-noa>]
  25     [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  26
  27 =for html
  28 </div>
  29
  30 =head1 DESCRIPTION
  31
  32 The B<vos clone> command creates a copy-on-write copy of a volume on the
  33 same partition and server as the parent volume.
  34
  35 A clone is a copy of a volume that only stores the changes from the
  36 parent volume. Cloning is a primitive operation that is used by the B<vos
  37 move>, B<vos backup>, and B<vos release> commands. A clone functions using
  38 the same mechanism as a backup volume, but it is persistent. Clone volumes
  39 can be used as point-in-time copies of the parent vollume, but they must be
  40 used with care.
  41
  42 =head1 CAUTIONS
  43
  44 This command is not used during normal OpenAFS administration and may
  45 have adverse effects on the VLDB if not used properly! This command
  46 should only be used by an expert.
  47
  48 Deleting or moving the parent volume makes the clone volume inaccessible,
  49 but the clone volume remains in the VLDB and on disk, and it needs to be
  50 cleaned up manually.
  51
  52 There is a maximum limitation of 7 clones when using the namei
  53 fileserver. You may safely create up to 4 clones using the B<vos clone>
  54 command. The other three clone slots are used by the backup volume, a
  55 read-only replica and the temporary clone that is created when executing a
  56 B<vos move>, B<vos dump>, or other B<vos> commands.
  57
  58 Some commands do not work properly on clone volumes. B<vos move> is one
  59 such command.
  60
  61 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
  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<-server>] <I<machine name>>
  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<-partition>] <I<partition name>>
  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<-toname> <I<volume name for new copy>>
  85
  86 The complete name of the new volume to create.
  87
  88 =item B<-toid> <I<volume id for new copy>>
  89
  90 The complete id of the new volume to create.
  91
  92 =item B<-offline>
  93
  94 Leaves the new volume flagged as off-line in the volume database.
  95
  96 =item B<-readonly>
  97
  98 Flags the new volume as read-only in the volume database.
  99
 100 =item B<-cell> <I<cell name>>
 101
 102 Names the cell in which to run the command. Do not combine this argument
 103 with the B<-localauth> flag. For more details, see L<vos(1)>.
 104
 105 =item B<-noauth>
 106
 107 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 108 combine this flag with the B<-localauth> flag. For more details, see
 109 L<vos(1)>.
 110
 111 =item B<-localauth>
 112
 113 Constructs a server ticket using a key from the local
 114 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents
 115 it to the Volume Server and Volume Location Server during mutual
 116 authentication. Do not combine this flag with the B<-cell> argument or
 117 B<-noauth> flag. For more details, see L<vos(1)>.
 118
 119 =item B<-verbose>
 120
 121 Produces on the standard output stream a detailed trace of the command's
 122 execution. If this argument is omitted, only warnings and error messages
 123 appear.
 124
 125 =item B<-encrypt>
 126
 127 Encrypts the command so that the operation's results are not transmitted
 128 across the network in clear text. This option is available in OpenAFS
 129 versions 1.4.11 or later and 1.5.60 or later.
 130
 131 =item B<-noresolve>
 132
 133 Shows all servers as IP addresses instead of the DNS name. This is very
 134 useful when the server address is registered as 127.0.0.1 or when dealing
 135 with multi-homed servers. This option is available in OpenAFS
 136 versions 1.4.8 or later and 1.5.35 or later.
 137
 138 =item B<-help>
 139
 140 Prints the online help for this command. All other valid options are
 141 ignored.
 142
 143 =back
 144
 145 =head1 OUTPUT
 146
 147 This command has no output unless C<-verbose> is specified or there is
 148 an error.
 149
 150 =head1 PRIVILEGE REQUIRED
 151
 152 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 153 machines specified with the B<-toserver> and B<-fromserver> arguments and
 154 on each database server machine.  If the B<-localauth> flag is included,
 155 the issuer must instead be logged on to a server machine as the local
 156 superuser C<root>.
 157
 158 =head1 SEE ALSO
 159
 160 L<vos(1)>,
 161 L<vos_backup(1)>,
 162 L<vos_copy(1)>,
 163 L<vos_move(1)>,
 164 L<vos_shadow(1)>
 165
 166 =head1 COPYRIGHT
 167
 168 Copyright 2008 Jason Edgecombe <jason@rampaginggeek.com>
 169
 170 This documentation is covered by the BSD License as written in the
 171 doc/LICENSE file. This man page was written by Jason Edgecombe for
 172 OpenAFS.