41 .Nm
  42 .Cm attach
  43 .Op Fl f
  44 .Ar pool device new_device
  45 .Nm
  46 .Cm checkpoint
  47 .Op Fl d, -discard
  48 .Ar pool
  49 .Nm
  50 .Cm clear
  51 .Ar pool
  52 .Op Ar device
  53 .Nm
  54 .Cm create
  55 .Op Fl dfn
  56 .Op Fl B
  57 .Op Fl m Ar mountpoint
  58 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
  59 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
  60 .Op Fl R Ar root

  61 .Ar pool vdev Ns ...
  62 .Nm
  63 .Cm destroy
  64 .Op Fl f
  65 .Ar pool
  66 .Nm
  67 .Cm detach
  68 .Ar pool device
  69 .Nm
  70 .Cm export
  71 .Op Fl f
  72 .Ar pool Ns ...
  73 .Nm
  74 .Cm get
  75 .Op Fl Hp
  76 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
  77 .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
  78 .Ar pool Ns ...
  79 .Nm
  80 .Cm history
  81 .Op Fl il
  82 .Oo Ar pool Oc Ns ...
  83 .Nm
  84 .Cm import
  85 .Op Fl D
  86 .Op Fl d Ar dir
  87 .Nm
  88 .Cm import
  89 .Fl a
  90 .Op Fl DfmN
  91 .Op Fl F Op Fl n
  92 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
  93 .Op Fl o Ar mntopts
  94 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
  95 .Op Fl R Ar root
  96 .Nm
  97 .Cm import
  98 .Op Fl Dfm
  99 .Op Fl F Op Fl n
 100 .Op Fl -rewind-to-checkpoint
 101 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
 102 .Op Fl o Ar mntopts
 103 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 104 .Op Fl R Ar root
 105 .Ar pool Ns | Ns Ar id
 106 .Op Ar newpool
 107 .Nm
 108 .Cm initialize
 109 .Op Fl cs
 110 .Ar pool
 111 .Op Ar device Ns ...
 112 .Nm
 113 .Cm iostat
 114 .Op Fl v
 115 .Op Fl T Sy u Ns | Ns Sy d
 116 .Oo Ar pool Oc Ns ...
 117 .Op Ar interval Op Ar count
 118 .Nm

 850 .El
 851 .It Xo
 852 .Nm
 853 .Cm clear
 854 .Ar pool
 855 .Op Ar device
 856 .Xc
 857 Clears device errors in a pool.
 858 If no arguments are specified, all device errors within the pool are cleared.
 859 If one or more devices is specified, only those errors associated with the
 860 specified device or devices are cleared.
 861 .It Xo
 862 .Nm
 863 .Cm create
 864 .Op Fl dfn
 865 .Op Fl B
 866 .Op Fl m Ar mountpoint
 867 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 868 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
 869 .Op Fl R Ar root

 870 .Ar pool vdev Ns ...
 871 .Xc
 872 Creates a new storage pool containing the virtual devices specified on the
 873 command line.
 874 The pool name must begin with a letter, and can only contain
 875 alphanumeric characters as well as underscore
 876 .Pq Qq Sy _ ,
 877 dash
 878 .Pq Qq Sy - ,
 879 and period
 880 .Pq Qq Sy \&. .
 881 The pool names
 882 .Sy mirror ,
 883 .Sy raidz ,
 884 .Sy spare
 885 and
 886 .Sy log
 887 are reserved, as are names beginning with the pattern
 888 .Sy c[0-9] .
 889 The

 971 .It Fl n
 972 Displays the configuration that would be used without actually creating the
 973 pool.
 974 The actual pool creation can still fail due to insufficient privileges or
 975 device sharing.
 976 .It Fl o Ar property Ns = Ns Ar value
 977 Sets the given pool properties.
 978 See the
 979 .Sx Properties
 980 section for a list of valid properties that can be set.
 981 .It Fl O Ar file-system-property Ns = Ns Ar value
 982 Sets the given file system properties in the root file system of the pool.
 983 See the
 984 .Sx Properties
 985 section of
 986 .Xr zfs 1M
 987 for a list of valid properties that can be set.
 988 .It Fl R Ar root
 989 Equivalent to
 990 .Fl o Sy cachefile Ns = Ns Sy none Fl o Sy altroot Ns = Ns Ar root










 991 .El
 992 .It Xo
 993 .Nm
 994 .Cm destroy
 995 .Op Fl f
 996 .Ar pool
 997 .Xc
 998 Destroys the given pool, freeing up any devices for other use.
 999 This command tries to unmount any active datasets before destroying the pool.
1000 .Bl -tag -width Ds
1001 .It Fl f
1002 Forces any active datasets contained within the pool to be unmounted.
1003 .El
1004 .It Xo
1005 .Nm
1006 .Cm detach
1007 .Ar pool device
1008 .Xc
1009 Detaches
1010 .Ar device

1216 .Xr zfs 1M
1217 for a description of dataset properties and mount options.
1218 .It Fl o Ar property Ns = Ns Ar value
1219 Sets the specified property on the imported pool.
1220 See the
1221 .Sx Properties
1222 section for more information on the available pool properties.
1223 .It Fl R Ar root
1224 Sets the
1225 .Sy cachefile
1226 property to
1227 .Sy none
1228 and the
1229 .Sy altroot
1230 property to
1231 .Ar root .
1232 .El
1233 .It Xo
1234 .Nm
1235 .Cm import
1236 .Op Fl Dfm
1237 .Op Fl F Op Fl n
1238 .Op Fl -rewind-to-checkpoint
1239 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
1240 .Op Fl o Ar mntopts
1241 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1242 .Op Fl R Ar root
1243 .Ar pool Ns | Ns Ar id
1244 .Op Ar newpool
1245 .Xc
1246 Imports a specific pool.
1247 A pool can be identified by its name or the numeric identifier.
1248 If
1249 .Ar newpool
1250 is specified, the pool is imported using the name
1251 .Ar newpool .
1252 Otherwise, it is imported with the same name as its exported name.
1253 .Pp
1254 If a device is removed from a system without running
1255 .Nm zpool Cm export
1256 first, the device appears as potentially active.

1307 .It Fl o Ar mntopts
1308 Comma-separated list of mount options to use when mounting datasets within the
1309 pool.
1310 See
1311 .Xr zfs 1M
1312 for a description of dataset properties and mount options.
1313 .It Fl o Ar property Ns = Ns Ar value
1314 Sets the specified property on the imported pool.
1315 See the
1316 .Sx Properties
1317 section for more information on the available pool properties.
1318 .It Fl R Ar root
1319 Sets the
1320 .Sy cachefile
1321 property to
1322 .Sy none
1323 and the
1324 .Sy altroot
1325 property to
1326 .Ar root .














