man-page-vos-clone-20080626
[openafs.git] / 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>>] >>> [B<-offline>] [B<-readonly>]
15     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>]
16     [B<-localauth>] [B<-verbose>] [B<-encrypt>] [B<-help>]
17
18 =for html
19 </div>
20
21 =head1 DESCRIPTION
22
23 The B<vos clone> command creates a copy-on-write copy of a volume on the
24 same partition and server ass the parent volume.
25
26 A clone is a copy of a volume that does only stores the changes from the
27 parent volume. Cloning is a primitive operation that is used by the B<vos
28 move>, B<vos backup>, and B<vos release> commands. A clone functions using
29 the same mechanism as a backup volume, but it is persistent. Clone volumes
30 can be used as point-in-time copies of the parent vollume, but they must be
31 used with care.
32
33 =head1 CAUTIONS
34
35 This command is not used during normal OpenAFS administration and may
36 have adverse effects on the VLDB if not used properly! This command
37 should only be used by an expert.
38
39 Deleting or moving the parent volume makes the clone volume inaccessible,
40 but the clone volume remains in the VLDB and on disk, and it needs to be
41 cleaned up manually.
42
43 There is a maximum limitation of 7 clones when using the namei
44 fileserver. You may safely create up to 4 clones using the B<vos clone>
45 command. The other three clone slots are used by the backup volume, a
46 read-only replica and the temporary clone that is created when executing a
47 B<vos move>, B<vos dump>, or other B<vos> commands.
48
49 Some commands do not work properly on clone volumes. B<vos move> is one
50 such command.
51
52 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
53
54 =head1 OPTIONS
55
56 =over 4
57
58 =item [B<-id>] <I<volume name or ID>>
59
60 Specifies either the complete name or volume ID number of a read/write
61 volume.
62
63 =item [B<-server>] <I<machine name>>
64
65 Identifies the file server machine where the source volume resides. Provide
66 the machine's IP address or its host name (either fully qualified or using
67 an unambiguous abbreviation). For details, see L<vos(1)>.
68
69 =item [B<-partition>] <I<partition name>>
70
71 Names the partition where the source volume resides. Provide the full
72 partition name (for, example, B</vicepa>) or one of the abbreviated forms
73 described in L<vos(1)>.
74
75 =item B<-toname> <I<volume name for new copy>>
76
77 The complete name of the new volume to create.
78
79 =item B<-toid> <I<volume id for new copy>>
80
81 The complete id of the new volume to create.
82
83 =item B<-offline>
84
85 Leaves the new volume flagged as off-line in the volume database.
86
87 =item B<-readonly>
88
89 Flags the new volume as read-only in the volume database.
90
91 =item B<-cell> <I<cell name>>
92
93 Names the cell in which to run the command. Do not combine this argument
94 with the B<-localauth> flag. For more details, see L<vos(1)>.
95
96 =item B<-noauth>
97
98 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
99 combine this flag with the B<-localauth> flag. For more details, see
100 L<vos(1)>.
101
102 =item B<-localauth>
103
104 Constructs a server ticket using a key from the local
105 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents
106 it to the Volume Server and Volume Location Server during mutual
107 authentication. Do not combine this flag with the B<-cell> argument or
108 B<-noauth> flag. For more details, see L<vos(1)>.
109
110 =item B<-verbose>
111
112 Produces on the standard output stream a detailed trace of the command's
113 execution. If this argument is omitted, only warnings and error messages
114 appear.
115
116 =item B<-encrypt>
117
118 Encrypts the command so that the operation's results are not transmitted
119 across the network in clear text.
120
121 =item B<-help>
122
123 Prints the online help for this command. All other valid options are
124 ignored.
125
126 =back
127
128 =head1 OUTPUT
129
130 This command has no output unless C<-verbose> is specified or there is
131 an error.
132
133 =head1 PRIVILEGE REQUIRED
134
135 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
136 machines specified with the B<-toserver> and B<-fromserver> arguments and
137 on each database server machine.  If the B<-localauth> flag is included,
138 the issuer must instead be logged on to a server machine as the local
139 superuser C<root>.
140
141 =head1 SEE ALSO
142
143 L<vos(1)>,
144 L<vos_backup(1)>,
145 L<vos_copy(1)>,
146 L<vos_move(1)>,
147 L<vos_shadow(1)>
148
149 =head1 COPYRIGHT
150
151 Copyright 2008 Jason Edgecombe <jason@rampaginggeek.com>
152
153 This documentation is covered by the BSD License as written in the
154 doc/LICENSE file. This man page was written by Jason Edgecombe for
155 OpenAFS.