xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-upgrade.8 (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
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.\"
30.Dd August 9, 2019
31.Dt ZPOOL-UPGRADE 8
32.Os
33.Sh NAME
34.Nm zpool-upgrade
35.Nd Manage version and feature flags of ZFS storage pools
36.Sh SYNOPSIS
37.Nm zpool
38.Cm upgrade
39.Nm zpool
40.Cm upgrade
41.Fl v
42.Nm zpool
43.Cm upgrade
44.Op Fl V Ar version
45.Fl a Ns | Ns Ar pool Ns ...
46.Sh DESCRIPTION
47.Bl -tag -width Ds
48.It Xo
49.Nm zpool
50.Cm upgrade
51.Xc
52Displays pools which do not have all supported features enabled and pools
53formatted using a legacy ZFS version number.
54These pools can continue to be used, but some features may not be available.
55Use
56.Nm zpool Cm upgrade Fl a
57to enable all features on all pools.
58.It Xo
59.Nm zpool
60.Cm upgrade
61.Fl v
62.Xc
63Displays legacy ZFS versions supported by the current software.
64See
65.Xr zpool-features 5
66for a description of feature flags features supported by the current software.
67.It Xo
68.Nm zpool
69.Cm upgrade
70.Op Fl V Ar version
71.Fl a Ns | Ns Ar pool Ns ...
72.Xc
73Enables all supported features on the given pool.
74Once this is done, the pool will no longer be accessible on systems that do not
75support feature flags.
76See
77.Xr zpool-features 5
78for details on compatibility with systems that support feature flags, but do not
79support all features enabled on the pool.
80.Bl -tag -width Ds
81.It Fl a
82Enables all supported features on all pools.
83.It Fl V Ar version
84Upgrade to the specified legacy version.
85If the
86.Fl V
87flag is specified, no features will be enabled on the pool.
88This option can only be used to increase the version number up to the last
89supported legacy version number.
90.El
91.El
92.Sh SEE ALSO
93.Xr zpool-features 5 ,
94.Xr zpoolconcepts 8 ,
95.Xr zpoolprops 8 ,
96.Xr zpool-history 8
97