2023-12-04 10:02:23 +00:00
|
|
|
---
|
|
|
|
|
arch-wiki: https://wiki.archlinux.org/title/ZFS
|
|
|
|
|
website: https://openzfs.org/wiki/Main_Page
|
|
|
|
|
repo: https://github.com/openzfs/zfs
|
|
|
|
|
obj: filesystem
|
|
|
|
|
---
|
2023-12-08 16:04:29 +00:00
|
|
|
|
2023-12-04 10:02:23 +00:00
|
|
|
# ZFS
|
2024-01-17 08:44:04 +00:00
|
|
|
[ZFS](https://en.wikipedia.org/wiki/ZFS "wikipedia:ZFS") is an advanced filesystem.
|
2023-12-04 10:02:23 +00:00
|
|
|
|
|
|
|
|
## ZPool
|
|
|
|
|
**Create a pool***
|
|
|
|
|
```shell
|
|
|
|
|
zpool create -f -m <mount> <pool> [raidz(2|3)|mirror] <ids>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Pool Status**
|
|
|
|
|
```shell
|
2023-12-08 16:04:29 +00:00
|
|
|
zpool list
|
2023-12-04 10:02:23 +00:00
|
|
|
zpool status -v
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Import Pool**
|
|
|
|
|
```shell
|
|
|
|
|
zpool import -l -d /dev/disk/by-id <pool> # Import pool
|
|
|
|
|
zpool import -a # Import all available pools
|
|
|
|
|
zpool import -a -f # Import all available pools with force option
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Export Pool**
|
|
|
|
|
```shell
|
|
|
|
|
zpool export <pool>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Extend Pool**
|
|
|
|
|
```shell
|
|
|
|
|
zpool add <pool> <device-id>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Destroy pool / dataset**
|
|
|
|
|
```shell
|
|
|
|
|
zpool destroy <pool>
|
|
|
|
|
zfs destroy <pool>/<dataset>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Rename a pool**
|
|
|
|
|
```shell
|
|
|
|
|
zpool export oldname
|
|
|
|
|
zpool import oldname newname
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Upgrade pool**
|
|
|
|
|
```shell
|
|
|
|
|
zpool upgrade <pool>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Automount
|
|
|
|
|
Specify this for `zfs-import-cache.service` to pick up the pool
|
|
|
|
|
```shell
|
|
|
|
|
zpool set cachefile=/etc/zfs/zpool.cache <pool>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Datasets
|
2023-12-08 16:04:29 +00:00
|
|
|
### Dataset Managment
|
2023-12-04 10:02:23 +00:00
|
|
|
**Create Dataset**
|
|
|
|
|
```shell
|
|
|
|
|
zfs create <nameofzpool>/<nameofdataset>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Create encrypted dataset:**
|
|
|
|
|
```shell
|
2023-12-08 16:04:29 +00:00
|
|
|
openssl rand 32 > /path/to/key # Generate key
|
2023-12-04 10:02:23 +00:00
|
|
|
|
|
|
|
|
zfs create -o encryption=on -o keyformat=raw -o keylocation=file://$KEYLOCATION "$DATASET"
|
|
|
|
|
```
|
2023-12-08 16:04:29 +00:00
|
|
|
|
|
|
|
|
**Change encryption keys:**
|
|
|
|
|
```shell
|
|
|
|
|
zfs change-key -l [-o keylocation=value] [-o keyformat=value] [-o pbkdf2iters=value] filesystem
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-04 10:02:23 +00:00
|
|
|
**Load all encryption keys**
|
|
|
|
|
```shell
|
|
|
|
|
zfs load-key -a
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Load all keys at boot with systemd**
|
|
|
|
|
__/etc/systemd/system/zfs-load-key.service__:
|
|
|
|
|
``` ini
|
|
|
|
|
[Unit]
|
|
|
|
|
Description=Load encryption keys
|
|
|
|
|
DefaultDependencies=no
|
|
|
|
|
After=zfs-import.target
|
|
|
|
|
Before=zfs-mount.service
|
|
|
|
|
|
|
|
|
|
[Service]
|
|
|
|
|
Type=oneshot
|
|
|
|
|
RemainAfterExit=yes
|
|
|
|
|
ExecStart=/usr/bin/zfs load-key -a
|
|
|
|
|
StandardInput=tty-force
|
|
|
|
|
|
|
|
|
|
[Install]
|
|
|
|
|
WantedBy=zfs-mount.service
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-08 16:04:29 +00:00
|
|
|
**Destroy dataset:**
|
|
|
|
|
```shell
|
|
|
|
|
# Destroy dataset
|
|
|
|
|
zfs destroy <pool>/<dataset>
|
|
|
|
|
|
|
|
|
|
# Destroy Dataset recursively with all subdatasets
|
|
|
|
|
zfs destroy -r <pool>/<dataset>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Mount dataset:**
|
|
|
|
|
```shell
|
|
|
|
|
zfs mount <pool>/<dataset>
|
|
|
|
|
zfs unmount <pool>/<dataset>
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-04 10:02:23 +00:00
|
|
|
### Snapshots
|
|
|
|
|
**Create snapshot:**
|
|
|
|
|
```shell
|
|
|
|
|
zfs snapshot <pool>/<dataset>@<snapshot>
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-08 16:04:29 +00:00
|
|
|
**Rollback snapshot:**
|
|
|
|
|
```shell
|
|
|
|
|
# Rollback to snapshot and destroy any newer snapshots
|
|
|
|
|
zfs rollback -r <pool>/<dataset>@<snapshot>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Show differences between snapshots:**
|
|
|
|
|
```shell
|
|
|
|
|
zfs diff -F tank/test@before tank/test
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The `-F` flag shows more information about the type of files that have changed:
|
|
|
|
|
|
|
|
|
|
| Symbol | Meaning |
|
|
|
|
|
| ------ | ---------------- |
|
|
|
|
|
| `B` | Block device |
|
|
|
|
|
| `C` | Character device |
|
|
|
|
|
| `/` | Directory |
|
|
|
|
|
| `>` | Door |
|
|
|
|
|
| `|` | Named pipe |
|
|
|
|
|
| `@` | Symbolic link |
|
|
|
|
|
| `P` | Event port |
|
|
|
|
|
| `=` | Socket |
|
|
|
|
|
| `F` | Regular file |
|
|
|
|
|
|
2023-12-04 10:02:23 +00:00
|
|
|
**Send and receive:**
|
|
|
|
|
```shell
|
|
|
|
|
zfs send -v -w <pool>/<dataset>@<snapshot> | zfs recv <pool>/<newdataset>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Properties
|
|
|
|
|
**Get properties:**
|
|
|
|
|
```shell
|
|
|
|
|
zfs get <property> <pool>/<dataset>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Set properties**
|
|
|
|
|
```shell
|
|
|
|
|
zfs set <property>=<value> <pool>/<dataset>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Available Properties
|
2023-12-08 16:04:29 +00:00
|
|
|
| PROPERTY | EDIT | INHERIT | VALUES |
|
|
|
|
|
| ---------------------- | ---- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| `available` | NO | NO | `<size>` |
|
|
|
|
|
| `clones` | NO | NO | `<dataset>[,...]` |
|
|
|
|
|
| `compressratio` | NO | NO | `<1.00x or higher if compressed>` |
|
|
|
|
|
| `createtxg` | NO | NO | `<uint64>` |
|
|
|
|
|
| `creation` | NO | NO | `<date>` |
|
|
|
|
|
| `encryptionroot` | NO | NO | `<filesystem \| volume>` |
|
|
|
|
|
| `filesystem_count` | NO | NO | `<count>` |
|
|
|
|
|
| `guid` | NO | NO | `<uint64>` |
|
|
|
|
|
| `keystatus` | NO | NO | `none` / `unavailable` / `available` |
|
|
|
|
|
| `logicalreferenced` | NO | NO | `<size>` |
|
|
|
|
|
| `logicalused` | NO | NO | `<size>` |
|
|
|
|
|
| `mounted` | NO | NO | `yes` / `no` |
|
|
|
|
|
| `origin` | NO | NO | `<snapshot>` |
|
|
|
|
|
| `redact_snaps` | NO | NO | `<snapshot>[,...]` |
|
|
|
|
|
| `referenced` | NO | NO | `<size>` |
|
|
|
|
|
| `snapshot_count` | NO | NO | `<count>` |
|
|
|
|
|
| `type` | NO | NO | `filesystem` / `volume` / `snapshot` / `bookmark` |
|
|
|
|
|
| `used` | NO | NO | `<size>` |
|
|
|
|
|
| `usedbychildren` | NO | NO | `<size>` |
|
|
|
|
|
| `usedbydataset` | NO | NO | `<size>` |
|
|
|
|
|
| `usedbyrefreservation` | NO | NO | `<size>` |
|
|
|
|
|
| `usedbysnapshots` | NO | NO | `<size>` |
|
|
|
|
|
| `written` | NO | NO | `<size>` |
|
|
|
|
|
| `atime` | YES | YES | `on` / `off` |
|
|
|
|
|
| `casesensitivity` | NO | YES | `sensitive` / `insensitive` / `mixed` |
|
|
|
|
|
| `checksum` | YES | YES | `on` / `off` / `fletcher2` / `fletcher4` / `sha256` / `sha512` / `skein` / `edonr` / `blake3` |
|
|
|
|
|
| `compression` | YES | YES | `on` / `off` / `lzjb` / `gzip` / `gzip-[1-9]` / `zle` / `lz4` / `zstd` / `zstd-[1-19]` / `zstd-fast` / `zstd-fast-[1-10,20,30,40,50,60,70,80,90,100,500,1000]` |
|
|
|
|
|
| `copies` | YES | YES | `1` / `2` / `3` |
|
|
|
|
|
| `dedup` | YES | YES | `on` / `off` / `verify` / `sha256[,verify]` / `sha512[,verify]` / `skein[,verify]` / `edonr,verify` / `blake3[,verify]` |
|
|
|
|
|
| `encryption` | NO | YES | `on` / `off` / `aes-128-ccm` / `aes-192-ccm` / `aes-256-ccm` / `aes-128-gcm` / `aes-192-gcm` / `aes-256-gcm` |
|
|
|
|
|
| `keyformat` | NO | NO | `none` / `raw` / `hex` / `passphrase` |
|
|
|
|
|
| `keylocation` | YES | NO | `prompt` / `<file URI>` / `<https URL>` / `<http URL>` |
|
|
|
|
|
| `mountpoint` | YES | YES | `<path>` / `legacy` / `none` |
|
|
|
|
|
| `pbkdf2iters` | NO | NO | `<iters>` |
|
|
|
|
|
| `quota` | YES | NO | `<size>` / `none` |
|
|
|
|
|
| `readonly` | YES | YES | `on` / `off` |
|
|
|
|
|
| `relatime` | YES | YES | `on` / `off` |
|
|
|
|
|
| `reservation` | YES | NO | `<size>` / `none` |
|
|
|
|
|
| `snapdir` | YES | YES | `hidden` / `visible` |
|
2023-12-04 10:02:23 +00:00
|
|
|
|
|
|
|
|
### Scrub
|
|
|
|
|
Like [Btrfs](Btrfs.md) ZFS can heal itself with scrubbing
|
|
|
|
|
|
|
|
|
|
**Start a scrub:**
|
|
|
|
|
```shell
|
|
|
|
|
zpool scrub <pool>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Cancel a scrub:**
|
|
|
|
|
```shell
|
|
|
|
|
zpool scrub -s <pool>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Autoscrubbing with systemd:**
|
|
|
|
|
|
|
|
|
|
__/etc/systemd/system/zfs-scrub@.timer__
|
|
|
|
|
```ini
|
|
|
|
|
[Unit]
|
|
|
|
|
Description=Monthly zpool scrub on %i
|
|
|
|
|
|
|
|
|
|
[Timer]
|
|
|
|
|
OnCalendar=monthly
|
|
|
|
|
AccuracySec=1h
|
|
|
|
|
Persistent=true
|
|
|
|
|
|
|
|
|
|
[Install]
|
|
|
|
|
WantedBy=multi-user.target
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
__/etc/systemd/system/zfs-scrub@.service__
|
|
|
|
|
```ini
|
|
|
|
|
[Unit]
|
|
|
|
|
Description=zpool scrub on %i
|
|
|
|
|
|
|
|
|
|
[Service]
|
|
|
|
|
Nice=19
|
|
|
|
|
IOSchedulingClass=idle
|
|
|
|
|
KillSignal=SIGINT
|
|
|
|
|
ExecStart=/usr/bin/zpool scrub %i
|
|
|
|
|
|
|
|
|
|
[Install]
|
|
|
|
|
WantedBy=multi-user.target
|
|
|
|
|
```
|
