Helios

@mccormick/heliosv2026.05.19.1· 1mo agoMODELS

01README

Manage an illumos/Helios host over SSH from swamp. Four model types compose to provision and inventory zones with explicit ZFS layout and isolation/security controls:

@mccormick/helios/host — connection profile + uname/release probe - @mccormick/helios/zfs — remote ZFS dataset and pool ops - @mccormick/helios/dladm — datalink and exclusive-IP VNIC management - @mccormick/helios/zone — zonecfg/zoneadm with hardened defaults (ip-type=exclusive, file-mac-profile, hardened limit-priv, capped-cpu/memory) plus a fan-out inventory method that gathers live usage, security state, network, storage, SMF health, and recent log lines for every zone in a single SSH session.

Brands supported: solaris (native illumos) and bhyve. SSH key supplied by the user's ssh-agent (e.g. the 1Password SSH agent); no key material flows through swamp. Privileged commands run via pfexec so the model can connect as a non-root user with the relevant Solaris RBAC profiles.

02Models4

helios_dladm.tsv2026.05.14.3

Global Arguments

Argument	Type	Required
sshUser	string	yes
sshPort?	number	no
sshKnownHosts?	string	no

fn link_list()

List every datalink (phys, vnic, aggr, etherstub).

fn phys_list()

List physical NICs (`dladm show-phys`).

fn etherstub_create(name: string)

Create an etherstub.

Argument	Type	Required	Description
name	string	yes

fn etherstub_destroy(name: string)

Destroy an etherstub.

Argument	Type	Required	Description
name	string	yes

fn vnic_create(name: string, over: string, macAddress?: string, vlanId?: number, allowedIps: array)

Create a VNIC over `over` (phys/etherstub/aggr) and immediately

Argument	Type	Required	Description
name	string	yes
over	string	yes
macAddress?	string	no
vlanId?	number	no
allowedIps	array	yes	CIDR list to pin via the allowed-ips linkprop. Required for

fn vnic_destroy(name: string)

Destroy a VNIC.

Argument	Type	Required	Description
name	string	yes

helios_host.tsv2026.05.14.4

Global Arguments

Argument	Type	Required	Description
sshUser	string	yes	Default SSH user; recommended: a non-root user with Solaris RBAC
sshPort?	number	no	Default SSH port
sshKnownHosts?	string	no	Path to a known_hosts file. Omit to use accept-new on first connect.

fn lookup(pattern: string, lines: number)

Probe the Helios host for hostname, illumos build, helios release,

Argument	Type	Required	Description
pattern	string	yes
lines	number	yes

fn thermal(pattern: string, lines: number)

Read-only thermal snapshot. Aggregates prtdiag -v, kstat fan/temp

Argument	Type	Required	Description
pattern	string	yes
lines	number	yes

fn load(pattern: string, lines: number)

Read-only load snapshot: load average, per-core CPU, top processes,

Argument	Type	Required	Description
pattern	string	yes
lines	number	yes

fn faults(pattern: string, lines: number)

Read-only fault snapshot: active faults from fmadm plus the most

Argument	Type	Required	Description
pattern	string	yes
lines	number	yes

fn messages(pattern: string, lines: number)

Filtered tail of /var/adm/messages and the fmd service log. The

Argument	Type	Required	Description
pattern	string	yes
lines	number	yes

fn health_check(messagePattern: string, messageLines: number)

Fan-out: gather thermal + load + faults + recent messages in a

Argument	Type	Required	Description
messagePattern	string	yes
messageLines	number	yes

helios_zfs.tsv2026.05.14.3

Global Arguments

Argument	Type	Required
sshUser	string	yes
sshPort?	number	no
sshKnownHosts?	string	no

fn dataset_list()

List all filesystem and volume datasets on the host.

fn dataset_lookup(name: string)

Look up one dataset

Argument	Type	Required	Description
name	string	yes

fn dataset_create(name: string, quota?: string, reservation?: string, compression: string, encryption?: string, encryptionPassphrase?: string, recordsize?: string, mountpoint?: string, canmount?: enum)

Create a ZFS filesystem with optional quota, reservation,

Argument	Type	Required	Description
name	string	yes
quota?	string	no	e.g. 10G; omit for unlimited
reservation?	string	no
compression	string	yes
encryption?	string	no	e.g. aes-256-gcm. Omit to disable encryption.
encryptionPassphrase?	string	no	Passphrase for keyformat=passphrase keylocation=prompt.
recordsize?	string	no
mountpoint?	string	no
canmount?	enum	no

fn dataset_destroy(name: string, recursive: boolean, force: boolean)

Destroy a dataset (recursive optional).

Argument	Type	Required
name	string	yes
recursive	boolean	yes
force	boolean	yes

fn snapshot_create(name: string, recursive: boolean)

Create a snapshot pool/dataset@name.

Argument	Type	Required	Description
name	string	yes	Fully-qualified e.g. rpool/zones/foo@2026-05-14
recursive	boolean	yes

fn snapshot_destroy(name: string)

Destroy a snapshot.

Argument	Type	Required	Description
name	string	yes

fn delegate(dataset: string, zone: string)

Delegate a dataset into a zone: `zfs zone <dataset> <zone>`.

Argument	Type	Required	Description
dataset	string	yes
zone	string	yes

fn pool_status(pool: string)

Capture pool size/usage and zpool status output.

Argument	Type	Required	Description
pool	string	yes

fn pool_scrub(pool: string)

Start a scrub on a pool.

Argument	Type	Required	Description
pool	string	yes

helios_zone.tsv2026.05.14.3

Global Arguments

Argument	Type	Required
sshUser	string	yes
sshPort?	number	no
sshKnownHosts?	string	no

fn list()

List every configured zone via `zoneadm list -cp`.

fn lookup(name: string)

Look up a single zone with full zonecfg.

Argument	Type	Required	Description
name	string	yes

fn create(name: string, brand: enum, zonepath: string, vnicLink?: string, allowedAddress?: string, defaultRouter?: string, limitPriv: string, fileMacProfile: string, cappedCpu?: number, cappedMemoryMb?: number, dedicatedCpu?: string, delegatedDatasets: array, lofs: array)

Create a zone with hardened security defaults. ip-type=exclusive,

Argument	Type	Required
name	string	yes
brand	enum	yes
zonepath	string	yes
vnicLink?	string	no
allowedAddress?	string	no
defaultRouter?	string	no
limitPriv	string	yes
fileMacProfile	string	yes
cappedCpu?	number	no
cappedMemoryMb?	number	no
dedicatedCpu?	string	no
delegatedDatasets	array	yes
lofs	array	yes

fn install(name: string, extraArgs: array)

Install a zone (no-op for bhyve brand).

Argument	Type	Required	Description
name	string	yes
extraArgs	array	yes

fn boot(name: string)

Boot a zone.

Argument	Type	Required	Description
name	string	yes

fn halt(name: string)

Halt a zone.

Argument	Type	Required	Description
name	string	yes

fn uninstall(name: string)

Uninstall a zone (force).

Argument	Type	Required	Description
name	string	yes

fn delete(name: string)

Delete a zone configuration.

Argument	Type	Required	Description
name	string	yes

fn exec(name: string, command: string)

Run a command inside the zone via `zlogin -S`.

Argument	Type	Required	Description
name	string	yes
command	string	yes

fn inventory(includeLogs: boolean, logTailLines: number)

Single fan-out: gather identity, live usage, security config,

Argument	Type	Required	Description
includeLogs	boolean	yes
logTailLines	number	yes

03Previous Versions1

2026.05.14.1May 19, 2026

04Stats

100 / 100

Downloads

Archive size

54.2 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
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/mccormickt/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#illumos #helios #zones #zfs #dladm #bhyve #ssh