1327 .It Fl -rewind-to-checkpoint
1328 Rewinds pool to the checkpointed state.
1329 Once the pool is imported with this flag there is no way to undo the rewind.
1330 All changes and data that were written after the checkpoint are lost!
1331 The only exception is when the
1332 .Sy readonly
1333 mounting option is enabled.
1334 In this case, the checkpointed state of the pool is opened and an
1335 administrator can see how the pool would look like if they were
1336 to fully rewind.
1337 .El
1338 .It Xo
1339 .Nm
1340 .Cm initialize
1341 .Op Fl cs
1342 .Ar pool
1343 .Op Ar device Ns ...
1344 .Xc
1345 Begins initializing by writing to all unallocated regions on the specified
1346 devices, or all eligible devices in the pool if no individual devices are

  41 .Nm
  42 .Cm attach
  43 .Op Fl f
  44 .Ar pool device new_device
  45 .Nm
  46 .Cm checkpoint
  47 .Op Fl d, -discard
  48 .Ar pool
  49 .Nm
  50 .Cm clear
  51 .Ar pool
  52 .Op Ar device
  53 .Nm
  54 .Cm create
  55 .Op Fl dfn
  56 .Op Fl B
  57 .Op Fl m Ar mountpoint
  58 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
  59 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
  60 .Op Fl R Ar root
  61 .Op Fl t Ar tempname
  62 .Ar pool vdev Ns ...
  63 .Nm
  64 .Cm destroy
  65 .Op Fl f
  66 .Ar pool
  67 .Nm
  68 .Cm detach
  69 .Ar pool device
  70 .Nm
  71 .Cm export
  72 .Op Fl f
  73 .Ar pool Ns ...
  74 .Nm
  75 .Cm get
  76 .Op Fl Hp
  77 .Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
  78 .Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns ...
  79 .Ar pool Ns ...
  80 .Nm
  81 .Cm history
  82 .Op Fl il
  83 .Oo Ar pool Oc Ns ...
  84 .Nm
  85 .Cm import
  86 .Op Fl D
  87 .Op Fl d Ar dir
  88 .Nm
  89 .Cm import
  90 .Fl a
  91 .Op Fl DfmN
  92 .Op Fl F Op Fl n
  93 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
  94 .Op Fl o Ar mntopts
  95 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
  96 .Op Fl R Ar root
  97 .Nm
  98 .Cm import
  99 .Op Fl Dfmt
 100 .Op Fl F Op Fl n
 101 .Op Fl -rewind-to-checkpoint
 102 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
 103 .Op Fl o Ar mntopts
 104 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 105 .Op Fl R Ar root
 106 .Ar pool Ns | Ns Ar id
 107 .Op Ar newpool
 108 .Nm
 109 .Cm initialize
 110 .Op Fl cs
 111 .Ar pool
 112 .Op Ar device Ns ...
 113 .Nm
 114 .Cm iostat
 115 .Op Fl v
 116 .Op Fl T Sy u Ns | Ns Sy d
 117 .Oo Ar pool Oc Ns ...
 118 .Op Ar interval Op Ar count
 119 .Nm

 851 .El
 852 .It Xo
 853 .Nm
 854 .Cm clear
 855 .Ar pool
 856 .Op Ar device
 857 .Xc
 858 Clears device errors in a pool.
 859 If no arguments are specified, all device errors within the pool are cleared.
 860 If one or more devices is specified, only those errors associated with the
 861 specified device or devices are cleared.
 862 .It Xo
 863 .Nm
 864 .Cm create
 865 .Op Fl dfn
 866 .Op Fl B
 867 .Op Fl m Ar mountpoint
 868 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 869 .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
 870 .Op Fl R Ar root
 871 .Op Fl t Ar tempname
 872 .Ar pool vdev Ns ...
 873 .Xc
 874 Creates a new storage pool containing the virtual devices specified on the
 875 command line.
 876 The pool name must begin with a letter, and can only contain
 877 alphanumeric characters as well as underscore
 878 .Pq Qq Sy _ ,
 879 dash
 880 .Pq Qq Sy - ,
 881 and period
 882 .Pq Qq Sy \&. .
 883 The pool names
 884 .Sy mirror ,
 885 .Sy raidz ,
 886 .Sy spare
 887 and
 888 .Sy log
 889 are reserved, as are names beginning with the pattern
 890 .Sy c[0-9] .
 891 The

 973 .It Fl n
 974 Displays the configuration that would be used without actually creating the
 975 pool.
 976 The actual pool creation can still fail due to insufficient privileges or
 977 device sharing.
 978 .It Fl o Ar property Ns = Ns Ar value
 979 Sets the given pool properties.
 980 See the
 981 .Sx Properties
 982 section for a list of valid properties that can be set.
 983 .It Fl O Ar file-system-property Ns = Ns Ar value
 984 Sets the given file system properties in the root file system of the pool.
 985 See the
 986 .Sx Properties
 987 section of
 988 .Xr zfs 1M
 989 for a list of valid properties that can be set.
 990 .It Fl R Ar root
 991 Equivalent to
 992 .Fl o Sy cachefile Ns = Ns Sy none Fl o Sy altroot Ns = Ns Ar root
 993 .It Fl t Ar tempname
 994 Sets the in-core pool name to
 995 .Pa tempname
 996 while the on-disk name will be the name specified as the pool name
 997 .Pa pool .
 998 This will set the default cachefile property to
 999 .Sy none.
1000 This is intended to handle name space collisions when creating pools
1001 for other systems, such as virtual machines or physical machines
1002 whose pools live on network block devices.
1003 .El
1004 .It Xo
1005 .Nm
1006 .Cm destroy
1007 .Op Fl f
1008 .Ar pool
1009 .Xc
1010 Destroys the given pool, freeing up any devices for other use.
1011 This command tries to unmount any active datasets before destroying the pool.
1012 .Bl -tag -width Ds
1013 .It Fl f
1014 Forces any active datasets contained within the pool to be unmounted.
1015 .El
1016 .It Xo
1017 .Nm
1018 .Cm detach
1019 .Ar pool device
1020 .Xc
1021 Detaches
1022 .Ar device

1228 .Xr zfs 1M
1229 for a description of dataset properties and mount options.
1230 .It Fl o Ar property Ns = Ns Ar value
1231 Sets the specified property on the imported pool.
1232 See the
1233 .Sx Properties
1234 section for more information on the available pool properties.
1235 .It Fl R Ar root
1236 Sets the
1237 .Sy cachefile
1238 property to
1239 .Sy none
1240 and the
1241 .Sy altroot
1242 property to
1243 .Ar root .
1244 .El
1245 .It Xo
1246 .Nm
1247 .Cm import
1248 .Op Fl Dfmt
1249 .Op Fl F Op Fl n
1250 .Op Fl -rewind-to-checkpoint
1251 .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
1252 .Op Fl o Ar mntopts
1253 .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1254 .Op Fl R Ar root
1255 .Ar pool Ns | Ns Ar id
1256 .Op Ar newpool
1257 .Xc
1258 Imports a specific pool.
1259 A pool can be identified by its name or the numeric identifier.
1260 If
1261 .Ar newpool
1262 is specified, the pool is imported using the name
1263 .Ar newpool .
1264 Otherwise, it is imported with the same name as its exported name.
1265 .Pp
1266 If a device is removed from a system without running
1267 .Nm zpool Cm export
1268 first, the device appears as potentially active.

1319 .It Fl o Ar mntopts
1320 Comma-separated list of mount options to use when mounting datasets within the
1321 pool.
1322 See
1323 .Xr zfs 1M
1324 for a description of dataset properties and mount options.
1325 .It Fl o Ar property Ns = Ns Ar value
1326 Sets the specified property on the imported pool.
1327 See the
1328 .Sx Properties
1329 section for more information on the available pool properties.
1330 .It Fl R Ar root
1331 Sets the
1332 .Sy cachefile
1333 property to
1334 .Sy none
1335 and the
1336 .Sy altroot
1337 property to
1338 .Ar root .
1339 .It Fl t
1340 Used with
1341 .Ar newpool .
1342 Specifies that
1343 .Ar newpool
1344 is temporary.
1345 Temporary pool names last until export.
1346 Ensures that the original pool name will be used in all label updates and
1347 therefore is retained upon export.
1348 Will also set
1349 .Sy cachefile
1350 property to
1351 .Sy none
1352 when not explicitly specified.
1353 .It Fl -rewind-to-checkpoint
1354 Rewinds pool to the checkpointed state.
1355 Once the pool is imported with this flag there is no way to undo the rewind.
1356 All changes and data that were written after the checkpoint are lost!
1357 The only exception is when the
1358 .Sy readonly
1359 mounting option is enabled.
1360 In this case, the checkpointed state of the pool is opened and an
1361 administrator can see how the pool would look like if they were
1362 to fully rewind.
1363 .El
1364 .It Xo
1365 .Nm
1366 .Cm initialize
1367 .Op Fl cs
1368 .Ar pool
1369 .Op Ar device Ns ...
1370 .Xc
1371 Begins initializing by writing to all unallocated regions on the specified
1372 devices, or all eligible devices in the pool if no individual devices are