Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/stratosphere-ve/core/llms.txt

Use this file to discover all available pages before exploring further.

Each virtual machine managed by Stratosphere is described by a JSON configuration file stored at vms/<name>.json. These files are created when you run VMCreate() (CLI option 8). Currently VMCreate() writes an empty file — you must populate the fields manually. Future versions will prompt for all values during creation.

​
Full example

{
  "vm": {
    "name": "example",
    "uuid": "example-id",
    "created_at": "1970-01-01T12:00:00Z"
  },
  "cpu": {
    "cores": 2,
    "threads": 2,
    "type": "host"
  },
  "memory": {
    "size_mb": 2048
  },
  "network": {
    "interfaces": [
      { "name": "eth0", "type": "nat", "mac": "auto" }
    ]
  },
  "storage": {
    "disks": [
      {
        "name": "example-disk",
        "path": "vms/example/example-disk-0.qcow2",
        "size_gb": 20,
        "format": "qcow2"
      }
    ]
  }
}

​
vm object

Top-level metadata that identifies the virtual machine.
​
name
string
required
Human-readable identifier for the VM. Should match the config filename (e.g. a file named my-vm.json would use "name": "my-vm").
​
uuid
string
required
Unique identifier for the VM. Used to distinguish VMs that share a name.
​
created_at
string
required
ISO 8601 timestamp recording when the VM was created (e.g. "1970-01-01T12:00:00Z").

​
cpu object

Virtual CPU configuration.
​
cores
integer
required
Number of virtual CPU cores allocated to the VM.
​
threads
integer
required
Number of threads per core. Set to 1 for single-threaded cores or 2 to emulate hyperthreading.
​
type
string
required
CPU model passed to the hypervisor. Use "host" to pass through the host machine’s CPU features directly.

​
memory object

Memory allocation for the VM.
​
size_mb
integer
required
RAM allocated to the VM in megabytes. For example, 2048 is equivalent to 2 GB.

​
network object

​
interfaces
array
required
List of virtual network interface objects.

​
storage object

​
disks
array
required
List of virtual disk objects attached to the VM.
VMCreate() currently creates an empty JSON file at vms/<name>.json. All fields must be added manually after creation. A future release will prompt for every field interactively.

Build docs developers (and LLMs) love

Get started for freeTalk to us