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) 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 March 16, 2022 32.Dt ZPOOL-UPGRADE 8 33.Os 34. 35.Sh NAME 36.Nm zpool-upgrade 37.Nd manage version and feature flags of ZFS storage pools 38.Sh SYNOPSIS 39.Nm zpool 40.Cm upgrade 41.Nm zpool 42.Cm upgrade 43.Fl v 44.Nm zpool 45.Cm upgrade 46.Op Fl V Ar version 47.Fl a Ns | Ns Ar pool Ns … 48. 49.Sh DESCRIPTION 50.Bl -tag -width Ds 51.It Xo 52.Nm zpool 53.Cm upgrade 54.Xc 55Displays pools which do not have all supported features enabled and pools 56formatted using a legacy ZFS version number. 57These pools can continue to be used, but some features may not be available. 58Use 59.Nm zpool Cm upgrade Fl a 60to enable all features on all pools (subject to the 61.Fl o Sy compatibility 62property). 63.It Xo 64.Nm zpool 65.Cm upgrade 66.Fl v 67.Xc 68Displays legacy ZFS versions supported by the this version of ZFS. 69See 70.Xr zpool-features 7 71for a description of feature flags features supported by this version of ZFS. 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. 79.Pp 80If the pool has specified compatibility feature sets using the 81.Fl o Sy compatibility 82property, only the features present in all requested compatibility sets will be 83enabled. 84If this property is set to 85.Ar legacy 86then no upgrade will take place. 87.Pp 88Once this is done, the pool will no longer be accessible on systems that do not 89support feature flags. 90See 91.Xr zpool-features 7 92for details on compatibility with systems that support feature flags, but do not 93support all features enabled on the pool. 94.Bl -tag -width Ds 95.It Fl a 96Enables all supported features (from specified compatibility sets, if any) on 97all 98pools. 99.It Fl V Ar version 100Upgrade to the specified legacy version. 101If specified, no features will be enabled on the pool. 102This option can only be used to increase the version number up to the last 103supported legacy version number. 104.El 105.El 106. 107.Sh EXAMPLES 108.\" These are, respectively, examples 10 from zpool.8 109.\" Make sure to update them bidirectionally 110.Ss Example 1 : No Upgrading All ZFS Storage Pools to the Current Version 111The following command upgrades all ZFS Storage pools to the current version of 112the software: 113.Bd -literal -compact -offset Ds 114.No # Nm zpool Cm upgrade Fl a 115This system is currently running ZFS version 2. 116.Ed 117. 118.Sh SEE ALSO 119.Xr zpool-features 7 , 120.Xr zpoolconcepts 7 , 121.Xr zpoolprops 7 , 122.Xr zpool-history 8 123