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