xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-upgrade.8 (revision eda14cbc264d6969b02f2b1994cef11148e914f1)
1*eda14cbcSMatt Macy.\"
2*eda14cbcSMatt Macy.\" CDDL HEADER START
3*eda14cbcSMatt Macy.\"
4*eda14cbcSMatt Macy.\" The contents of this file are subject to the terms of the
5*eda14cbcSMatt Macy.\" Common Development and Distribution License (the "License").
6*eda14cbcSMatt Macy.\" You may not use this file except in compliance with the License.
7*eda14cbcSMatt Macy.\"
8*eda14cbcSMatt Macy.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*eda14cbcSMatt Macy.\" or http://www.opensolaris.org/os/licensing.
10*eda14cbcSMatt Macy.\" See the License for the specific language governing permissions
11*eda14cbcSMatt Macy.\" and limitations under the License.
12*eda14cbcSMatt Macy.\"
13*eda14cbcSMatt Macy.\" When distributing Covered Code, include this CDDL HEADER in each
14*eda14cbcSMatt Macy.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*eda14cbcSMatt Macy.\" If applicable, add the following below this CDDL HEADER, with the
16*eda14cbcSMatt Macy.\" fields enclosed by brackets "[]" replaced with your own identifying
17*eda14cbcSMatt Macy.\" information: Portions Copyright [yyyy] [name of copyright owner]
18*eda14cbcSMatt Macy.\"
19*eda14cbcSMatt Macy.\" CDDL HEADER END
20*eda14cbcSMatt Macy.\"
21*eda14cbcSMatt Macy.\"
22*eda14cbcSMatt Macy.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23*eda14cbcSMatt Macy.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24*eda14cbcSMatt Macy.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25*eda14cbcSMatt Macy.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26*eda14cbcSMatt Macy.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27*eda14cbcSMatt Macy.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28*eda14cbcSMatt Macy.\" Copyright (c) 2014 Integros [integros.com]
29*eda14cbcSMatt Macy.\" Copyright 2019 Richard Laager. All rights reserved.
30*eda14cbcSMatt Macy.\" Copyright 2018 Nexenta Systems, Inc.
31*eda14cbcSMatt Macy.\" Copyright 2019 Joyent, Inc.
32*eda14cbcSMatt Macy.\"
33*eda14cbcSMatt Macy.Dd June 30, 2019
34*eda14cbcSMatt Macy.Dt ZFS-UPGRADE 8
35*eda14cbcSMatt Macy.Os
36*eda14cbcSMatt Macy.Sh NAME
37*eda14cbcSMatt Macy.Nm zfs Ns Pf - Cm upgrade
38*eda14cbcSMatt Macy.Nd Manage upgrading the on-disk version of filesystems.
39*eda14cbcSMatt Macy.Sh SYNOPSIS
40*eda14cbcSMatt Macy.Nm
41*eda14cbcSMatt Macy.Cm upgrade
42*eda14cbcSMatt Macy.Nm
43*eda14cbcSMatt Macy.Cm upgrade
44*eda14cbcSMatt Macy.Fl v
45*eda14cbcSMatt Macy.Nm
46*eda14cbcSMatt Macy.Cm upgrade
47*eda14cbcSMatt Macy.Op Fl r
48*eda14cbcSMatt Macy.Op Fl V Ar version
49*eda14cbcSMatt Macy.Fl a | Ar filesystem
50*eda14cbcSMatt Macy.Sh DESCRIPTION
51*eda14cbcSMatt Macy.Bl -tag -width ""
52*eda14cbcSMatt Macy.It Xo
53*eda14cbcSMatt Macy.Nm
54*eda14cbcSMatt Macy.Cm upgrade
55*eda14cbcSMatt Macy.Xc
56*eda14cbcSMatt MacyDisplays a list of file systems that are not the most recent version.
57*eda14cbcSMatt Macy.It Xo
58*eda14cbcSMatt Macy.Nm
59*eda14cbcSMatt Macy.Cm upgrade
60*eda14cbcSMatt Macy.Fl v
61*eda14cbcSMatt Macy.Xc
62*eda14cbcSMatt MacyDisplays a list of currently supported file system versions.
63*eda14cbcSMatt Macy.It Xo
64*eda14cbcSMatt Macy.Nm
65*eda14cbcSMatt Macy.Cm upgrade
66*eda14cbcSMatt Macy.Op Fl r
67*eda14cbcSMatt Macy.Op Fl V Ar version
68*eda14cbcSMatt Macy.Fl a | Ar filesystem
69*eda14cbcSMatt Macy.Xc
70*eda14cbcSMatt MacyUpgrades file systems to a new on-disk version.
71*eda14cbcSMatt MacyOnce this is done, the file systems will no longer be accessible on systems
72*eda14cbcSMatt Macyrunning older versions of the software.
73*eda14cbcSMatt Macy.Nm zfs Cm send
74*eda14cbcSMatt Macystreams generated from new snapshots of these file systems cannot be accessed on
75*eda14cbcSMatt Macysystems running older versions of the software.
76*eda14cbcSMatt Macy.Pp
77*eda14cbcSMatt MacyIn general, the file system version is independent of the pool version.
78*eda14cbcSMatt MacySee
79*eda14cbcSMatt Macy.Xr zpool 8
80*eda14cbcSMatt Macyfor information on the
81*eda14cbcSMatt Macy.Nm zpool Cm upgrade
82*eda14cbcSMatt Macycommand.
83*eda14cbcSMatt Macy.Pp
84*eda14cbcSMatt MacyIn some cases, the file system version and the pool version are interrelated and
85*eda14cbcSMatt Macythe pool version must be upgraded before the file system version can be
86*eda14cbcSMatt Macyupgraded.
87*eda14cbcSMatt Macy.Bl -tag -width "-V"
88*eda14cbcSMatt Macy.It Fl V Ar version
89*eda14cbcSMatt MacyUpgrade to the specified
90*eda14cbcSMatt Macy.Ar version .
91*eda14cbcSMatt MacyIf the
92*eda14cbcSMatt Macy.Fl V
93*eda14cbcSMatt Macyflag is not specified, this command upgrades to the most recent version.
94*eda14cbcSMatt MacyThis
95*eda14cbcSMatt Macyoption can only be used to increase the version number, and only up to the most
96*eda14cbcSMatt Macyrecent version supported by this software.
97*eda14cbcSMatt Macy.It Fl a
98*eda14cbcSMatt MacyUpgrade all file systems on all imported pools.
99*eda14cbcSMatt Macy.It Ar filesystem
100*eda14cbcSMatt MacyUpgrade the specified file system.
101*eda14cbcSMatt Macy.It Fl r
102*eda14cbcSMatt MacyUpgrade the specified file system and all descendent file systems.
103*eda14cbcSMatt Macy.El
104*eda14cbcSMatt Macy.El
105*eda14cbcSMatt Macy.Sh SEE ALSO
106*eda14cbcSMatt Macy.Xr zpool-upgrade 8
107