Phenix

@nblair2/phenixv2026.05.30.2· 1d agoMODELS

01README

Full sceptre-phenix control via the HTTP API, split into five models — config, experiment, vm, cluster and user: config CRUD (Topology/Scenario/Experiment/Image/User), the experiment lifecycle (create/start/stop/delete, schedule, apps, topology, files, trigger), VM control (inventory, reconfigure, power, snapshots, captures, commit), and cluster/server reads (hosts, disks, apps, topologies, version, features, settings) plus identity (users, roles, long-lived tokens).

02Models5

@nblair2/phenix/configv2026.05.30.2config.ts

fn config_list()

List all phenix configs, storing each one

fn config_get(kind: string, name: string)

Fetch a single config by kind and name and store it

Argument	Type	Required	Description
kind	string	yes	Config kind: Topology, Scenario, Experiment, Image, or User
name	string	yes	Config name (metadata.name)

fn config_create(config?: record, file?: string)

Create a config from an inline object or a local YAML/JSON file

Argument	Type	Required	Description
config?	record	no	Inline config object ({apiVersion, kind, metadata, spec});
file?	string	no	Path to a local YAML or JSON config document; mutually exclusive with config

fn config_update(kind: string, name: string, config?: record, file?: string)

Replace an existing config (by kind/name) from an inline object or file

Argument	Type	Required	Description
kind	string	yes	Config kind: Topology, Scenario, Experiment, Image, or User
name	string	yes	Config name (metadata.name)
config?	record	no	Inline replacement config object; mutually exclusive with file
file?	string	no	Path to a local YAML or JSON config document; mutually exclusive with config

fn config_delete(kind: string, name: string)

Delete a config by kind and name

Argument	Type	Required	Description
kind	string	yes	Config kind: Topology, Scenario, Experiment, Image, or User
name	string	yes	Config name (metadata.name)

Resources

config(infinite)— A phenix config object (Topology, Scenario, Experiment, Image or User)

@nblair2/phenix/experimentv2026.05.30.2experiment.ts

fn experiment_list()

List all experiments, storing each one

fn experiment_get(name: string)

Fetch a single experiment by name and store its state

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_create(name: string, topology: string, scenario?: string, vlanMin?: number, vlanMax?: number, disabledApps?: array, deployMode?: string, defaultBridge?: string, useGreMesh?: boolean)

Create an experiment from a topology (and optional scenario).

Argument	Type	Required	Description
name	string	yes	Unique experiment name
topology	string	yes	Name of the Topology config to use
scenario?	string	no	Name of the Scenario config to apply (optional)
vlanMin?	number	no	Low end of the VLAN range
vlanMax?	number	no	High end of the VLAN range
disabledApps?	array	no	Scenario apps to disable for this experiment
deployMode?	string	no	Deploy mode (e.g. 'all', 'no-headnode', 'only-headnode')
defaultBridge?	string	no	Default minimega bridge name
useGreMesh?	boolean	no	Use a GRE mesh between cluster nodes

fn experiment_delete(name: string)

Delete an experiment (must be stopped)

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_start(name: string)

Start (launch) an experiment, then store its updated state

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_stop(name: string)

Stop (tear down) a running experiment, then store its state

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_apps(name: string)

List the apps configured for an experiment

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_schedule_get(name: string)

Read the current VM-placement schedule for an experiment

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_schedule_set(name: string, algorithm: string)

Apply a scheduling algorithm to place an experiment's VMs

Argument	Type	Required	Description
name	string	yes	Experiment name
algorithm	string	yes	Scheduling algorithm (e.g. 'round-robin', 'isolate-experiment')

fn experiment_topology(name: string)

Fetch the (expanded) topology of an experiment

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_files(name: string)

List the files associated with an experiment

Argument	Type	Required	Description
name	string	yes	Experiment name

fn experiment_trigger(name: string, apps?: array)

Trigger (re-run) running-stage apps for an experiment

Argument	Type	Required	Description
name	string	yes	Experiment name
apps?	array	no	Specific apps to (re)trigger; omit to trigger all

Resources

experiment(infinite)— A phenix experiment and its current lifecycle state

operation(7d)— Outcome of a one-shot phenix action (schedule, trigger, apps, etc.)

@nblair2/phenix/vmv2026.05.30.2vm.ts

fn vm_list(exp: string)

List all VMs in an experiment, storing each one

Argument	Type	Required	Description
exp	string	yes	Experiment name

fn vm_list_all()

List every VM across all experiments, storing each as a `vm` resource

fn vm_get(exp: string, name: string)

Fetch a single VM by name and store its state

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_update(exp: string, name: string, cpus?: number, ram?: number, disk?: string, dnb?: boolean, host?: string, snapshot?: boolean, interface?: object, tags?: record)

Update a VM's CPUs/RAM/disk, do-not-boot flag, host pin, snapshot

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name
cpus?	number	no	Number of vCPUs
ram?	number	no	RAM in MB
disk?	string	no	Disk image path
dnb?	boolean	no	Set the do-not-boot flag
host?	string	no	Pin the VM to a cluster host
snapshot?	boolean	no	Run the disk in snapshot mode
interface?	object	no	Connect interface {index} to a {vlan}
tags?	record	no	Tags to set on the VM

fn vm_start(exp: string, name: string)

Boot a VM, then store its updated state

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_stop(exp: string, name: string)

Power off (pause) a VM, then store its updated state

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_shutdown(exp: string, name: string)

Gracefully shut down a VM's guest OS, then store its state

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_restart(exp: string, name: string)

Restart a VM, then store its updated state

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_reset(exp: string, name: string)

Hard-reset a VM, then store its updated state

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_redeploy(exp: string, name: string, cpus?: number, ram?: number, disk?: string, injects?: boolean)

Redeploy a VM (optionally with new CPUs/RAM/disk and re-injection)

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name
cpus?	number	no	Number of vCPUs
ram?	number	no	RAM in MB
disk?	string	no	Disk image path
injects?	boolean	no	Re-run file injections

fn vm_snapshot_list(exp: string, name: string)

List the disk snapshots available for a VM

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_snapshot_create(exp: string, name: string, filename: string)

Create a disk snapshot of a VM

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name
filename	string	yes	Snapshot filename

fn vm_snapshot_restore(exp: string, name: string, snapshot: string)

Restore a VM from a named disk snapshot

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name
snapshot	string	yes	Snapshot name to restore

fn vm_commit(exp: string, name: string)

Commit a VM's current disk state to a new backing image

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

fn vm_capture_start(exp: string, name: string, interface: number, filter?: string)

Start a packet capture on a VM interface

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name
interface	number	yes	Interface index to capture on
filter?	string	no	Optional BPF capture filter

fn vm_capture_stop(exp: string, name: string)

Stop all packet captures on a VM

Argument	Type	Required	Description
exp	string	yes	Experiment name
name	string	yes	VM name

Resources

vm(infinite)— A VM within a phenix experiment and its current state

operation(7d)— Outcome of a one-shot phenix action (snapshot, commit, capture, etc.)

@nblair2/phenix/clusterv2026.05.30.2cluster.ts

fn host_list()

List the cluster hosts (head and compute nodes)

fn disk_list()

List the disk images available on the cluster

fn application_list()

List the phenix apps available on the server

fn topology_list()

List the available Topology configs

fn topology_scenarios(topology: string)

List the scenarios compatible with a given topology

Argument	Type	Required	Description
topology	string	yes	Topology name

fn version()

Read the phenix server version

fn features()

Read the phenix server's enabled feature flags

fn settings_get()

Read the phenix server settings

Resources

host(7d)— A phenix cluster host (head or compute node)

disk(7d)— A disk image known to the phenix cluster

operation(7d)— Outcome of a one-shot phenix read (apps, topologies, version, etc.)

@nblair2/phenix/userv2026.05.30.2user.ts

fn user_list()

List all phenix users, storing each one

fn user_get(username: string)

Fetch a single user by username and store it

Argument	Type	Required	Description
username	string	yes	Username

fn user_create(username: string, password: string, firstName?: string, lastName?: string, roleName: string, resourceNames?: array)

Create a phenix user with an RBAC role

Argument	Type	Required	Description
username	string	yes	New username
password	string	yes	Initial password
firstName?	string	no	First name
lastName?	string	no	Last name
roleName	string	yes	RBAC role name (e.g. 'Global Admin', 'VM Viewer')
resourceNames?	array	no	Resource-name globs the role is scoped to (e.g. ['*'])

fn user_delete(username: string)

Delete a phenix user

Argument	Type	Required	Description
username	string	yes	Username

fn role_list()

List the available RBAC roles

fn token_create(username: string, lifetime: string, desc?: string)

Mint a long-lived API token for a user (the result includes the

Argument	Type	Required	Description
username	string	yes	User to mint a token for
lifetime	string	yes	Token lifetime: a Go duration ('720h') or an integer number of days
desc?	string	no	Description for the token

Resources

user(infinite)— A phenix UI user and its RBAC role

operation(7d)— Outcome of a one-shot phenix action (role list, token mint, etc.)

03Previous Versions1

2026.05.30.1May 31, 2026

04Stats

100 / 100

Downloads

Archive size

48.1 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types1/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/nblair2/swamp-phenix

05Platforms

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

06Labels

#phenix #sceptre #sandia #minimega #network-emulation #cyber-range #experiment #topology #scenario #vm #infrastructure