| blob | 1c87630b5e6c4d62a1b849fc51b55e9cbc261b0e |
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 https://opensource.org/licenses/CDDL-1.0.
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 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23 .\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24 .\" Copyright (c) 2017 Datto Inc.
25 .\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26 .\" Copyright 2017 Nexenta Systems, Inc.
27 .\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28 .\" Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
29 .\"
30 .Dd March 16, 2022
31 .Dt ZPOOL-UPGRADE 8
32 .Os
33 .
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 .
48 .Sh DESCRIPTION
49 .Bl -tag -width Ds
50 .It Xo
51 .Nm zpool
52 .Cm upgrade
53 .Xc
54 Displays pools which do not have all supported features enabled and pools
55 formatted using a legacy ZFS version number.
56 These pools can continue to be used, but some features may not be available.
57 Use
58 .Nm zpool Cm upgrade Fl a
59 to enable all features on all pools (subject to the
60 .Fl o Sy compatibility
61 property).
62 .It Xo
63 .Nm zpool
64 .Cm upgrade
65 .Fl v
66 .Xc
67 Displays legacy ZFS versions supported by the this version of ZFS.
68 See
69 .Xr zpool-features 7
70 for a description of feature flags features supported by this version of ZFS.
71 .It Xo
72 .Nm zpool
73 .Cm upgrade
74 .Op Fl V Ar version
75 .Fl a Ns | Ns Ar pool Ns …
76 .Xc
77 Enables all supported features on the given pool.
78 .Pp
79 If the pool has specified compatibility feature sets using the
80 .Fl o Sy compatibility
81 property, only the features present in all requested compatibility sets will be
82 enabled.
83 If this property is set to
84 .Ar legacy
85 then no upgrade will take place.
86 .Pp
87 Once this is done, the pool will no longer be accessible on systems that do not
88 support feature flags.
89 See
90 .Xr zpool-features 7
91 for details on compatibility with systems that support feature flags, but do not
92 support all features enabled on the pool.
93 .Bl -tag -width Ds
94 .It Fl a
95 Enables all supported features (from specified compatibility sets, if any) on
96 all
97 pools.
98 .It Fl V Ar version
99 Upgrade to the specified legacy version.
100 If specified, no features will be enabled on the pool.
101 This option can only be used to increase the version number up to the last
102 supported legacy version number.
103 .El
104 .El
105 .
106 .Sh EXAMPLES
107 .\" These are, respectively, examples 10 from zpool.8
108 .\" Make sure to update them bidirectionally
109 .Ss Example 1 : No Upgrading All ZFS Storage Pools to the Current Version
110 The following command upgrades all ZFS Storage pools to the current version of
111 the software:
112 .Bd -literal -compact -offset Ds
113 .No # Nm zpool Cm upgrade Fl a
114 This system is currently running ZFS version 2.
115 .Ed
116 .
117 .Sh SEE ALSO
118 .Xr zpool-features 7 ,
119 .Xr zpoolconcepts 7 ,
120 .Xr zpoolprops 7 ,
121 .Xr zpool-history 8