Truenas
@keeb/truenasv2026.07.09.1
01README
TrueNAS SCALE management: decomposed, per-object typed resources for system, storage, and sharing over the REST API v2.0, queryable with CEL (https://github.com/keeb/swamp-truenas)
02Models
@keeb/truenas/systemv2026.07.09.1system.ts
fn discover()
Read system info, active alerts, and services; write one typed resource per object
fn service_start(service: string)
Start a system service and record its new state
| Argument | Type | Description |
|---|---|---|
| service | string | Service name, e.g. cifs, nfs, ssh, smartd |
fn service_stop(service: string)
Stop a system service and record its new state
| Argument | Type | Description |
|---|---|---|
| service | string | Service name, e.g. cifs, nfs, ssh, smartd |
fn service_restart(service: string)
Restart a system service and record its new state
| Argument | Type | Description |
|---|---|---|
| service | string | Service name, e.g. cifs, nfs, ssh, smartd |
Resources
info(infinite)— Host system information snapshot
alert(infinite)— One active TrueNAS alert
service(infinite)— One system service and its run state
@keeb/truenas/storagev2026.07.09.1storage.ts
fn discover()
Read pools and datasets; write one typed resource per pool and dataset
fn discover_disks()
Read physical disks with SMART status and temperature; one typed resource per disk
fn discover_snapshots(dataset?: string)
Enumerate ZFS snapshots (optionally filtered to one dataset) as typed resources
| Argument | Type | Description |
|---|---|---|
| dataset? | string | Only snapshots of this dataset (exact match), e.g. main/storage |
fn create_dataset(name: string, comments?: string, compression?: string)
Create a ZFS dataset and record it
| Argument | Type | Description |
|---|---|---|
| name | string | Full dataset path, e.g. main/media |
| comments? | string | |
| compression? | string | e.g. LZ4, ZSTD, OFF (inherits parent when omitted) |
fn delete_dataset(id: string, recursive: boolean)
Delete a ZFS dataset after verifying it exists (fails if missing)
| Argument | Type | Description |
|---|---|---|
| id | string | Dataset id/path, e.g. main/media |
| recursive | boolean | Also delete child datasets |
fn create_snapshot(dataset: string, name: string, recursive: boolean)
Create a ZFS snapshot and record it
| Argument | Type | Description |
|---|---|---|
| dataset | string | Dataset to snapshot, e.g. main/storage |
| name | string | Snapshot name (the part after @) |
| recursive | boolean |
fn delete_snapshot(id: string)
Delete a ZFS snapshot by its full id (dataset@name)
| Argument | Type | Description |
|---|---|---|
| id | string | Full snapshot id, e.g. main/storage@daily-1 |
Resources
pool(infinite)— One ZFS pool with capacity and health
dataset(infinite)— One ZFS dataset or zvol
snapshot(infinite)— One ZFS snapshot
disk(infinite)— One physical disk with SMART health and temperature
@keeb/truenas/sharingv2026.07.09.1sharing.ts
fn discover()
Read SMB, NFS, and iSCSI shares; write one typed resource per share
fn smb_set_enabled(id: number, enabled: boolean)
Enable or disable an SMB share and record its new state
| Argument | Type | Description |
|---|---|---|
| id | number | Share id |
| enabled | boolean | Desired enabled state |
fn nfs_set_enabled(id: number, enabled: boolean)
Enable or disable an NFS export and record its new state
| Argument | Type | Description |
|---|---|---|
| id | number | Share id |
| enabled | boolean | Desired enabled state |
Resources
smb(infinite)— One SMB (CIFS) share
nfs(infinite)— One NFS export
iscsiTarget(infinite)— One iSCSI target
@keeb/truenas/accountsv2026.07.09.1accounts.ts
fn discover()
Read users and groups; write one typed resource per account and group
Resources
user(infinite)— One local user account
group(infinite)— One local group
@keeb/truenas/networkv2026.07.09.1network.ts
fn discover()
Read network interfaces; write one typed resource per interface
Resources
interface(infinite)— One network interface with live link state and addresses
@keeb/truenas/appsv2026.07.09.1apps.ts
fn discover()
Read chart releases; write one typed resource per application
fn set_replicas(name: string, replicas: number)
Scale an app to N replicas (0 stops it, >=1 starts it) and record its state
| Argument | Type | Description |
|---|---|---|
| name | string | Release name, e.g. minio |
| replicas | number | Desired replica count |
Resources
app(infinite)— One application (Helm chart release)
@keeb/truenas/protectionv2026.07.09.1protection.ts
fn discover()
Read snapshot, replication, cloud sync, and rsync tasks as typed resources
Resources
snapshotTask(infinite)— One periodic ZFS snapshot task
replication(infinite)— One replication task
cloudSync(infinite)— One cloud sync task
rsyncTask(infinite)— One rsync task
03Stats
A
100 / 100
Downloads
0
Archive size
27.7 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
Repository
https://github.com/keeb/swamp-truenas04Platforms
05Labels