Skip to content

Interface: VmRunArgs ​

Arguments for a vm/run / cvm/run hypervisor operation — a declarative façade over the VM orchestrator that mirrors container/run (the QEMU knobs are hidden). cvm/run is the confidential (SEV-SNP) variant and shares this exact arg shape: the operation key selects confidentiality, not an argument.

Properties ​

PropertyTypeDescription
cmd?string | string[]Command to run on boot (delivered via cloud-init / the guest agent).
cpu?numbervCPU count.
disk?string | numberRoot disk size — MiB as a number, or a human string like "20G".
env?EnvEnvironment variables injected into the guest.
expose?ExposePorts to expose — same grammar as container/run.
gpu?booleanPass a GPU through to the guest (VFIO).
imagestringDisk image to fetch and boot (OCI artifact, URL, or IPFS CID). Required.
memory?string | numberMemory — MiB as a number, or a human string like "4G".
private?booleanPublish exposed URLs privately (auth-gated) rather than publicly.
restart_policy?RestartPolicyRestart policy — same grammar as container/run.