xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-upgrade.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
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 June 30, 2019
34.Dt ZFS-UPGRADE 8
35.Os
36.
37.Sh NAME
38.Nm zfs-upgrade
39.Nd manage on-disk version of ZFS filesystems
40.Sh SYNOPSIS
41.Nm zfs
42.Cm upgrade
43.Nm zfs
44.Cm upgrade
45.Fl v
46.Nm zfs
47.Cm upgrade
48.Op Fl r
49.Op Fl V Ar version
50.Fl a Ns | Ns Ar filesystem
51.
52.Sh DESCRIPTION
53.Bl -tag -width ""
54.It Xo
55.Nm zfs
56.Cm upgrade
57.Xc
58Displays a list of file systems that are not the most recent version.
59.It Xo
60.Nm zfs
61.Cm upgrade
62.Fl v
63.Xc
64Displays a list of currently supported file system versions.
65.It Xo
66.Nm zfs
67.Cm upgrade
68.Op Fl r
69.Op Fl V Ar version
70.Fl a Ns | Ns Ar filesystem
71.Xc
72Upgrades file systems to a new on-disk version.
73Once this is done, the file systems will no longer be accessible on systems
74running older versions of ZFS.
75.Nm zfs Cm send
76streams generated from new snapshots of these file systems cannot be accessed on
77systems running older versions of ZFS.
78.Pp
79In general, the file system version is independent of the pool version.
80See
81.Xr zpool-features 7
82for information on features of ZFS storage pools.
83.Pp
84In some cases, the file system version and the pool version are interrelated and
85the pool version must be upgraded before the file system version can be
86upgraded.
87.Bl -tag -width "filesystem"
88.It Fl V Ar version
89Upgrade to
90.Ar version .
91If not specified, upgrade to the most recent version.
92This
93option can only be used to increase the version number, and only up to the most
94recent version supported by this version of ZFS.
95.It Fl a
96Upgrade all file systems on all imported pools.
97.It Ar filesystem
98Upgrade the specified file system.
99.It Fl r
100Upgrade the specified file system and all descendent file systems.
101.El
102.El
103.Sh SEE ALSO
104.Xr zpool-upgrade 8
105