Skip to content

Virtumfile fields ​

The Virtumfile is a YAML file. Commented example: examples/Virtumfile.

Lab ​

FieldPurpose
nameLab name (required); network virtum-lab-<name>
machinesThe machines, by name (required)
subnetLab subnet, a.b.c.0/24; otherwise derived from the name. See Networking
networklab (default) or bridge, for every machine
bridge_interfaceHost interface for bridging
bindlocal (default, 127.0.0.1) or lan for ports:. See Ports
mountsShared folders inherited by every machine. See Shared folders
ssh_portSSH port of the machines if they move it (falls back to 22)
restartno, always or unless-stopped: start at host boot
ansibleAnsible section, below

Machine ​

FieldPurpose
osImage: debian-12, ubuntu-24.04, ubuntu-26.04 (required)
ramMemory in MB (default 2048)
cpuVirtual CPUs (default 2)
disk_sizeDisk size (20G)
portsForwards "<host port>:<VM port>"
bindlocal or lan, overrides the lab's
provisionShell commands run at first boot
mountsShared folders: <host>:<guest>, :rw suffix for write access
networklab or bridge, overrides the lab's
bridge_interfaceHost interface for bridging
ipFixed address on the lab network
ssh_portSSH port, overrides the lab's
restartOverrides the lab's
groupsAnsible inventory groups

apply updates on existing VMs: ram, cpu, bind, ports, disk_size, mounts, ssh_port, restart, ip.

ansible section ​

FieldPurpose
playbookPlaybook, relative to the Virtumfile's folder (required)
requirementsCollections and roles to install with ansible-galaxy
snapshotSnapshot taken after the first provisioning: a name, true (default, provisioned) or false

Validation ​

The Virtumfile is validated before use: names (lab, machines, groups, snapshots), host paths relative to and under the Virtumfile, guest paths under /home/virtum, no nested shares.

A Virtumfile is code

Running a stranger's Virtumfile or playbook amounts to running their code on your machine.