man/man8/zfs-upgrade.8

   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) 2009 Sun Microsystems, Inc. All Rights Reserved.
  22 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  23 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
  24 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
  26 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
  27 .\" Copyright (c) 2014 Integros [integros.com]
  28 .\" Copyright 2019 Richard Laager. All rights reserved.
  29 .\" Copyright 2018 Nexenta Systems, Inc.
  30 .\" Copyright 2019 Joyent, Inc.
  31 .\"
  32 .Dd June 30, 2019
  33 .Dt ZFS-UPGRADE 8
  34 .Os
  35 .
  36 .Sh NAME
  37 .Nm zfs-upgrade
  38 .Nd manage on-disk version of ZFS 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 Ns | Ns Ar filesystem
  50 .
  51 .Sh DESCRIPTION
  52 .Bl -tag -width ""
  53 .It Xo
  54 .Nm zfs
  55 .Cm upgrade
  56 .Xc
  57 Displays a list of file systems that are not the most recent version.
  58 .It Xo
  59 .Nm zfs
  60 .Cm upgrade
  61 .Fl v
  62 .Xc
  63 Displays a list of currently supported file system versions.
  64 .It Xo
  65 .Nm zfs
  66 .Cm upgrade
  67 .Op Fl r
  68 .Op Fl V Ar version
  69 .Fl a Ns | Ns Ar filesystem
  70 .Xc
  71 Upgrades file systems to a new on-disk version.
  72 Once this is done, the file systems will no longer be accessible on systems
  73 running older versions of ZFS.
  74 .Nm zfs Cm send
  75 streams generated from new snapshots of these file systems cannot be accessed on
  76 systems running older versions of ZFS.
  77 .Pp
  78 In general, the file system version is independent of the pool version.
  79 See
  80 .Xr zpool-features 7
  81 for information on features of ZFS storage pools.
  82 .Pp
  83 In some cases, the file system version and the pool version are interrelated and
  84 the pool version must be upgraded before the file system version can be
  85 upgraded.
  86 .Bl -tag -width "filesystem"
  87 .It Fl V Ar version
  88 Upgrade to
  89 .Ar version .
  90 If not specified, upgrade to the most recent version.
  91 This
  92 option can only be used to increase the version number, and only up to the most
  93 recent version supported by this version of ZFS.
  94 .It Fl a
  95 Upgrade all file systems on all imported pools.
  96 .It Ar filesystem
  97 Upgrade the specified file system.
  98 .It Fl r
  99 Upgrade the specified file system and all descendent file systems.
 100 .El
 101 .El
 102 .Sh SEE ALSO
 103 .Xr zpool-upgrade 8