xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-clone.8 (revision eda14cbc264d6969b02f2b1994cef11148e914f1)
1*eda14cbcSMatt Macy.\"
2*eda14cbcSMatt Macy.\" CDDL HEADER START
3*eda14cbcSMatt Macy.\"
4*eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5*eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6*eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7*eda14cbcSMatt Macy.\"
8*eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*eda14cbcSMatt Macy.\" or http://www.opensolaris.org/os/licensing.
10*eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11*eda14cbcSMatt Macy.\" and limitations under the License.
12*eda14cbcSMatt Macy.\"
13*eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14*eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16*eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17*eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18*eda14cbcSMatt Macy.\"
19*eda14cbcSMatt Macy.\" CDDL HEADER END
20*eda14cbcSMatt Macy.\"
21*eda14cbcSMatt Macy.\"
22*eda14cbcSMatt Macy.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23*eda14cbcSMatt Macy.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24*eda14cbcSMatt Macy.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25*eda14cbcSMatt Macy.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26*eda14cbcSMatt Macy.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27*eda14cbcSMatt Macy.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28*eda14cbcSMatt Macy.\" Copyright (c) 2014 Integros [integros.com]
29*eda14cbcSMatt Macy.\" Copyright 2019 Richard Laager. All rights reserved.
30*eda14cbcSMatt Macy.\" Copyright 2018 Nexenta Systems, Inc.
31*eda14cbcSMatt Macy.\" Copyright 2019 Joyent, Inc.
32*eda14cbcSMatt Macy.\"
33*eda14cbcSMatt Macy.Dd June 30, 2019
34*eda14cbcSMatt Macy.Dt ZFS-CLONE 8
35*eda14cbcSMatt Macy.Os
36*eda14cbcSMatt Macy.Sh NAME
37*eda14cbcSMatt Macy.Nm zfs Ns Pf - Cm clone
38*eda14cbcSMatt Macy.Nd Creates a clone of the given snapshot.
39*eda14cbcSMatt Macy.Sh SYNOPSIS
40*eda14cbcSMatt Macy.Nm
41*eda14cbcSMatt Macy.Cm clone
42*eda14cbcSMatt Macy.Op Fl p
43*eda14cbcSMatt Macy.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
44*eda14cbcSMatt Macy.Ar snapshot Ar filesystem Ns | Ns Ar volume
45*eda14cbcSMatt Macy.Sh DESCRIPTION
46*eda14cbcSMatt Macy.Bl -tag -width ""
47*eda14cbcSMatt Macy.It Xo
48*eda14cbcSMatt Macy.Nm
49*eda14cbcSMatt Macy.Cm clone
50*eda14cbcSMatt Macy.Op Fl p
51*eda14cbcSMatt Macy.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
52*eda14cbcSMatt Macy.Ar snapshot Ar filesystem Ns | Ns Ar volume
53*eda14cbcSMatt Macy.Xc
54*eda14cbcSMatt MacySee the
55*eda14cbcSMatt Macy.Em Clones
56*eda14cbcSMatt Macysection of
57*eda14cbcSMatt Macy.Xr zfsconcepts 8
58*eda14cbcSMatt Macyfor details.
59*eda14cbcSMatt MacyThe target dataset can be located anywhere in the ZFS hierarchy, and is created
60*eda14cbcSMatt Macyas the same type as the original.
61*eda14cbcSMatt Macy.Bl -tag -width "-o"
62*eda14cbcSMatt Macy.It Fl o Ar property Ns = Ns Ar value
63*eda14cbcSMatt MacySets the specified property; see
64*eda14cbcSMatt Macy.Nm zfs Cm create
65*eda14cbcSMatt Macyfor details.
66*eda14cbcSMatt Macy.It Fl p
67*eda14cbcSMatt MacyCreates all the non-existing parent datasets.
68*eda14cbcSMatt MacyDatasets created in this manner are automatically mounted according to the
69*eda14cbcSMatt Macy.Sy mountpoint
70*eda14cbcSMatt Macyproperty inherited from their parent.
71*eda14cbcSMatt MacyIf the target filesystem or volume already exists, the operation completes
72*eda14cbcSMatt Macysuccessfully.
73*eda14cbcSMatt Macy.El
74*eda14cbcSMatt Macy.El
75*eda14cbcSMatt Macy.Sh SEE ALSO
76*eda14cbcSMatt Macy.Xr zfs-promote 8 ,
77*eda14cbcSMatt Macy.Xr zfs-snapshot 8
78