xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-upgrade.8 (revision 25ecdc7d52770caf1c9b44b5ec11f468f6b636f3)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or http://www.opensolaris.org/os/licensing.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
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.Sh NAME
37.Nm zfs-upgrade
38.Nd Manage upgrading the on-disk version of filesystems.
39.Sh SYNOPSIS
40.Nm zfs
41.Cm upgrade
42.Nm zfs
43.Cm upgrade
44.Fl v
45.Nm zfs
46.Cm upgrade
47.Op Fl r
48.Op Fl V Ar version
49.Fl a | Ar filesystem
50.Sh DESCRIPTION
51.Bl -tag -width ""
52.It Xo
53.Nm zfs
54.Cm upgrade
55.Xc
56Displays a list of file systems that are not the most recent version.
57.It Xo
58.Nm zfs
59.Cm upgrade
60.Fl v
61.Xc
62Displays a list of currently supported file system versions.
63.It Xo
64.Nm zfs
65.Cm upgrade
66.Op Fl r
67.Op Fl V Ar version
68.Fl a | Ar filesystem
69.Xc
70Upgrades file systems to a new on-disk version.
71Once this is done, the file systems will no longer be accessible on systems
72running older versions of the software.
73.Nm zfs Cm send
74streams generated from new snapshots of these file systems cannot be accessed on
75systems running older versions of the software.
76.Pp
77In general, the file system version is independent of the pool version.
78See
79.Xr zpool 8
80for information on the
81.Nm zpool Cm upgrade
82command.
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 "-V"
88.It Fl V Ar version
89Upgrade to the specified
90.Ar version .
91If the
92.Fl V
93flag is not specified, this command upgrades to the most recent version.
94This
95option can only be used to increase the version number, and only up to the most
96recent version supported by this software.
97.It Fl a
98Upgrade all file systems on all imported pools.
99.It Ar filesystem
100Upgrade the specified file system.
101.It Fl r
102Upgrade the specified file system and all descendent file systems.
103.El
104.El
105.Sh SEE ALSO
106.Xr zpool-upgrade 8
107