1.\" SPDX-License-Identifier: CDDL-1.0 2.\" 3.\" CDDL HEADER START 4.\" 5.\" The contents of this file are subject to the terms of the 6.\" Common Development and Distribution License (the "License"). 7.\" You may not use this file except in compliance with the License. 8.\" 9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10.\" or https://opensource.org/licenses/CDDL-1.0. 11.\" See the License for the specific language governing permissions 12.\" and limitations under the License. 13.\" 14.\" When distributing Covered Code, include this CDDL HEADER in each 15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16.\" If applicable, add the following below this CDDL HEADER, with the 17.\" fields enclosed by brackets "[]" replaced with your own identifying 18.\" information: Portions Copyright [yyyy] [name of copyright owner] 19.\" 20.\" CDDL HEADER END 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 March 16, 2022 34.Dt ZFS-CLONE 8 35.Os 36. 37.Sh NAME 38.Nm zfs-clone 39.Nd clone snapshot of ZFS dataset 40.Sh SYNOPSIS 41.Nm zfs 42.Cm clone 43.Op Fl p 44.Oo Fl o Ar property Ns = Ns Ar value Oc Ns … 45.Ar snapshot Ar filesystem Ns | Ns Ar volume 46. 47.Sh DESCRIPTION 48See the 49.Sx Clones 50section of 51.Xr zfsconcepts 7 52for details. 53The target dataset can be located anywhere in the ZFS hierarchy, 54and is created as the same type as the original. 55.Bl -tag -width Ds 56.It Fl o Ar property Ns = Ns Ar value 57Sets the specified property; see 58.Nm zfs Cm create 59for details. 60.It Fl p 61Creates all the non-existing parent datasets. 62Datasets created in this manner are automatically mounted according to the 63.Sy mountpoint 64property inherited from their parent. 65If the target filesystem or volume already exists, the operation completes 66successfully. 67.El 68. 69.Sh EXAMPLES 70.\" These are, respectively, examples 9, 10 from zfs.8 71.\" Make sure to update them bidirectionally 72.Ss Example 1 : No Creating a ZFS Clone 73The following command creates a writable file system whose initial contents are 74the same as 75.Ar pool/home/bob@yesterday . 76.Dl # Nm zfs Cm clone Ar pool/home/bob@yesterday pool/clone 77. 78.Ss Example 2 : No Promoting a ZFS Clone 79The following commands illustrate how to test out changes to a file system, and 80then replace the original file system with the changed one, using clones, clone 81promotion, and renaming: 82.Bd -literal -compact -offset Ds 83.No # Nm zfs Cm create Ar pool/project/production 84 populate /pool/project/production with data 85.No # Nm zfs Cm snapshot Ar pool/project/production Ns @ Ns Ar today 86.No # Nm zfs Cm clone Ar pool/project/production@today pool/project/beta 87 make changes to /pool/project/beta and test them 88.No # Nm zfs Cm promote Ar pool/project/beta 89.No # Nm zfs Cm rename Ar pool/project/production pool/project/legacy 90.No # Nm zfs Cm rename Ar pool/project/beta pool/project/production 91 once the legacy version is no longer needed, it can be destroyed 92.No # Nm zfs Cm destroy Ar pool/project/legacy 93.Ed 94. 95.Sh SEE ALSO 96.Xr zfs-promote 8 , 97.Xr zfs-snapshot 8 98