Print this page
5882 Temporary pool names
Reviewed by: Matt Ahrens <matt@delphix.com>
Reviewed by: Igor Kozhukhov <igor@dilos.org>
Reviewed by: John Kennedy <john.kennedy@delphix.com>
Approved by: Dan McDonald <danmcd@joyent.com>

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man1m/zpool.1m
          +++ new/usr/src/man/man1m/zpool.1m
↓ open down ↓ 50 lines elided ↑ open up ↑
  51   51  .Ar pool
  52   52  .Op Ar device
  53   53  .Nm
  54   54  .Cm create
  55   55  .Op Fl dfn
  56   56  .Op Fl B
  57   57  .Op Fl m Ar mountpoint
  58   58  .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
  59   59  .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
  60   60  .Op Fl R Ar root
       61 +.Op Fl t Ar tempname
  61   62  .Ar pool vdev Ns ...
  62   63  .Nm
  63   64  .Cm destroy
  64   65  .Op Fl f
  65   66  .Ar pool
  66   67  .Nm
  67   68  .Cm detach
  68   69  .Ar pool device
  69   70  .Nm
  70   71  .Cm export
↓ open down ↓ 17 lines elided ↑ open up ↑
  88   89  .Cm import
  89   90  .Fl a
  90   91  .Op Fl DfmN
  91   92  .Op Fl F Op Fl n
  92   93  .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
  93   94  .Op Fl o Ar mntopts
  94   95  .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
  95   96  .Op Fl R Ar root
  96   97  .Nm
  97   98  .Cm import
  98      -.Op Fl Dfm
       99 +.Op Fl Dfmt
  99  100  .Op Fl F Op Fl n
 100  101  .Op Fl -rewind-to-checkpoint
 101  102  .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
 102  103  .Op Fl o Ar mntopts
 103  104  .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 104  105  .Op Fl R Ar root
 105  106  .Ar pool Ns | Ns Ar id
 106  107  .Op Ar newpool
 107  108  .Nm
 108  109  .Cm initialize
↓ open down ↓ 751 lines elided ↑ open up ↑
 860  861  specified device or devices are cleared.
 861  862  .It Xo
 862  863  .Nm
 863  864  .Cm create
 864  865  .Op Fl dfn
 865  866  .Op Fl B
 866  867  .Op Fl m Ar mountpoint
 867  868  .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
 868  869  .Oo Fl O Ar file-system-property Ns = Ns Ar value Oc Ns ...
 869  870  .Op Fl R Ar root
      871 +.Op Fl t Ar tempname
 870  872  .Ar pool vdev Ns ...
 871  873  .Xc
 872  874  Creates a new storage pool containing the virtual devices specified on the
 873  875  command line.
 874  876  The pool name must begin with a letter, and can only contain
 875  877  alphanumeric characters as well as underscore
 876  878  .Pq Qq Sy _ ,
 877  879  dash
 878  880  .Pq Qq Sy - ,
 879  881  and period
↓ open down ↓ 101 lines elided ↑ open up ↑
 981  983  .It Fl O Ar file-system-property Ns = Ns Ar value
 982  984  Sets the given file system properties in the root file system of the pool.
 983  985  See the
 984  986  .Sx Properties
 985  987  section of
 986  988  .Xr zfs 1M
 987  989  for a list of valid properties that can be set.
 988  990  .It Fl R Ar root
 989  991  Equivalent to
 990  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.
 991 1003  .El
 992 1004  .It Xo
 993 1005  .Nm
 994 1006  .Cm destroy
 995 1007  .Op Fl f
 996 1008  .Ar pool
 997 1009  .Xc
 998 1010  Destroys the given pool, freeing up any devices for other use.
 999 1011  This command tries to unmount any active datasets before destroying the pool.
1000 1012  .Bl -tag -width Ds
↓ open down ↓ 225 lines elided ↑ open up ↑
1226 1238  property to
1227 1239  .Sy none
1228 1240  and the
1229 1241  .Sy altroot
1230 1242  property to
1231 1243  .Ar root .
1232 1244  .El
1233 1245  .It Xo
1234 1246  .Nm
1235 1247  .Cm import
1236      -.Op Fl Dfm
     1248 +.Op Fl Dfmt
1237 1249  .Op Fl F Op Fl n
1238 1250  .Op Fl -rewind-to-checkpoint
1239 1251  .Op Fl c Ar cachefile Ns | Ns Fl d Ar dir
1240 1252  .Op Fl o Ar mntopts
1241 1253  .Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
1242 1254  .Op Fl R Ar root
1243 1255  .Ar pool Ns | Ns Ar id
1244 1256  .Op Ar newpool
1245 1257  .Xc
1246 1258  Imports a specific pool.
↓ open down ↓ 70 lines elided ↑ open up ↑
1317 1329  section for more information on the available pool properties.
1318 1330  .It Fl R Ar root
1319 1331  Sets the
1320 1332  .Sy cachefile
1321 1333  property to
1322 1334  .Sy none
1323 1335  and the
1324 1336  .Sy altroot
1325 1337  property to
1326 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.
1327 1353  .It Fl -rewind-to-checkpoint
1328 1354  Rewinds pool to the checkpointed state.
1329 1355  Once the pool is imported with this flag there is no way to undo the rewind.
1330 1356  All changes and data that were written after the checkpoint are lost!
1331 1357  The only exception is when the
1332 1358  .Sy readonly
1333 1359  mounting option is enabled.
1334 1360  In this case, the checkpointed state of the pool is opened and an
1335 1361  administrator can see how the pool would look like if they were
1336 1362  to fully rewind.
↓ open down ↓ 664 lines elided ↑ open up ↑
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX