Truenas
Administration of a TrueNAS SCALE host (25.04 or 25.10) through its JSON-RPC 2.0 WebSocket API (wss://, API-key auth). Reads apps and their port bindings, NFS/SMB shares and their host allowlists, services, network interfaces, scheduled tasks and each pool's last scrub, and a summary of exposed app ports and shares. Makes a small set of changes: switch an app port between published and exposed, set a custom app's docker networks, create or update an app from Docker Compose YAML with its secrets filled in from a vault, set NFS networks/hosts and SMB hostsallow/hostsdeny, and delete an NFS or SMB share (the data is left alone). Rejects any non-TLS endpoint, because TrueNAS revokes an API key sent in cleartext. Verifies each target first. Does not manage pools, datasets, users, or service start/stop.
Global Arguments
| Argument | Type | Description |
|---|---|---|
| endpoint | string | TrueNAS host or wss:// base URL (required), e.g. nas.example.com or |
| apiKey | string | TrueNAS API key (Credentials → Users → API keys). Supply via vault: |
| timeoutMs? | coerce.number | Per-call timeout in milliseconds (also the job-wait budget) |
| Argument | Type | Description |
|---|---|---|
| path | preprocess | Absolute path to list, e.g. /mnt/Backup, or a JSON list of paths to list in |
| maxEntries? | coerce.number | Cap on entries recorded (a media dataset can hold thousands); 0 records |
| Argument | Type | Description |
|---|---|---|
| app? | string | App name (from app_list). Omit to report every app's host-path binds. |
| Argument | Type | Description |
|---|---|---|
| app | string | App name (from app_list) |
| portKey? | string | Port config key, e.g. "ldap_port", "admin_port" (preferred; from app_list |
| portNumber? | coerce.number | Alternatively select the port by its current number |
| bindMode? | enum | published = bound on the host; exposed = container-internal only (closes the |
| hostIps? | array | Host IPs to publish on (e.g. ["192.0.2.252"]); only meaningful when |
| Argument | Type | Description |
|---|---|---|
| name | string | App name: lowercase letters, digits and hyphens, at most 40 characters |
| compose | string | The app's Docker Compose YAML. Write each secret as a ${NAME} placeholder |
| secrets? | record | Placeholder name to secret value, each from a vault: |
| waitMs? | coerce.number | How long to wait for the create or update job. It pulls the images |
| Argument | Type | Description |
|---|---|---|
| name | string | App name: lowercase letters, digits and hyphens, at most 40 characters |
| compose | string | The app's Docker Compose YAML. Write each secret as a ${NAME} placeholder |
| secrets? | record | Placeholder name to secret value, each from a vault: |
| waitMs? | coerce.number | How long to wait for the create or update job. It pulls the images |
| Argument | Type | Description |
|---|---|---|
| app | string | App name (from app_list) |
| networks | array | The complete desired set of docker network names to attach the app to (e.g. |
| Argument | Type | Description |
|---|---|---|
| id? | coerce.number | NFS share id (from nfs_share_list) |
| path? | string | Alternatively select the share by export path |
| networks? | array | Authorized networks in CIDR, e.g. ["192.0.2.161/32"]. Empty array clears |
| hosts? | array | Authorized hosts/IPs. Empty array clears. Omit to leave hosts unchanged. |
| Argument | Type | Description |
|---|---|---|
| id? | coerce.number | NFS share id (from nfs_share_list) |
| path? | string | Alternatively select the share by export path |
| confirmPath? | string | Safety guard: when set, must exactly equal the resolved share's export path |
| Argument | Type | Description |
|---|---|---|
| id? | coerce.number | SMB share id (from smb_share_list) |
| name? | string | Alternatively select the share by name |
| hostsallow? | array | Allowed hosts/subnets. Empty array clears the allowlist. Omit to leave unchanged. |
| hostsdeny? | array | Denied hosts/subnets (e.g. ["ALL"] with an allowlist). Omit to leave unchanged. |
| Argument | Type | Description |
|---|---|---|
| id? | coerce.number | SMB share id (from smb_share_list) |
| name? | string | Alternatively select the share by name |
| confirmName? | string | Safety guard: when set, must exactly equal the resolved share's name |
Resources
Modified 1 behaviors
Modified 1 behaviors
Added 1 behaviors. updated labels
- 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
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned