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