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