| zfs.8 (228055) | zfs.8 (228103) |
|---|---|
| 1'\" te 2.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>. 3.\" All Rights Reserved. 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.\" --- 8 unchanged lines hidden (view full) --- 17.\" fields enclosed by brackets "[]" replaced with your own identifying 18.\" information: Portions Copyright [yyyy] [name of copyright owner] 19.\" 20.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved. 21.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. 22.\" Copyright (c) 2011 by Delphix. All rights reserved. 23.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org> 24.\" | 1'\" te 2.\" Copyright (c) 2011, Martin Matuska <mm@FreeBSD.org>. 3.\" All Rights Reserved. 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.\" --- 8 unchanged lines hidden (view full) --- 17.\" fields enclosed by brackets "[]" replaced with your own identifying 18.\" information: Portions Copyright [yyyy] [name of copyright owner] 19.\" 20.\" Copyright (c) 2010, Sun Microsystems, Inc. All Rights Reserved. 21.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. 22.\" Copyright (c) 2011 by Delphix. All rights reserved. 23.\" Copyright (c) 2011, Pawel Jakub Dawidek <pjd@FreeBSD.org> 24.\" |
| 25.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 228055 2011-11-28 09:33:13Z mm $ | 25.\" $FreeBSD: head/cddl/contrib/opensolaris/cmd/zfs/zfs.8 228103 2011-11-28 21:40:00Z mm $ |
| 26.\" 27.Dd November 26, 2011 28.Dt ZFS 8 29.Os 30.Sh NAME 31.Nm zfs 32.Nd configures ZFS file systems 33.Sh SYNOPSIS --- 9 unchanged lines hidden (view full) --- 43.Op Fl ps 44.Op Fl b Ar blocksize 45.Op Fl o Ar property Ns = Ns Ar value 46.Ar ... 47.Fl V 48.Ar size volume 49.Nm 50.Cm destroy | 26.\" 27.Dd November 26, 2011 28.Dt ZFS 8 29.Os 30.Sh NAME 31.Nm zfs 32.Nd configures ZFS file systems 33.Sh SYNOPSIS --- 9 unchanged lines hidden (view full) --- 43.Op Fl ps 44.Op Fl b Ar blocksize 45.Op Fl o Ar property Ns = Ns Ar value 46.Ar ... 47.Fl V 48.Ar size volume 49.Nm 50.Cm destroy |
| 51.Op Fl rRf | 51.Op Fl fnpRrv |
| 52.Ar filesystem Ns | Ns Ar volume 53.Nm 54.Cm destroy | 52.Ar filesystem Ns | Ns Ar volume 53.Nm 54.Cm destroy |
| 55.Op Fl rRd | 55.Op Fl dnpRrv 56.Sm off |
| 56.Ar snapshot | 57.Ar snapshot |
| 58.Ns Op % Ns Ar snapname 59.Ns Op , Ns Ar ... 60.Sm on |
|
| 57.Nm 58.Cm snapshot 59.Op Fl r 60.Op Fl o Ar property Ns = Ns Ar value 61.Ar ... filesystem@snapname Ns | Ns Ar volume@snapname 62.Nm 63.Cm rollback 64.Op Fl rRf --- 90 unchanged lines hidden (view full) --- 155.Nm 156.Cm share 157.Fl a | Ar filesystem 158.Nm 159.Cm unshare 160.Fl a | Ar filesystem Ns | Ns Ar mountpoint 161.Nm 162.Cm send | 61.Nm 62.Cm snapshot 63.Op Fl r 64.Op Fl o Ar property Ns = Ns Ar value 65.Ar ... filesystem@snapname Ns | Ns Ar volume@snapname 66.Nm 67.Cm rollback 68.Op Fl rRf --- 90 unchanged lines hidden (view full) --- 159.Nm 160.Cm share 161.Fl a | Ar filesystem 162.Nm 163.Cm unshare 164.Fl a | Ar filesystem Ns | Ns Ar mountpoint 165.Nm 166.Cm send |
| 163.Op Fl DvRp | 167.Op Fl DnPpRrv |
| 164.Op Fl i Ar snapshot | Fl I Ar snapshot 165.Ar snapshot 166.Nm 167.Cm receive 168.Op Fl vnFu 169.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 170.Nm 171.Cm receive --- 310 unchanged lines hidden (view full) --- 482is the same as the 483.Sy refcompressratio 484property. Compression can be turned on by running: 485.Qq Nm Cm set compression=on Ar dataset 486The default value is 487.Cm off . 488.It Sy creation 489The time this dataset was created. | 168.Op Fl i Ar snapshot | Fl I Ar snapshot 169.Ar snapshot 170.Nm 171.Cm receive 172.Op Fl vnFu 173.Ar filesystem Ns | Ns Ar volume Ns | Ns Ar snapshot 174.Nm 175.Cm receive --- 310 unchanged lines hidden (view full) --- 486is the same as the 487.Sy refcompressratio 488property. Compression can be turned on by running: 489.Qq Nm Cm set compression=on Ar dataset 490The default value is 491.Cm off . 492.It Sy creation 493The time this dataset was created. |
| 494.It Sy clones 495For snapshots, this property is a comma-separated list of filesystems or 496volumes which are clones of this snapshot. The clones' 497.Sy origin 498property is this snapshot. If the 499.Sy clones 500property is not empty, then this snapshot can not be destroyed (even with the 501.Fl r 502or 503.Fl f 504options). |
|
| 490.It Sy defer_destroy 491This property is 492.Cm on 493if the snapshot has been marked for deferred destroy by using the 494.Qq Nm Cm destroy -d 495command. Otherwise, the property is 496.Cm off . 497.It Sy mounted --- 141 unchanged lines hidden (view full) --- 639cannot be changed once the volume has been written, so it should be set at 640volume creation time. The default 641.Ar blocksize 642for volumes is 8 Kbytes. Any 643power of 2 from 512 bytes to 128 Kbytes is valid. 644.Pp 645This property can also be referred to by its shortened column name, 646.Sy volblock . | 505.It Sy defer_destroy 506This property is 507.Cm on 508if the snapshot has been marked for deferred destroy by using the 509.Qq Nm Cm destroy -d 510command. Otherwise, the property is 511.Cm off . 512.It Sy mounted --- 141 unchanged lines hidden (view full) --- 654cannot be changed once the volume has been written, so it should be set at 655volume creation time. The default 656.Ar blocksize 657for volumes is 8 Kbytes. Any 658power of 2 from 512 bytes to 128 Kbytes is valid. 659.Pp 660This property can also be referred to by its shortened column name, 661.Sy volblock . |
| 662.It Sy written 663The amount of 664.Sy referenced 665space written to this dataset since the previous snapshot. 666.It Sy written@ Ns Ar snapshot 667The amount of 668.Sy referenced 669space written to this dataset since the specified snapshot. This is the space 670that is referenced by this dataset but was not referenced by the specified 671snapshot. 672.Pp 673The 674.Ar snapshot 675may be specified as a short snapshot name (just the part after the 676.Sy @ Ns ), 677in which case it will be interpreted as a snapshot in the same filesystem as 678this dataset. The 679.Ar snapshot 680may be a full snapshot name 681.Pq Em filesystem@snapshot , 682which for clones may be a snapshot in the origin's filesystem (or the origin of 683the origin's filesystem, etc). |
|
| 647.El 648.Pp 649The following native properties can be used to change the behavior of a 650.Tn ZFS 651dataset. 652.Bl -tag -width 2n 653.It Xo 654.Sy aclinherit Ns = Ns Cm discard | --- 743 unchanged lines hidden (view full) --- 1398options can be specified. An error results if the same property is specified in 1399multiple 1400.Fl o 1401options. 1402.El 1403.It Xo 1404.Nm 1405.Cm destroy | 684.El 685.Pp 686The following native properties can be used to change the behavior of a 687.Tn ZFS 688dataset. 689.Bl -tag -width 2n 690.It Xo 691.Sy aclinherit Ns = Ns Cm discard | --- 743 unchanged lines hidden (view full) --- 1435options can be specified. An error results if the same property is specified in 1436multiple 1437.Fl o 1438options. 1439.El 1440.It Xo 1441.Nm 1442.Cm destroy |
| 1406.Op Fl rRf | 1443.Op Fl fnpRrv |
| 1407.Ar filesystem Ns | Ns Ar volume 1408.Xc 1409.Pp 1410Destroys the given dataset. By default, the command unshares any file systems 1411that are currently shared, unmounts any file systems that are currently 1412mounted, and refuses to destroy a dataset that has active dependents (children 1413or clones). 1414.Bl -tag -width indent 1415.It Fl r 1416Recursively destroy all children. 1417.It Fl R 1418Recursively destroy all dependents, including cloned file systems outside the 1419target hierarchy. 1420.It Fl f 1421Force an unmount of any file systems using the 1422.Qq Nm Cm unmount Fl f 1423command. This option has no effect on non-file systems or unmounted file 1424systems. | 1444.Ar filesystem Ns | Ns Ar volume 1445.Xc 1446.Pp 1447Destroys the given dataset. By default, the command unshares any file systems 1448that are currently shared, unmounts any file systems that are currently 1449mounted, and refuses to destroy a dataset that has active dependents (children 1450or clones). 1451.Bl -tag -width indent 1452.It Fl r 1453Recursively destroy all children. 1454.It Fl R 1455Recursively destroy all dependents, including cloned file systems outside the 1456target hierarchy. 1457.It Fl f 1458Force an unmount of any file systems using the 1459.Qq Nm Cm unmount Fl f 1460command. This option has no effect on non-file systems or unmounted file 1461systems. |
| 1462.It Fl n 1463Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in 1464conjunction with the 1465.Fl v 1466or 1467.Fl p 1468flags to determine what data would be deleted. 1469.It Fl p 1470Print machine-parsable verbose information about the deleted data. 1471.It Fl v 1472Print verbose information about the deleted data. |
|
| 1425.El 1426.Pp 1427Extreme care should be taken when applying either the 1428.Fl r 1429or the 1430.Fl R 1431options, as they can destroy large portions of a pool and cause unexpected 1432behavior for mounted file systems in use. 1433.It Xo 1434.Nm 1435.Cm destroy | 1473.El 1474.Pp 1475Extreme care should be taken when applying either the 1476.Fl r 1477or the 1478.Fl R 1479options, as they can destroy large portions of a pool and cause unexpected 1480behavior for mounted file systems in use. 1481.It Xo 1482.Nm 1483.Cm destroy |
| 1436.Op Fl rRd | 1484.Op Fl dnpRrv 1485.Sm off |
| 1437.Ar snapshot | 1486.Ar snapshot |
| 1487.Ns Op % Ns Ar snapname 1488.Ns Op , Ns Ar ... 1489.Sm on |
|
| 1438.Xc 1439.Pp | 1490.Xc 1491.Pp |
| 1440The given snapshot is destroyed immediately if and only if the | 1492The given snapshots are destroyed immediately if and only if the |
| 1441.Qq Nm Cm destroy 1442command without the 1443.Fl d 1444option would have destroyed it. Such immediate destruction would occur, for 1445example, if the snapshot had no clones and the user-initiated reference count 1446were zero. 1447.Pp | 1493.Qq Nm Cm destroy 1494command without the 1495.Fl d 1496option would have destroyed it. Such immediate destruction would occur, for 1497example, if the snapshot had no clones and the user-initiated reference count 1498were zero. 1499.Pp |
| 1448If the snapshot does not qualify for immediate destruction, it is marked for | 1500If a snapshot does not qualify for immediate destruction, it is marked for |
| 1449deferred deletion. In this state, it exists as a usable, visible snapshot until 1450both of the preconditions listed above are met, at which point it is destroyed. | 1501deferred deletion. In this state, it exists as a usable, visible snapshot until 1502both of the preconditions listed above are met, at which point it is destroyed. |
| 1503.Pp 1504An inclusive range of snapshots may be specified by separating the 1505first and last snapshots with a percent sign 1506.Pq Sy % . 1507The first and/or last snapshots may be left blank, in which case the 1508filesystem's oldest or newest snapshot will be implied. 1509.Pp 1510Multiple snapshots 1511(or ranges of snapshots) of the same filesystem or volume may be specified 1512in a comma-separated list of snapshots. 1513Only the snapshot's short name (the 1514part after the 1515.Sy @ ) 1516should be specified when using a range or comma-separated list to identify 1517multiple snapshots. |
|
| 1451.Bl -tag -width indent 1452.It Fl r 1453Destroy (or mark for deferred deletion) all snapshots with this name in 1454descendent file systems. 1455.It Fl R 1456Recursively destroy all dependents. | 1518.Bl -tag -width indent 1519.It Fl r 1520Destroy (or mark for deferred deletion) all snapshots with this name in 1521descendent file systems. 1522.It Fl R 1523Recursively destroy all dependents. |
| 1524.It Fl n 1525Do a dry-run ("No-op") deletion. No data will be deleted. This is useful in 1526conjunction with the 1527.Fl v 1528or 1529.Fl p 1530flags to determine what data would be deleted. 1531.It Fl p 1532Print machine-parsable verbose information about the deleted data. 1533.It Fl v 1534Print verbose information about the deleted data. |
|
| 1457.It Fl d 1458Defer snapshot deletion. 1459.El 1460.Pp 1461Extreme care should be taken when applying either the 1462.Fl r 1463or the 1464.Fl R --- 610 unchanged lines hidden (view full) --- 2075.It Ar filesystem | mountpoint 2076Unshare the specified filesystem. The command can also be given a path to a 2077.Tn ZFS 2078file system shared on the system. 2079.El 2080.It Xo 2081.Nm 2082.Cm send | 1535.It Fl d 1536Defer snapshot deletion. 1537.El 1538.Pp 1539Extreme care should be taken when applying either the 1540.Fl r 1541or the 1542.Fl R --- 610 unchanged lines hidden (view full) --- 2153.It Ar filesystem | mountpoint 2154Unshare the specified filesystem. The command can also be given a path to a 2155.Tn ZFS 2156file system shared on the system. 2157.El 2158.It Xo 2159.Nm 2160.Cm send |
| 2083.Op Fl DvRp | 2161.Op Fl DnPpRrv |
| 2084.Op Fl i Ar snapshot | Fl I Ar snapshot 2085.Ar snapshot 2086.Xc 2087.Pp 2088Creates a stream representation of the last 2089.Ar snapshot 2090argument (not part of 2091.Fl i --- 54 unchanged lines hidden (view full) --- 2146Generate a deduplicated stream. Blocks which would have been sent multiple 2147times in the send stream will only be sent once. The receiving system must 2148also support this feature to recieve a deduplicated stream. This flag can 2149be used regardless of the dataset's 2150.Sy dedup 2151property, but performance will be much better if the filesystem uses a 2152dedup-capable checksum (eg. 2153.Sy sha256 Ns ). | 2162.Op Fl i Ar snapshot | Fl I Ar snapshot 2163.Ar snapshot 2164.Xc 2165.Pp 2166Creates a stream representation of the last 2167.Ar snapshot 2168argument (not part of 2169.Fl i --- 54 unchanged lines hidden (view full) --- 2224Generate a deduplicated stream. Blocks which would have been sent multiple 2225times in the send stream will only be sent once. The receiving system must 2226also support this feature to recieve a deduplicated stream. This flag can 2227be used regardless of the dataset's 2228.Sy dedup 2229property, but performance will be much better if the filesystem uses a 2230dedup-capable checksum (eg. 2231.Sy sha256 Ns ). |
| 2232.It Fl r 2233Recursively send all descendant snapshots. This is similar to the 2234.Fl R 2235flag, but information about deleted and renamed datasets is not included, and 2236property information is only included if the 2237.Fl p 2238flag is specified. |
|
| 2154.It Fl p 2155Include the dataset's properties in the stream. This flag is implicit when 2156.Fl R 2157is specified. The receiving system must also support this feature. | 2239.It Fl p 2240Include the dataset's properties in the stream. This flag is implicit when 2241.Fl R 2242is specified. The receiving system must also support this feature. |
| 2243.It Fl n 2244Do a dry-run ("No-op") send. Do not generate any actual send data. This is 2245useful in conjunction with the 2246.Fl v 2247or 2248.Fl P 2249flags to determine what data will be sent. 2250.It Fl P 2251Print machine-parsable verbose information about the stream package generated. |
|
| 2158.It Fl v 2159Print verbose information about the stream package generated. 2160.El 2161.Pp 2162The format of the stream is committed. You will be able to receive your streams 2163on future versions of 2164.Tn ZFS . 2165.It Xo --- 921 unchanged lines hidden --- | 2252.It Fl v 2253Print verbose information about the stream package generated. 2254.El 2255.Pp 2256The format of the stream is committed. You will be able to receive your streams 2257on future versions of 2258.Tn ZFS . 2259.It Xo --- 921 unchanged lines hidden --- |