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-RENAME 8 35eda14cbcSMatt Macy.Os 36eda14cbcSMatt Macy.Sh NAME 37eda14cbcSMatt Macy.Nm zfs Ns Pf - Cm rename 38eda14cbcSMatt Macy.Nd Renames the given dataset (filesystem or snapshot). 39eda14cbcSMatt Macy.Sh SYNOPSIS 40eda14cbcSMatt Macy.Nm 41eda14cbcSMatt Macy.Cm rename 42eda14cbcSMatt Macy.Op Fl f 43eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 44eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 45eda14cbcSMatt Macy.Nm 46eda14cbcSMatt Macy.Cm rename 47*eac7052fSMatt Macy.Fl p 48*eac7052fSMatt Macy.Op Fl f 49eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume 50eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume 51*eac7052fSMatt Macy.Nm 52*eac7052fSMatt Macy.Cm rename 53*eac7052fSMatt Macy.Fl u 54*eac7052fSMatt Macy.Op Fl f 55*eac7052fSMatt Macy.Ar filesystem 56*eac7052fSMatt Macy.Ar filesystem 57eda14cbcSMatt Macy.Sh DESCRIPTION 58eda14cbcSMatt Macy.Bl -tag -width "" 59eda14cbcSMatt Macy.It Xo 60eda14cbcSMatt Macy.Nm 61eda14cbcSMatt Macy.Cm rename 62eda14cbcSMatt Macy.Op Fl f 63eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 64eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 65eda14cbcSMatt Macy.Xc 66eda14cbcSMatt Macy.It Xo 67eda14cbcSMatt Macy.Nm 68eda14cbcSMatt Macy.Cm rename 69*eac7052fSMatt Macy.Fl p 70*eac7052fSMatt Macy.Op Fl f 71eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume 72eda14cbcSMatt Macy.Ar filesystem Ns | Ns Ar volume 73eda14cbcSMatt Macy.Xc 74*eac7052fSMatt Macy.It Xo 75*eac7052fSMatt Macy.Nm 76*eac7052fSMatt Macy.Cm rename 77*eac7052fSMatt Macy.Fl u 78*eac7052fSMatt Macy.Op Fl f 79*eac7052fSMatt Macy.Ar filesystem 80*eac7052fSMatt Macy.Ar filesystem 81*eac7052fSMatt Macy.Xc 82eda14cbcSMatt MacyRenames the given dataset. 83eda14cbcSMatt MacyThe new target can be located anywhere in the ZFS hierarchy, with the exception 84eda14cbcSMatt Macyof snapshots. 85eda14cbcSMatt MacySnapshots can only be renamed within the parent file system or volume. 86eda14cbcSMatt MacyWhen renaming a snapshot, the parent file system of the snapshot does not need 87eda14cbcSMatt Macyto be specified as part of the second argument. 88eda14cbcSMatt MacyRenamed file systems can inherit new mount points, in which case they are 89eda14cbcSMatt Macyunmounted and remounted at the new mount point. 90eda14cbcSMatt Macy.Bl -tag -width "-a" 91eda14cbcSMatt Macy.It Fl f 92eda14cbcSMatt MacyForce unmount any file systems that need to be unmounted in the process. 93*eac7052fSMatt MacyThis flag has no effect if used together with the 94*eac7052fSMatt Macy.Fl u 95*eac7052fSMatt Macyflag. 96eda14cbcSMatt Macy.It Fl p 97eda14cbcSMatt MacyCreates all the nonexistent parent datasets. 98eda14cbcSMatt MacyDatasets created in this manner are automatically mounted according to the 99eda14cbcSMatt Macy.Sy mountpoint 100eda14cbcSMatt Macyproperty inherited from their parent. 101*eac7052fSMatt Macy.It Fl u 102*eac7052fSMatt MacyDo not remount file systems during rename. 103*eac7052fSMatt MacyIf a file system's 104*eac7052fSMatt Macy.Sy mountpoint 105*eac7052fSMatt Macyproperty is set to 106*eac7052fSMatt Macy.Sy legacy 107*eac7052fSMatt Macyor 108*eac7052fSMatt Macy.Sy none , 109*eac7052fSMatt Macythe file system is not unmounted even if this option is not given. 110eda14cbcSMatt Macy.El 111eda14cbcSMatt Macy.It Xo 112eda14cbcSMatt Macy.Nm 113eda14cbcSMatt Macy.Cm rename 114eda14cbcSMatt Macy.Fl r 115eda14cbcSMatt Macy.Ar snapshot Ar snapshot 116eda14cbcSMatt Macy.Xc 117eda14cbcSMatt MacyRecursively rename the snapshots of all descendent datasets. 118eda14cbcSMatt MacySnapshots are the only dataset that can be renamed recursively. 119eda14cbcSMatt Macy.El 120