Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
put/vm.create
Request body
Example request
{
"memory": {
"hugepages": false,
"shared": false,
"hugepage_size": 1,
"prefault": false,
"mergeable": false,
"size": 2,
"hotplugged_size": 7,
"zones": [
{
"hugepages": false,
"shared": false,
"hugepage_size": 1,
"prefault": false,
"mergeable": false,
"file": "file",
"size": 1,
"hotplugged_size": 1,
"host_numa_node": 6,
"id": "id",
"hotplug_size": 7
},
{
"hugepages": false,
"shared": false,
"hugepage_size": 1,
"prefault": false,
"mergeable": false,
"file": "file",
"size": 1,
"hotplugged_size": 1,
"host_numa_node": 6,
"id": "id",
"hotplug_size": 7
}
],
"hotplug_size": 4,
"hotplug_method": "Acpi",
"thp": true
},
"disks": [
{
"num_queues": 9,
"rate_limit_group": "rate_limit_group",
"queue_size": 6,
"direct": false,
"backing_files": false,
"rate_limiter_config": {
"ops": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
},
"bandwidth": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
}
},
"queue_affinity": [
{
"host_cpus": [
6,
6
],
"queue_index": 9
},
{
"host_cpus": [
6,
6
],
"queue_index": 9
}
],
"pci_segment": 8,
"path": "path",
"readonly": false,
"iommu": false,
"vhost_socket": "vhost_socket",
"serial": "serial",
"sparse": true,
"vhost_user": false,
"id": "id",
"image_type": "FixedVhd"
},
{
"num_queues": 9,
"rate_limit_group": "rate_limit_group",
"queue_size": 6,
"direct": false,
"backing_files": false,
"rate_limiter_config": {
"ops": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
},
"bandwidth": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
}
},
"queue_affinity": [
{
"host_cpus": [
6,
6
],
"queue_index": 9
},
{
"host_cpus": [
6,
6
],
"queue_index": 9
}
],
"pci_segment": 8,
"path": "path",
"readonly": false,
"iommu": false,
"vhost_socket": "vhost_socket",
"serial": "serial",
"sparse": true,
"vhost_user": false,
"id": "id",
"image_type": "FixedVhd"
}
],
"fs": [
{
"pci_segment": 6,
"num_queues": 6,
"queue_size": 5,
"tag": "tag",
"socket": "socket",
"id": "id"
},
{
"pci_segment": 6,
"num_queues": 6,
"queue_size": 5,
"tag": "tag",
"socket": "socket",
"id": "id"
}
],
"vsock": {
"pci_segment": 8,
"iommu": false,
"socket": "socket",
"id": "id",
"cid": 3
},
"platform": {
"iommu_segments": [
4,
4
],
"num_pci_segments": 6,
"iommu_address_width": 1,
"oem_strings": [
"oem_strings",
"oem_strings"
],
"tdx": false,
"serial_number": "serial_number",
"sev_snp": false,
"uuid": "uuid"
},
"pmem": [
{
"pci_segment": 3,
"file": "file",
"size": 3,
"iommu": false,
"id": "id",
"discard_writes": false
},
{
"pci_segment": 3,
"file": "file",
"size": 3,
"iommu": false,
"id": "id",
"discard_writes": false
}
],
"iommu": false,
"payload": {
"cmdline": "cmdline",
"igvm": "igvm",
"kernel": "kernel",
"host_data": "host_data",
"initramfs": "initramfs",
"firmware": "firmware"
},
"rate_limit_groups": [
{
"id": "id",
"rate_limiter_config": {
"ops": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
},
"bandwidth": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
}
}
},
{
"id": "id",
"rate_limiter_config": {
"ops": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
},
"bandwidth": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
}
}
}
],
"debug_console": {
"mode": "Off",
"iobase": 7,
"file": "file"
},
"net": [
{
"tap": "tap",
"host_mac": "host_mac",
"num_queues": 6,
"offload_ufo": true,
"queue_size": 1,
"offload_csum": true,
"ip": "192.168.249.1",
"rate_limiter_config": {
"ops": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
},
"bandwidth": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
}
},
"mac": "mac",
"mtu": 3,
"pci_segment": 2,
"offload_tso": true,
"vhost_mode": "Client",
"iommu": false,
"vhost_socket": "vhost_socket",
"vhost_user": false,
"id": "id",
"mask": "255.255.255.0"
},
{
"tap": "tap",
"host_mac": "host_mac",
"num_queues": 6,
"offload_ufo": true,
"queue_size": 1,
"offload_csum": true,
"ip": "192.168.249.1",
"rate_limiter_config": {
"ops": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
},
"bandwidth": {
"size": 0,
"one_time_burst": 0,
"refill_time": 0
}
},
"mac": "mac",
"mtu": 3,
"pci_segment": 2,
"offload_tso": true,
"vhost_mode": "Client",
"iommu": false,
"vhost_socket": "vhost_socket",
"vhost_user": false,
"id": "id",
"mask": "255.255.255.0"
}
],
"pvpanic": false,
"console": {
"mode": "Off",
"file": "file",
"iommu": false,
"socket": "socket"
},
"balloon": {
"size": 6,
"deflate_on_oom": false,
"free_page_reporting": false
},
"cpus": {
"features": {
"amx": true
},
"kvm_hyperv": false,
"topology": {
"dies_per_package": 5,
"threads_per_core": 1,
"cores_per_die": 5,
"packages": 2
},
"max_phys_bits": 7,
"boot_vcpus": 1,
"max_vcpus": 1,
"nested": true,
"affinity": [
{
"vcpu": 9,
"host_cpus": [
3,
3
]
},
{
"vcpu": 9,
"host_cpus": [
3,
3
]
}
]
},
"devices": [
{
"pci_segment": 0,
"path": "path",
"x_nv_gpudirect_clique": 7,
"iommu": false,
"id": "id"
},
{
"pci_segment": 0,
"path": "path",
"x_nv_gpudirect_clique": 7,
"iommu": false,
"id": "id"
}
],
"vdpa": [
{
"pci_segment": 0,
"path": "path",
"num_queues": 6,
"iommu": false,
"id": "id"
},
{
"pci_segment": 0,
"path": "path",
"num_queues": 6,
"iommu": false,
"id": "id"
}
],
"numa": [
{
"distances": [
{
"distance": 7,
"destination": 3
},
{
"distance": 7,
"destination": 3
}
],
"pci_segments": [
5,
5
],
"device_id": "device_id",
"cpus": [
3,
3
],
"memory_zones": [
"memory_zones",
"memory_zones"
],
"guest_numa_id": 7
},
{
"distances": [
{
"distance": 7,
"destination": 3
},
{
"distance": 7,
"destination": 3
}
],
"pci_segments": [
5,
5
],
"device_id": "device_id",
"cpus": [
3,
3
],
"memory_zones": [
"memory_zones",
"memory_zones"
],
"guest_numa_id": 7
}
],
"rng": {
"iommu": false,
"src": "src"
},
"tpm": {
"socket": "socket"
},
"watchdog": false,
"pci_segments": [
{
"pci_segment": 3,
"mmio32_aperture_weight": 4,
"mmio64_aperture_weight": 0
},
{
"pci_segment": 3,
"mmio32_aperture_weight": 4,
"mmio64_aperture_weight": 0
}
],
"landlock_enable": false,
"serial": {
"mode": "Off",
"file": "file",
"iommu": false,
"socket": "socket"
},
"landlock_rules": [
{
"path": "path",
"access": "access"
},
{
"path": "path",
"access": "access"
}
]
}Response
The VM instance was successfully created.