ZFS Administration Guide

https://illumos.org/books/zfs-admin/
Admin
The ZFS Administration Guide provides comprehensive information about setting up, managing, and...
Tokens:59,681
Snippets:641
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### ZFS Pool Configuration Examples

Source: https://illumos.org/books/zfs-admin/gavwg.html

Examples of ZFS pool configurations showing various states of redundancy and device health.

```text
mirror            DEGRADED
    c1t0d0             ONLINE
    c1t1d0             FAULTED
```

```text
raidz             FAULTED
    c1t0d0             ONLINE
    c2t0d0             FAULTED
    c3t0d0             FAULTED
    c3t0d0             ONLINE
```

```text
c1t0d0         ONLINE
c1t1d0         ONLINE
```

--------------------------------

### Configure Mirrored Storage Pools

Source: https://illumos.org/books/zfs-admin/gavwn.html

Conceptual examples of simple and complex mirrored storage pool configurations.

```text
mirror c1t0d0 c2t0d0
```

```text
mirror c1t0d0 c2t0d0 c3t0d0 mirror c4t0d0 c5t0d0 c6t0d0
```

--------------------------------

### Set and Display ZFS Reservations

Source: https://illumos.org/books/zfs-admin/gavwq.html

Use zfs set to define a reservation and zfs get to verify the current setting.

```bash
# `zfs set reservation=5G tank/home/moore`
# `zfs get reservation tank/home/moore`
NAME             PROPERTY      VALUE                      SOURCE
tank/home/moore  reservation   5.00G                      local
```

--------------------------------

### Set and Display ZFS Quotas

Source: https://illumos.org/books/zfs-admin/gavwq.html

Use zfs set to define a quota and zfs get to verify the configuration.

```bash
# `zfs set quota=10G tank/home/bonwick`
# `zfs get quota tank/home/bonwick`
NAME              PROPERTY      VALUE                      SOURCE
tank/home/bonwick quota         10.0G                      local
```

--------------------------------

### Example /etc/vfstab entry for a legacy ZFS file system

Source: https://illumos.org/books/zfs-admin/gavwq.html

Required entry format in /etc/vfstab to ensure a legacy ZFS file system mounts automatically at boot.

```text
#device         device        mount           FS      fsck    mount   mount
#to mount       to fsck       point           type    pass    at boot options
#

tank/home/eschrock -		/mnt		   zfs		-		yes		-
```

--------------------------------

### Displaying a ZFS-formatted disk partition table

Source: https://illumos.org/books/zfs-admin/gavwn.html

Example output of the format command showing an EFI label applied by ZFS to a whole disk.

```text
Current partition table (original):
Total disk sectors available: 71670953 + 16384 (reserved sectors)

Part      Tag    Flag     First Sector        Size        Last Sector
  0        usr    wm                34      34.18GB         71670953    
  1 unassigned    wm                 0          0              0    
  2 unassigned    wm                 0          0              0    
  3 unassigned    wm                 0          0              0    
  4 unassigned    wm                 0          0              0    
  5 unassigned    wm                 0          0              0    
  6 unassigned    wm                 0          0              0    
  7 unassigned    wm                 0          0              0    
  8   reserved    wm          71670954       8.00MB         71687337
```

--------------------------------

### Detecting In-Use Devices During ZFS Pool Creation

Source: https://illumos.org/books/zfs-admin/gavwn.html

Example output showing errors when attempting to create a ZFS pool on devices already in use by the system.

```bash
# `zpool create tank c1t0d0 c1t1d0`
invalid vdev specification
use '-f' to override the following errors:
/dev/dsk/c1t0d0s0 is currently mounted on /. Please see umount(1M).
/dev/dsk/c1t0d0s1 is currently mounted on swap. Please see swap(1M).
/dev/dsk/c1t1d0s0 is part of active ZFS pool zeepool. Please see zpool(1M).
```

--------------------------------

### Configure RAID-Z Storage Pools

Source: https://illumos.org/books/zfs-admin/gavwn.html

Conceptual examples of standard and complex RAID-Z storage pool configurations.

```text
raidz c1t0d0 c2t0d0 c3t0d0
```

```text
raidz c1t0d0 c2t0d0 c3t0d0 c4t0d0 c5t0d0 c6t0d0 c7t0d0 raidz c8t0d0 c9t0d0 c10t0d0 c11t0d0
c12t0d0 c13t0d0 c14t0d0
```

--------------------------------

### Manage ZFS Web Server Services

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Commands to start, enable, and configure network services for the ZFS web-based management console.

```bash
# /usr/sbin/smcwebserver start
```

```bash
# /usr/sbin/smcwebserver enable
```

```bash
# `netservices open`
```

--------------------------------

### Verify Multiple Reservation Properties

Source: https://illumos.org/books/zfs-admin/gavwq.html

Use zfs get to display both reservation and refreservation values simultaneously.

```bash
# `zfs get reservation,refreserv profs/prof1`
NAME         PROPERTY        VALUE        SOURCE
profs/prof1  reservation     20G          local
profs/prof1  refreservation  10G          local
```

--------------------------------

### Handling Mismatched Replication Levels

Source: https://illumos.org/books/zfs-admin/gavwn.html

Examples of errors triggered when attempting to create pools with inconsistent redundancy levels.

```bash
# `zpool create tank c1t0d0 mirror c2t0d0 c3t0d0`
invalid vdev specification
use '-f' to override the following errors:
mismatched replication level: both disk and mirror vdevs are present
# `zpool create tank mirror c1t0d0 c2t0d0 mirror c3t0d0 c4t0d0 c5t0d0`
invalid vdev specification
use '-f' to override the following errors:
mismatched replication level: 2-way mirror and 3-way mirror vdevs are present
```

--------------------------------

### Create ZFS file systems as a delegated user

Source: https://illumos.org/books/zfs-admin/gbchv.html

Demonstrates how a user with delegated permissions can create a file system, while a user without permissions receives a denied error.

```bash
# su marks
marks$ zfs create tank/marks
marks$ ^D
# su lp
$ zfs create tank/lp
cannot create 'tank/lp': permission denied
```

--------------------------------

### Modify and Verify ACLs

Source: https://illumos.org/books/zfs-admin/acls.html

Example of updating group permissions and verifying the changes with ls -v.

```shell
# `chmod A2=group@:append_data/execute:deny file.1`
# `chmod A3=group@:read_data/write_data:allow file.1`
# `ls -v file.1`
-rw-rw-r--   1 root     root           206663 May  3 16:36 file.1
     0:owner@:execute:deny
     1:owner@:read_data/write_data/append_data/write_xattr/write_attributes
         /write_acl/write_owner:allow
     2:group@:append_data/execute:deny
     3:group@:read_data/write_data:allow
     4:everyone@:write_data/append_data/write_xattr/execute/write_attributes
         /write_acl/write_owner:deny
     5:everyone@:read_data/read_xattr/read_attributes/read_acl/synchronize
         :allow
```

--------------------------------

### Promote a ZFS clone

Source: https://illumos.org/books/zfs-admin/snapshots.html

Demonstrates creating a clone, promoting it, and verifying the change with zfs list.

```bash
# `zfs create tank/test`
# `zfs create tank/test/productA`
# `zfs snapshot tank/test/productA@today`
# `zfs clone tank/test/productA@today tank/test/productAbeta`
# `zfs list -r tank/test`
NAME                   USED  AVAIL  REFER  MOUNTPOINT
tank/test              314K  8.24G  25.5K  /tank/test
tank/test/productA     288K  8.24G   288K  /tank/test/productA
tank/test/productA@today      0      -   288K  -
tank/test/productAbeta      0  8.24G   288K  /tank/test/productAbeta
# `zfs promote tank/test/productAbeta`
# `zfs list -r tank/test`
NAME                   USED  AVAIL  REFER  MOUNTPOINT
tank/test              316K  8.24G  27.5K  /tank/test
tank/test/productA        0  8.24G   288K  /tank/test/productA
tank/test/productAbeta   288K  8.24G   288K  /tank/test/productAbeta
tank/test/productAbeta@today      0      -   288K  -
```

--------------------------------

### Set ZFS Properties During Creation

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Demonstrates setting properties individually versus using the -o flag during file system creation.

```shell
# `zfs create tank/home`
# `zfs set mountpoint=/export/zfs tank/home`
# `zfs set sharenfs=on tank/home`
# `zfs set compression=on tank/home`
```

```shell
# `zfs create -o mountpoint=/export/zfs -o sharenfs=on -o compression=on tank/home`
```

--------------------------------

### Create and verify an automatically managed ZFS dataset

Source: https://illumos.org/books/zfs-admin/gavwq.html

Demonstrates creating a dataset and checking its default mount point and mount status.

```bash
# `zfs create pool/filesystem`
# `zfs get mountpoint pool/filesystem`
NAME             PROPERTY      VALUE                      SOURCE
pool/filesystem  mountpoint    /pool/filesystem           default
# `zfs get mounted pool/filesystem`
NAME             PROPERTY      VALUE                      SOURCE
pool/filesystem  mounted       yes                        -
```

--------------------------------

### View ZFS fault message

Source: https://illumos.org/books/zfs-admin/gavwg.html

Example of a fault message generated by fmd after a ZFS device failure.

```text
SUNW-MSG-ID: ZFS-8000-D3, TYPE: Fault, VER: 1, SEVERITY: Major
EVENT-TIME: Thu Aug 31 11:40:59 MDT 2006
PLATFORM: SUNW,Sun-Blade-1000, CSN: -, HOSTNAME: tank
SOURCE: zfs-diagnosis, REV: 1.0
EVENT-ID: e11d8245-d76a-e152-80c6-e63763ed7e4e
DESC: A ZFS device failed.  Refer to http://illumos.org/msg/ZFS-8000-D3 for more information.
AUTO-RESPONSE: No automated response will occur.
IMPACT: Fault tolerance of the pool may be compromised.
REC-ACTION: Run 'zpool status -x' and replace the bad device.
```

--------------------------------

### Enable SMB Services

Source: https://illumos.org/books/zfs-admin/gavwq.html

Use svcadm to enable the SMB server and verify its status with svcs.

```bash
# svcadm enable -r smb/server
svcadm: svc:/milestone/network depends on svc:/network/physical, which has multiple instances.
# svcs | grep smb
online         10:47:15 svc:/network/smb/server:default
```

--------------------------------

### Verify Multiple Quota Values

Source: https://illumos.org/books/zfs-admin/gavwq.html

Use zfs get to display both refquota and quota values simultaneously.

```bash
# `zfs get refquota,quota students/studentA`
NAME               PROPERTY  VALUE              SOURCE
students/studentA  refquota  10G                local
students/studentA  quota     20G                local
```

--------------------------------

### Handle Legacy Mount Points

Source: https://illumos.org/books/zfs-admin/gavwq.html

Demonstrates that legacy mount points must be managed with standard mount tools rather than ZFS subcommands.

```bash
# `zfs mount pool/home/billm`
cannot mount 'pool/home/billm': legacy mountpoint
use mount(1M) to mount this filesystem
# `mount -F zfs tank/home/billm`
```

--------------------------------

### Create ZFS file system with properties

Source: https://illumos.org/books/zfs-admin/setup-1.html

Sets file system properties during the creation process.

```bash
# `zfs create -o mountpoint=/export/zfs -o sharenfs=on -o compression=on tank/home`
```

--------------------------------

### Create and Share a ZFS File System

Source: https://illumos.org/books/zfs-admin/gavwq.html

Create a ZFS pool and file system, then enable SMB sharing.

```bash
# `zpool create sandbox mirror c0t2d0 c0t4d0`
# `zfs create sandbox/fs1`
# `zfs set sharesmb=on sandbox/fs1`
```

--------------------------------

### Create a Mirrored Pool with Mirrored Log Devices

Source: https://illumos.org/books/zfs-admin/gavwn.html

Configure a storage pool with separate mirrored intent log devices to improve performance.

```bash
# zpool create datap mirror c1t1d0 c1t2d0 mirror c1t3d0 c1t4d0 log mirror c1t5d0 c1t8d0
# zpool status
  pool: datap
 state: ONLINE
 scrub: none requested
config:

        NAME        STATE     READ WRITE CKSUM
        datap       ONLINE       0     0     0
          mirror    ONLINE       0     0     0
            c1t1d0  ONLINE       0     0     0
            c1t2d0  ONLINE       0     0     0
          mirror    ONLINE       0     0     0
            c1t3d0  ONLINE       0     0     0
            c1t4d0  ONLINE       0     0     0
        logs        ONLINE       0     0     0
          mirror    ONLINE       0     0     0
            c1t5d0  ONLINE       0     0     0
            c1t8d0  ONLINE       0     0     0

errors: No known data errors
```

--------------------------------

### Send cumulative incremental ZFS snapshot stream

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Sends all incremental streams from a starting snapshot to a cumulative snapshot.

```bash
# zfs list
NAME                      USED  AVAIL  REFER  MOUNTPOINT
pool                      428K  16.5G    20K  /pool
pool/fs                    71K  16.5G    21K  /pool/fs
pool/fs@snapA              16K      -  18.5K  -
pool/fs@snapB              17K      -    20K  -
pool/fs@snapC              17K      -  20.5K  -
pool/fs@snapD                0      -    21K  -
# zfs send -I pool/fs@snapA pool/fs@snapD > /snaps/fs@combo
```

--------------------------------

### Initiate ZFS Data Scrubbing

Source: https://illumos.org/books/zfs-admin/gavwg.html

Starts an explicit scrub operation on the specified pool to verify all data blocks.

```bash
# `zpool scrub tank`
```

--------------------------------

### Defining and Using Complex Delegated Permissions

Source: https://illumos.org/books/zfs-admin/gbchv.html

Create a permission set and grant it to a group, demonstrating how permissions restrict or allow file system creation.

```bash
# zfs allow -s @myset create,destroy,mount,snapshot,promote,clone,readonly tank
# zfs allow tank
-------------------------------------------------------------
Permission sets on (tank)
        @myset clone,create,destroy,mount,promote,readonly,snapshot
-------------------------------------------------------------
# zfs allow staff @myset,rename tank
# zfs allow tank
-------------------------------------------------------------
Permission sets on (tank)
        @myset clone,create,destroy,mount,promote,readonly,snapshot
Local+Descendent permissions on (tank)
        group staff @myset,rename
# chmod A+group:staff:add_subdirectory:fd:allow tank
# su cindys
cindys% zfs create tank/data
Cindys% zfs allow tank
-------------------------------------------------------------
Permission sets on (tank)
        @myset clone,create,destroy,mount,promote,readonly,snapshot
Local+Descendent permissions on (tank)
        group staff @myset,rename
-------------------------------------------------------------
cindys% ls -l /tank
total 15
drwxr-xr-x   2 cindys   staff          2 Aug  8 14:10 data
cindys% exit
# su lp
$ zfs create tank/lp
cannot create 'tank/lp': permission denied
```

--------------------------------

### ZFS error path formats

Source: https://illumos.org/books/zfs-admin/gavwg.html

Examples of how ZFS displays file paths depending on mount status and object translation.

```text
/monkey/a.txt
```

```text
monkey/ghost:/e.txt
```

```text
monkey/dnode:<0x0>
```

--------------------------------

### Perform a dry run for adding a device

Source: https://illumos.org/books/zfs-admin/gavwn.html

Uses the -n option to preview the configuration changes without actually modifying the pool.

```bash
# `zpool add -n zeepool mirror c3t1d0 c3t2d0`
would update 'zeepool' to the following configuration:
      zeepool
        mirror
            c1t0d0
            c1t1d0
        mirror
            c2t1d0
            c2t2d0
        mirror
            c3t1d0
			c3t2d0
```

