xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-upgrade.8 (revision 6be3386466ab79a84b48429ae66244f21526d3df)
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) 2007, Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
24.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
25.\" Copyright (c) 2017 Datto Inc.
26.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
27.\" Copyright 2017 Nexenta Systems, Inc.
28.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
29.\" Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
30.\"
31.Dd August 9, 2019
32.Dt ZPOOL-UPGRADE 8
33.Os
34.Sh NAME
35.Nm zpool-upgrade
36.Nd Manage version and feature flags of ZFS storage pools
37.Sh SYNOPSIS
38.Nm zpool
39.Cm upgrade
40.Nm zpool
41.Cm upgrade
42.Fl v
43.Nm zpool
44.Cm upgrade
45.Op Fl V Ar version
46.Fl a Ns | Ns Ar pool Ns ...
47.Sh DESCRIPTION
48.Bl -tag -width Ds
49.It Xo
50.Nm zpool
51.Cm upgrade
52.Xc
53Displays pools which do not have all supported features enabled and pools
54formatted using a legacy ZFS version number.
55These pools can continue to be used, but some features may not be available.
56Use
57.Nm zpool Cm upgrade Fl a
58to enable all features on all pools. (If a pool has specified compatibility
59feature sets using the
60.Fl o Ar compatibility
61property, only the features present in all requested compatibility sets will
62be enabled on that pool.)
63.It Xo
64.Nm zpool
65.Cm upgrade
66.Fl v
67.Xc
68Displays legacy ZFS versions supported by the current software.
69See
70.Xr zpool-features 5
71for a description of feature flags features supported by the current software.
72.It Xo
73.Nm zpool
74.Cm upgrade
75.Op Fl V Ar version
76.Fl a Ns | Ns Ar pool Ns ...
77.Xc
78Enables all supported features on the given pool. (If the pool has specified
79compatibility feature sets using the
80.Fl o Ar compatibility
81property, only the features present in all requested compatibility sets will be
82enabled.)
83Once this is done, the pool will no longer be accessible on systems that do not
84support feature flags.
85See
86.Xr zpool-features 5
87for details on compatibility with systems that support feature flags, but do not
88support all features enabled on the pool.
89.Bl -tag -width Ds
90.It Fl a
91Enables all supported features (from specified compatibility sets, if any) on all
92pools.
93.It Fl V Ar version
94Upgrade to the specified legacy version.
95If the
96.Fl V
97flag is specified, no features will be enabled on the pool.
98This option can only be used to increase the version number up to the last
99supported legacy version number.
100.El
101.El
102.Sh SEE ALSO
103.Xr zpool-features 5 ,
104.Xr zpoolconcepts 8 ,
105.Xr zpoolprops 8 ,
106.Xr zpool-history 8
107