Zfs
@josephholsten/zfsv2026.06.11.1
01README
ZFS pool, dataset, and snapshot operations via SSH — supports FreeBSD, Linux, and Illumos
02Models
@josephholsten/zfs/poolv2026.06.11.1pool.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| pool | string |
fn sync()
Capture pool health, size/usage, and device state
fn scrub()
Start a scrub on the pool
fn trim()
Start a TRIM on the pool (for SSD vdevs)
Resources
status(infinite)— ZFS pool health, size, and device state
scrub-run(7d)— Record of a pool scrub initiated via this model
trim-run(7d)— Record of a pool TRIM initiated via this model
@josephholsten/zfs/datasetv2026.06.11.1dataset.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| pool | string |
fn sync()
List all datasets in the pool and store as a single inventory resource
fn create(name: string, properties?: record)
Create a ZFS dataset with optional properties
| Argument | Type | Description |
|---|---|---|
| name | string | Full dataset name, e.g. tank/data/backups |
| properties? | record | ZFS properties to set at creation time, e.g. {compression: 'zstd', quota: '10G'} |
fn destroy(name: string, recursive: boolean, force: boolean)
Destroy a ZFS dataset
| Argument | Type | Description |
|---|---|---|
| name | string | |
| recursive | boolean | |
| force | boolean |
fn set(name: string, property: string, value: string)
Set a ZFS property on a dataset
| Argument | Type | Description |
|---|---|---|
| name | string | |
| property | string | |
| value | string |
Resources
inventory(infinite)— All ZFS filesystems and volumes in the pool
@josephholsten/zfs/snapshotv2026.06.11.1snapshot.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| pool | string |
fn sync()
List all snapshots in the pool and store as a single inventory resource
fn create(dataset: string, name?: string, recursive: boolean)
Create a snapshot. Auto-generates swamp_YYYY-MM-DD_HH.MM.SS name if omitted.
| Argument | Type | Description |
|---|---|---|
| dataset | string | Dataset to snapshot, e.g. tank/data |
| name? | string | Snapshot name after @. Defaults to swamp_YYYY-MM-DD_HH.MM.SS |
| recursive | boolean |
fn destroy(name: string)
Destroy a single snapshot by full name (dataset@snapname)
| Argument | Type | Description |
|---|---|---|
| name | string | Full snapshot name, e.g. tank/data@swamp_2026-06-11_03.00.00 |
fn prune(dataset: string, prefix: string, keepCount: number, olderThanDays: number, dryRun: boolean)
Destroy snapshots on a dataset matching prefix, keeping the newest keepCount and any newer than olderThanDays
| Argument | Type | Description |
|---|---|---|
| dataset | string | |
| prefix | string | Snapshot name prefix to match, e.g. swamp_ |
| keepCount | number | |
| olderThanDays | number | |
| dryRun | boolean |
Resources
inventory(infinite)— All ZFS snapshots in the pool
prune-run(7d)— Record of a prune operation run via this model
03Stats
A
100 / 100
Downloads
0
Archive size
16.0 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
04Platforms
05Labels