--------------------------------

### Retrieve ZFS user properties

Source: https://illumos.org/books/zfs-admin/gavwq.html

Query user properties across a dataset hierarchy using the zfs get command.

```bash
`zfs get -r dept:users userpool`
NAME            PROPERTY    VALUE           SOURCE
userpool        dept:users  all             local
userpool/user1  dept:users  finance         local
userpool/user2  dept:users  general         local
userpool/user3  dept:users  itops           local
```

--------------------------------

### Create ZFS Pool with Custom Mount Point

Source: https://illumos.org/books/zfs-admin/gavwn.html

Demonstrates creating a pool with a specific mount point using the -m option when the default mount point is unavailable.

```bash
# `zpool create home c1t0d0`
default mountpoint '/home' exists and is not empty
use '-m' option to specify a different default
# `zpool create -m /export/zfs home c1t0d0`
```

```bash
# `zpool create home c1t0d0`
default mountpoint '/home' exists and is not empty
use '-m' option to provide a different default
# `zpool create -m /export/zfs home c1t0d0`
```

--------------------------------

### Modify File System Before Incremental Send

Source: https://illumos.org/books/zfs-admin/snapshots.html

Example of a file system modification that necessitates a rollback or force option before receiving an incremental snapshot.

```bash
host2# `rm newtank/dana/file.1`
```

--------------------------------

### Configure ZFS pool properties

Source: https://illumos.org/books/zfs-admin/gavwn.html

Use the zpool set command to modify a specific property, followed by zpool get to verify the change.

```bash
# zpool set autoreplace=on tank
# zpool get autoreplace tank
NAME  PROPERTY     VALUE    SOURCE
tank  autoreplace  on       default
```

--------------------------------

### Create a ZFS Snapshot

Source: https://illumos.org/books/zfs-admin/snapshots.html

Basic command to create a snapshot for a specific dataset.

```bash
# `zfs snapshot tank/home/ahrens@friday`
```

--------------------------------

### List basic ZFS dataset information

Source: https://illumos.org/books/zfs-admin/gavwq.html

Displays default properties for all datasets on the system.

```bash
# `zfs list`
NAME                   USED  AVAIL  REFER  MOUNTPOINT
pool                   476K  16.5G    21K  /pool
pool/clone              18K  16.5G    18K  /pool/clone
pool/home              296K  16.5G    19K  /pool/home
pool/home/marks        277K  16.5G   277K  /pool/home/marks
pool/home/marks@snap      0      -   277K  -
pool/test               18K  16.5G    18K  /pool/test
```

--------------------------------

### Create a ZFS Clone

Source: https://illumos.org/books/zfs-admin/snapshots.html

Commands to create a snapshot and then clone it into a new dataset location.

```bash
# `zfs snapshot tank/ws/gate@yesterday`
# `zfs clone tank/ws/gate@yesterday tank/home/ahrens/bug123`
```

```bash
# `zfs snapshot projects/newproject@today`
# `zfs clone projects/newproject@today projects/teamA/tempuser`
# `zfs set sharenfs=on projects/teamA/tempuser`
# `zfs set quota=5G projects/teamA/tempuser`
```

--------------------------------

### Verify user-specific permissions

Source: https://illumos.org/books/zfs-admin/gbchv.html

Displays the permissions for a specific file system and demonstrates snapshot creation success or failure based on those permissions.

```bash
# su marks
$ zfs create tank/marks2
$ zfs allow tank/marks2
-------------------------------------------------------------
Local permissions on (tank/marks2)
        user marks destroy,snapshot
-------------------------------------------------------------
Create time permissions on (tank)
        destroy,snapshot
Local+Descendent permissions on (tank)
        group staff create
        everyone mount
-------------------------------------------------------------
```

```bash
$ zfs snapshot tank/marks2@snap1
$ zfs snapshot tank/marks@snappp
cannot create snapshot 'tank/marks@snappp': permission denied
```

--------------------------------

### List supported ZFS features and versions

Source: https://illumos.org/books/zfs-admin/gavwn.html

Lists all supported ZFS pool feature flags and legacy versions available on the system.

```bash
# `zpool upgrade -v`
This system supports ZFS pool feature flags.

The following features are supported:

FEAT DESCRIPTION
-------------------------------------------------------------
async_destroy                         (read-only compatible)
     Destroy filesystems asynchronously.
empty_bpobj                           (read-only compatible)
     Snapshots use less space.
lz4_compress
     LZ4 compression algorithm support.
multi_vdev_crash_dump
     Crash dumps to multiple vdev pools.
spacemap_histogram                    (read-only compatible)
     Spacemaps maintain space histograms.
enabled_txg                           (read-only compatible)
     Record txg at which a feature is enabled
hole_birth
     Retain hole birth txg for more precise zfs send
extensible_dataset
     Enhanced dataset functionality, used by other features.
embedded_data
     Blocks which compress very well use even less space.
bookmarks                             (read-only compatible)
     "zfs bookmark" command
filesystem_limits                     (read-only compatible)
     Filesystem and snapshot limits.
large_blocks
     Support for blocks larger than 128KB.
sha512
     SHA-512/256 hash algorithm.
skein
     Skein hash algorithm.
edonr
     Edon-R hash algorithm.

The following legacy versions are also supported:

VER  DESCRIPTION
---  --------------------------------------------------------
 1   Initial ZFS version
 2   Ditto blocks (replicated metadata)
 3   Hot spares and double parity RAID-Z
 4   zpool history
 5   Compression using the gzip algorithm
 6   bootfs pool property
 7   Separate intent log devices
 8   Delegated administration
 9   refquota and refreservation properties
 10  Cache devices
 11  Improved scrub performance
 12  Snapshot properties
 13  snapused property
 14  passthrough-x aclinherit
 15  user/group space accounting
 16  stmf property support
 17  Triple-parity RAID-Z
 18  Snapshot user holds
 19  Log device removal
 20  Compression using zle (zero-length encoding)
 21  Deduplication
 22  Received properties
 23  Slim ZIL
 24  System attributes
 25  Improved scrub stats
 26  Improved snapshot deletion performance
 27  Improved snapshot creation performance
 28  Multiple vdev replacements

For more information on a particular version, including supported releases,
see the ZFS Administration Guide.
```

--------------------------------

### Combine Snapshot and Clone with zfs send -I

Source: https://illumos.org/books/zfs-admin/snapshots.html

Uses the -I flag to create a combined dataset from a snapshot and a clone.

```bash
# zfs create pool/fs
# zfs snapshot pool/fs@snap1
# zfs clone pool/fs@snap1 pool/clone
# zfs snapshot pool/clone@snapA
# zfs send -I pool/fs@snap1 pool/clone@snapA > /snaps/fsclonesnap-I
# zfs destroy pool/clone@snapA
# zfs destroy pool/clone
# zfs receive -F pool/clone < /snaps/fsclonesnap-I
```

--------------------------------

### Handle faulted device onlining

Source: https://illumos.org/books/zfs-admin/gavwn.html

Attempting to online a device that has been physically replaced without using the proper replacement procedure will result in a fault.

```bash
# `zpool online tank c1t0d0`
Bringing device c1t0d0 online
# 
SUNW-MSG-ID: ZFS-8000-D3, TYPE: Fault, VER: 1, SEVERITY: Major
EVENT-TIME: Thu Aug 31 11:13:59 MDT 2006
PLATFORM: SUNW,Ultra-60, CSN: -, HOSTNAME: neo
SOURCE: zfs-diagnosis, REV: 1.0
EVENT-ID: e11d8245-d76a-e152-80c6-e63763ed7e4f
DESC: A ZFS device failed.  Refer to http://illumos.org/msg/ZFS-8000-D3 for more information.
AUTO-RESPONSE: No automated response will occur.
IMPACT: Fault tolerance of the pool may be compromised.
REC-ACTION: Run 'zpool status -x' and replace the bad device.
```

--------------------------------

### Simulating ZFS Pool Creation with -n

Source: https://illumos.org/books/zfs-admin/gavwn.html

Performs a dry run of the pool creation process to validate configuration without writing data to disks.

```bash
# `zpool create -n tank mirror c1t0d0 c1t1d0`
would create 'tank' with the following layout:

        tank
          mirror
            c1t0d0
            c1t1d0
```

--------------------------------

### Demonstrate NFSv4 automatic mount discovery

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Shows how newly created ZFS file systems on a server become automatically visible to NFS clients.

```bash
zee# mount neo:/tank /mnt
zee# ls /mnt
baa    bar

neo# zfs create tank/baz

zee% ls /mnt
baa    bar    baz
zee% ls /mnt/baz
file1    file2
```

--------------------------------

### Import a ZFS pool by name

Source: https://illumos.org/books/zfs-admin/gavwn.html

Use the zpool import command followed by the pool name to import an available pool.

```bash
# `zpool import tank`
```

--------------------------------

### Create a Storage Pool with Cache Devices

Source: https://illumos.org/books/zfs-admin/gavwn.html

Add cache devices to a storage pool to improve performance for random read-workloads.

```bash
# zpool create tank mirror c2t0d0 c2t1d0 c2t3d0 cache c2t5d0 c2t8d0
# zpool status tank
  pool: tank
 state: ONLINE
 scrub: none requested
config:

        NAME        STATE     READ WRITE CKSUM
        tank        ONLINE       0     0     0
          mirror    ONLINE       0     0     0
            c2t0d0  ONLINE       0     0     0
            c2t1d0  ONLINE       0     0     0
            c2t3d0  ONLINE       0     0     0
        cache
          c2t5d0    ONLINE       0     0     0
          c2t8d0    ONLINE       0     0     0
```

--------------------------------

### Import ZFS pools from alternate directories

Source: https://illumos.org/books/zfs-admin/gavwn.html

Use the -d option to specify a directory other than /dev/dsk when searching for pool devices.

```bash
# `zpool create dozer mirror /file/a /file/b`
# `zpool export dozer`
# `zpool import -d /file`
  pool: dozer
    id: 10952414725867935582
 state: ONLINE
action: The pool can be imported using its name or numeric identifier.
config:

        dozer        ONLINE
          mirror     ONLINE
            /file/a  ONLINE
            /file/b  ONLINE
# `zpool import -d /file dozer`
```

--------------------------------

### View ACL Inheritance on New File

Source: https://illumos.org/books/zfs-admin/acls.html

Shows how user permissions are propagated to a newly created file within a directory.

```bash
# `touch test4.dir/file.4`
# `ls -v test4.dir/file.4`
-rw-r--r--+  1 root     root           0 May  4 15:02 test4.dir/file.4
     0:user:gozer:write_data/execute:deny
     1:user:gozer:read_data/write_data/execute:allow
     2:owner@:execute:deny
     3:owner@:read_data/write_data/append_data/write_xattr/write_attributes
         /write_acl/write_owner:allow
     4:group@:write_data/append_data/execute:deny
     5:group@:read_data:allow
     6:everyone@:write_data/append_data/write_xattr/execute/write_attributes
         /write_acl/write_owner:deny
     7:everyone@:read_data/read_xattr/read_attributes/read_acl/synchronize
         :allow
```

--------------------------------

### Create a RAID-Z Pool with Disk Slices

Source: https://illumos.org/books/zfs-admin/gavwn.html

Create a RAID-Z pool using preformatted disk slices. Ensure slice zero is appropriately sized before execution.

```bash
# `zpool create tank raidz c1t0d0s0 c2t0d0s0 c3t0d0s0 c4t0d0s0 c5t0d0s0`
```

--------------------------------

### Configure ZFS volume as swap

Source: https://illumos.org/books/zfs-admin/advanced.html

Adds a ZFS volume as a swap device and lists current swap configuration.

```bash
# `swap -a /dev/zvol/dsk/tank/vol`
# `swap -l`
swapfile                 dev  swaplo blocks   free
/dev/dsk/c0t0d0s1      32,33      16 1048688  1048688
/dev/zvol/dsk/tank/vol 254,1      16 10485744 10485744
```

--------------------------------

### Create a ZFS volume

Source: https://illumos.org/books/zfs-admin/advanced.html

Creates a 5-Gbyte ZFS volume named tank/vol.

```bash
# `zfs create -V 5gb tank/vol`
```

--------------------------------

### Expand ZFS pool capacity after device replacement

Source: https://illumos.org/books/zfs-admin/gavwn.html

Demonstrates the export and import cycle required to recognize increased capacity after replacing a device with a larger one.

```bash
# zpool list tank
NAME   SIZE   USED  AVAIL    CAP  HEALTH  ALTROOT
tank  16.8G    94K  16.7G     0%  ONLINE  -
# zpool replace tank c0t0d0 c0t4d0
# zpool list tank
NAME   SIZE   USED  AVAIL    CAP  HEALTH  ALTROOT
tank  16.8G   112K  16.7G     0%  ONLINE  -
# zpool export tank
# zpool import tank
# zpool list tank
NAME   SIZE   USED  AVAIL    CAP  HEALTH  ALTROOT
tank  33.9G   114K  33.9G     0%  ONLINE  -
```

--------------------------------

### List ZFS Datasets

Source: https://illumos.org/books/zfs-admin/advanced.html

Display all ZFS datasets in the global zone to identify hierarchy.

```shell
global# `zfs list -Ho name`
tank
tank/home
tank/data
tank/data/matrix
tank/data/zion
tank/data/zion/home
```

--------------------------------

### Recursively Snapshot ZFS File Systems

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Create snapshots for a set of ZFS file systems recursively.

```bash
# `zfs snapshot -r users/home@today`
# `zfs list`
NAME                     USED  AVAIL  REFER  MOUNTPOINT
users                    216K  16.5G    20K  /users
users/home                76K  16.5G    22K  /users/home
users/home@today            0      -    22K  -
users/home/markm          18K  16.5G    18K  /users/home/markm
users/home/markm@today      0      -    18K  -
users/home/marks          18K  16.5G    18K  /users/home/marks
users/home/marks@today      0      -    18K  -
users/home/neil           18K  16.5G    18K  /users/home/neil
users/home/neil@today       0      -    18K  -
```

--------------------------------

### Create and list ZFS iSCSI target

Source: https://illumos.org/books/zfs-admin/advanced.html

Creates a 2-Gbyte ZFS volume and enables it as an iSCSI target.

```bash
# `zfs create -V 2g tank/volumes/v2`
# `zfs set shareiscsi=on tank/volumes/v2`
# `iscsitadm list target`
Target: tank/volumes/v2
    iSCSI Name: iqn.1986-03.com.sun:02:984fe301-c412-ccc1-cc80-cf9a72aa062a
    Connections: 0
```

--------------------------------

### Listing Snapshots

Source: https://illumos.org/books/zfs-admin/snapshots.html

List all snapshots or filter them by file system and specific output columns.

```bash
# `zfs list -t snapshot`
NAME                        USED  AVAIL  REFER  MOUNTPOINT
pool/home/anne@monday          0      -   780K  -
pool/home/bob@monday           0      -  1.01M  -
tank/home/ahrens@tuesday   8.50K      -   780K  -
tank/home/ahrens@wednesday 8.50K      -  1.01M  -
tank/home/ahrens@thursday      0      -  1.77M  -
tank/home/cindys@today     8.50K      -   524K  -
```

```bash
# `zfs list -r -t snapshot -o name,creation tank/home`
NAME                       CREATION
tank/home@now               Wed Aug 30 10:53 2006
tank/home/ahrens@tuesday    Wed Aug 30 10:53 2006
tank/home/ahrens@wednesday  Wed Aug 30 10:54 2006
tank/home/ahrens@thursday   Wed Aug 30 10:53 2006
tank/home/cindys@now        Wed Aug 30 10:57 2006
```

