xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-upgrade.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1*61145dc2SMartin Matuska.\" SPDX-License-Identifier: CDDL-1.0
2eda14cbcSMatt Macy.\"
3eda14cbcSMatt Macy.\" CDDL HEADER START
4eda14cbcSMatt Macy.\"
5eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
6eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
7eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
8eda14cbcSMatt Macy.\"
9eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10271171e0SMartin Matuska.\" or https://opensource.org/licenses/CDDL-1.0.
11eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
12eda14cbcSMatt Macy.\" and limitations under the License.
13eda14cbcSMatt Macy.\"
14eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
15eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
17eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
18eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
19eda14cbcSMatt Macy.\"
20eda14cbcSMatt Macy.\" CDDL HEADER END
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-UPGRADE 8
35eda14cbcSMatt Macy.Os
3616038816SMartin Matuska.
37eda14cbcSMatt Macy.Sh NAME
387877fdebSMatt Macy.Nm zfs-upgrade
3916038816SMartin Matuska.Nd manage on-disk version of ZFS filesystems
40eda14cbcSMatt Macy.Sh SYNOPSIS
417877fdebSMatt Macy.Nm zfs
42eda14cbcSMatt Macy.Cm upgrade
437877fdebSMatt Macy.Nm zfs
44eda14cbcSMatt Macy.Cm upgrade
45eda14cbcSMatt Macy.Fl v
467877fdebSMatt Macy.Nm zfs
47eda14cbcSMatt Macy.Cm upgrade
48eda14cbcSMatt Macy.Op Fl r
49eda14cbcSMatt Macy.Op Fl V Ar version
5016038816SMartin Matuska.Fl a Ns | Ns Ar filesystem
5116038816SMartin Matuska.
52eda14cbcSMatt Macy.Sh DESCRIPTION
53eda14cbcSMatt Macy.Bl -tag -width ""
54eda14cbcSMatt Macy.It Xo
557877fdebSMatt Macy.Nm zfs
56eda14cbcSMatt Macy.Cm upgrade
57eda14cbcSMatt Macy.Xc
58eda14cbcSMatt MacyDisplays a list of file systems that are not the most recent version.
59eda14cbcSMatt Macy.It Xo
607877fdebSMatt Macy.Nm zfs
61eda14cbcSMatt Macy.Cm upgrade
62eda14cbcSMatt Macy.Fl v
63eda14cbcSMatt Macy.Xc
64eda14cbcSMatt MacyDisplays a list of currently supported file system versions.
65eda14cbcSMatt Macy.It Xo
667877fdebSMatt Macy.Nm zfs
67eda14cbcSMatt Macy.Cm upgrade
68eda14cbcSMatt Macy.Op Fl r
69eda14cbcSMatt Macy.Op Fl V Ar version
7016038816SMartin Matuska.Fl a Ns | Ns Ar filesystem
71eda14cbcSMatt Macy.Xc
72eda14cbcSMatt MacyUpgrades file systems to a new on-disk version.
73eda14cbcSMatt MacyOnce this is done, the file systems will no longer be accessible on systems
7416038816SMartin Matuskarunning older versions of ZFS.
75eda14cbcSMatt Macy.Nm zfs Cm send
76eda14cbcSMatt Macystreams generated from new snapshots of these file systems cannot be accessed on
7716038816SMartin Matuskasystems running older versions of ZFS.
78eda14cbcSMatt Macy.Pp
79eda14cbcSMatt MacyIn general, the file system version is independent of the pool version.
80eda14cbcSMatt MacySee
813ff01b23SMartin Matuska.Xr zpool-features 7
8216038816SMartin Matuskafor information on features of ZFS storage pools.
83eda14cbcSMatt Macy.Pp
84eda14cbcSMatt MacyIn some cases, the file system version and the pool version are interrelated and
85eda14cbcSMatt Macythe pool version must be upgraded before the file system version can be
86eda14cbcSMatt Macyupgraded.
8716038816SMartin Matuska.Bl -tag -width "filesystem"
88eda14cbcSMatt Macy.It Fl V Ar version
8916038816SMartin MatuskaUpgrade to
90eda14cbcSMatt Macy.Ar version .
9116038816SMartin MatuskaIf not specified, upgrade to the most recent version.
92eda14cbcSMatt MacyThis
93eda14cbcSMatt Macyoption can only be used to increase the version number, and only up to the most
9416038816SMartin Matuskarecent version supported by this version of ZFS.
95eda14cbcSMatt Macy.It Fl a
96eda14cbcSMatt MacyUpgrade all file systems on all imported pools.
97eda14cbcSMatt Macy.It Ar filesystem
98eda14cbcSMatt MacyUpgrade the specified file system.
99eda14cbcSMatt Macy.It Fl r
100eda14cbcSMatt MacyUpgrade the specified file system and all descendent file systems.
101eda14cbcSMatt Macy.El
102eda14cbcSMatt Macy.El
103eda14cbcSMatt Macy.Sh SEE ALSO
104eda14cbcSMatt Macy.Xr zpool-upgrade 8
105