--------------------------------

### Bring a ZFS device online and verify pool health

Source: https://illumos.org/books/zfs-admin/gavwn.html

Use zpool online to restore a replaced device to the pool, followed by zpool status -x to confirm the pool is healthy.

```bash
# `zpool online tank c1t0d0`
Bringing device c1t0d0 online
# `zpool status -x`
all pools are healthy
```

--------------------------------

### Add a mirrored log device to a pool

Source: https://illumos.org/books/zfs-admin/gavwn.html

Configures a separate mirrored log device for an existing storage pool.

```bash
# zpool status newpool
  pool: newpool
 state: ONLINE
 scrub: none requested
config:

        NAME         STATE     READ WRITE CKSUM
        newpool      ONLINE       0     0     0
          mirror     ONLINE       0     0     0
            c1t9d0   ONLINE       0     0     0
            c1t10d0  ONLINE       0     0     0

errors: No known data errors
# zpool add newpool log mirror c1t11d0 c1t12d0
# zpool status newpool
  pool: newpool
 state: ONLINE
 scrub: none requested
config:

        NAME         STATE     READ WRITE CKSUM
        newpool      ONLINE       0     0     0
          mirror     ONLINE       0     0     0
            c1t9d0   ONLINE       0     0     0
            c1t10d0  ONLINE       0     0     0
        logs         ONLINE       0     0     0
          mirror     ONLINE       0     0     0
            c1t11d0  ONLINE       0     0     0
            c1t12d0  ONLINE       0     0     0

errors: No known data errors
```

--------------------------------

### List virtual device I/O statistics

Source: https://illumos.org/books/zfs-admin/gavwn.html

Displays the complete virtual device layout and associated I/O statistics using the -v flag.

```shell
# `zpool iostat -v`
               capacity     operations    bandwidth
tank         used  avail   read  write   read  write
----------  -----  -----  -----  -----  -----  -----
mirror      20.4G  59.6G      0     22      0  6.00K
  c1t0d0        -      -      1    295  11.2K   148K
  c1t1d0        -      -      1    299  11.2K   148K
----------  -----  -----  -----  -----  -----  -----
total       24.5K   149M      0     22      0  6.00K
```

--------------------------------

### Create individual child file systems

Source: https://illumos.org/books/zfs-admin/setup-1.html

Creates child file systems under the parent container, inheriting its properties.

```bash
# `zfs create tank/home/bonwick`
# `zfs create tank/home/billm`
```

--------------------------------

### Restore a ZFS Snapshot

Source: https://illumos.org/books/zfs-admin/snapshots.html

Demonstrates the process of sending a snapshot to a file, receiving it into a new dataset, and renaming datasets to complete the restoration.

```bash
# `zfs send tank/gozer@0830 > /bkups/gozer.083006`
# `zfs receive tank/gozer2@today < /bkups/gozer.083006`
# `zfs rename tank/gozer tank/gozer.old`
# `zfs rename tank/gozer2 tank/gozer`
```

--------------------------------

### Create a Basic ZFS Storage Pool

Source: https://illumos.org/books/zfs-admin/gavwn.html

Creates a new pool named 'tank' using two specified disks with dynamic striping.

```bash
# `zpool create tank c1t0d0 c1t1d0`
```

--------------------------------

### Set and Verify ACL Inheritance with file_inherit and dir_inherit

Source: https://illumos.org/books/zfs-admin/acls.html

Configures user permissions on a directory and verifies the resulting ACLs on the directory itself, a new file, and a new subdirectory.

```bash
# `chmod A+user:gozer:read_data/write_data/execute:file_inherit/dir_inherit:allow test3.dir`
# `ls -dv test3.dir`
drwxr-xr-x+  2 root     root           2 Feb 17 14:51 test3.dir
     0:user:gozer:list_directory/read_data/add_file/write_data/execute
         :file_inherit/dir_inherit:allow
     1:owner@::deny
     2:owner@:list_directory/read_data/add_file/write_data/add_subdirectory
         /append_data/write_xattr/execute/write_attributes/write_acl
         /write_owner:allow
     3:group@:add_file/write_data/add_subdirectory/append_data:deny
     4:group@:list_directory/read_data/execute:allow
     5:everyone@:add_file/write_data/add_subdirectory/append_data/write_xattr
         /write_attributes/write_acl/write_owner:deny
     6:everyone@:list_directory/read_data/read_xattr/execute/read_attributes
         /read_acl/synchronize:allow
```

```bash
# `touch test3.dir/file.3`
# `ls -v test3.dir/file.3`
-rw-r--r--+  1 root     root           0 Feb 17 14:53 test3.dir/file.3
     0:user:gozer:write_data/execute:deny
     1:user:gozer:read_data/write_data/execute:allow
     2:owner@:execute:deny
     3:owner@:read_data/write_data/append_data/write_xattr/write_attributes
         /write_acl/write_owner:allow
     4:group@:write_data/append_data/execute:deny
     5:group@:read_data:allow
     6:everyone@:write_data/append_data/write_xattr/execute/write_attributes
         /write_acl/write_owner:deny
     7:everyone@:read_data/read_xattr/read_attributes/read_acl/synchronize
         :allow
```

```bash
# `mkdir test3.dir/subdir.1`
# `ls -dv test3.dir/subdir.1`
drwxr-xr-x+  2 root     root           2 May  4 15:00 test3.dir/subdir.1
     0:user:gozer:list_directory/read_data/add_file/write_data/execute
         :file_inherit/dir_inherit/inherit_only:allow
     1:user:gozer:add_file/write_data:deny
     2:user:gozer:list_directory/read_data/add_file/write_data/execute:allow
     3:owner@::deny
     4:owner@:list_directory/read_data/add_file/write_data/add_subdirectory
         /append_data/write_xattr/execute/write_attributes/write_acl
         /write_owner:allow
     5:group@:add_file/write_data/add_subdirectory/append_data:deny
     6:group@:list_directory/read_data/execute:allow
     7:everyone@:add_file/write_data/add_subdirectory/append_data/write_xattr
         /write_attributes/write_acl/write_owner:deny
     8:everyone@:list_directory/read_data/read_xattr/execute/read_attributes
         /read_acl/synchronize:allow
```

--------------------------------

### Bring a ZFS device online

Source: https://illumos.org/books/zfs-admin/gavwg.html

Use the zpool online command to notify ZFS that a replaced or reattached device is ready for use.

```bash
# `zpool online tank c0t1d0`
```

--------------------------------

### Create ZFS iSCSI Target

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Create a ZFS volume and configure it as a Solaris iSCSI target device.

```bash
# zfs create -V 2g tank/volumes/v2
# zfs set shareiscsi=on tank/volumes/v2
# iscsitadm list target
Target: tank/volumes/v2
    iSCSI Name: iqn.1986-03.com.sun:02:984fe301-c412-ccc1-cc80-cf9a72aa062a
    Connections: 0
```

--------------------------------

### Identify available ZFS pools

Source: https://illumos.org/books/zfs-admin/gavwn.html

Run the zpool import command without arguments to list all pools available for import on the current system.

```bash
# `zpool import`
  pool: tank
    id: 3778921145927357706
 state: ONLINE
action: The pool can be imported using its name or numeric identifier.
config:

        tank        ONLINE
          mirror    ONLINE
            c1t0d0  ONLINE
            c1t1d0  ONLINE
```

--------------------------------

### Configure a ZFS dataset for legacy mount management

Source: https://illumos.org/books/zfs-admin/gavwq.html

Sets the mountpoint property to legacy, requiring manual management via standard mount commands.

```bash
# `zfs set mountpoint=legacy tank/home/eschrock`
# `mount -F zfs tank/home/eschrock /mnt`
```

--------------------------------

### Manage Snapshot Space with Quotas

Source: https://illumos.org/books/zfs-admin/gavwq.html

Combine quota and refquota to manage both total dataset space and snapshot-specific consumption.

```bash
# `zfs set quota=20g students/studentA`
# `zfs list`
NAME                      USED  AVAIL  REFER  MOUNTPOINT
profs                     106K  33.2G    18K  /profs
students                 57.7M  33.2G    19K  /students
students/studentA        57.5M  9.94G  57.5M  /students/studentA
students/studentA@today      0      -  57.5M  -
```

--------------------------------

### Retrieve all dataset properties

Source: https://illumos.org/books/zfs-admin/gavwq.html

Use the all keyword to list every property associated with a specific dataset.

```bash
# `zfs get all tank`
NAME  PROPERTY         VALUE                  SOURCE
tank  type             filesystem             -
tank  creation         Wed Jan 23  9:57 2008  -
tank  used             120K                   -
tank  available        33.1G                  -
tank  referenced       24.0K                  -
tank  compressratio    1.00x                  -
tank  mounted          yes                    -
tank  quota            none                   default
tank  reservation      none                   default
tank  recordsize       128K                   default
tank  mountpoint       /tank                  default
tank  sharenfs         off                    default
tank  checksum         on                     default
tank  compression      off                    default
tank  atime            on                     default
tank  devices          on                     default
tank  exec             on                     default
tank  setuid           on                     default
tank  readonly         off                    default
tank  zoned            off                    default
tank  snapdir          hidden                 default
tank  aclmode          groupmask              default
tank  aclinherit       secure                 default
tank  canmount         on                     default
tank  shareiscsi       off                    default
tank  xattr            on                     default
tank  copies           1                      default
tank  version          3                      -
tank  utf8only         off                    -
tank  normalization    none                   -
tank  casesensitivity  sensitive              -
tank  vscan            off                    default
tank  nbmand           off                    default
tank  sharesmb         off                    default
tank  refquota         none                   default
tank  refreservation   none                   default
```

--------------------------------

### Configure ZFS GZIP Compression

Source: https://illumos.org/books/zfs-admin/zfsover-1.html

Set GZIP compression levels on ZFS file systems during creation.

```bash
# zfs create -o compression=gzip users/home/snapshots
# zfs get compression users/home/snapshots
NAME                  PROPERTY     VALUE            SOURCE
users/home/snapshots  compression  gzip             local
# zfs create -o compression=gzip-9 users/home/oldfiles
# zfs get compression users/home/oldfiles
NAME                  PROPERTY     VALUE           SOURCE
users/home/oldfiles   compression  gzip-9          local
```
Tokens:
Raw