Table Of Contents

Previous topic

vm.cpu_model_choices

Next topic

vm.delete

vm.create

Create a Virtual Machine (VM).

Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a separate package. Multiple cores can be configured per CPU by specifying cores attributes. vcpus specifies total number of CPU sockets. cores specifies number of cores per socket. threads specifies number of threads per core.

ensure_display_device when set ( the default ) will ensure that the guest always has access to a video device. For headless installations like ubuntu server this is required for the guest to operate properly. However for cases where consumer would like to use GPU passthrough and does not want a display device added should set this to false.

arch_type refers to architecture type and can be specified for the guest. By default the value is null and system in this case will choose a reasonable default based on host.

machine_type refers to machine type of the guest based on the architecture type selected with arch_type. By default the value is null and system in this case will choose a reasonable default based on arch_type configuration.

shutdown_timeout indicates the time in seconds the system waits for the VM to cleanly shutdown. During system shutdown, if the VM hasn’t exited after a hardware shutdown signal has been sent by the system within shutdown_timeout seconds, system initiates poweroff for the VM to stop it.

hide_from_msr is a boolean which when set will hide the KVM hypervisor from standard MSR based discovery and is useful to enable when doing GPU passthrough.

hyperv_enlightenments can be used to enable subset of predefined Hyper-V enlightenments for Windows guests. These enlightenments improve performance and enable otherwise missing features.

suspend_on_snapshot is a boolean attribute which when enabled will automatically pause/suspend VMs when a snapshot is being taken for periodic snapshot tasks. For manual snapshots, if user has specified vms to be paused, they will be in that case.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: vm_create

vm_create

Type: object
No Additional Properties

Command Line Args

Type: string Default: ""

Cpu Mode

Type: enum (of string) Default: "CUSTOM"
Must be one of:
  • "CUSTOM"
  • "HOST-MODEL"
  • "HOST-PASSTHROUGH"

Cpu Model

Default: null

Type: string
Type: null

Name

Type: string

Must be at least 1 characters long

Description

Type: string Default: ""

Vcpus

Type: integer Default: 1

Value must be greater or equal to 1

Cores

Type: integer Default: 1

Value must be greater or equal to 1

Threads

Type: integer Default: 1

Value must be greater or equal to 1

Cpuset

Default: null

Type: string
Type: null

Nodeset

Default: null

Type: string
Type: null

Enable Cpu Topology Extension

Type: boolean Default: false

Pin Vcpus

Type: boolean Default: false

Suspend On Snapshot

Type: boolean Default: false

Trusted Platform Module

Type: boolean Default: false

Memory

Type: integer

Value must be greater or equal to 20

Min Memory

Default: null

Type: integer

Value must be greater or equal to 20

Type: null

Hyperv Enlightenments

Type: boolean Default: false

Bootloader

Type: enum (of string) Default: "UEFI"
Must be one of:
  • "UEFI_CSM"
  • "UEFI"

Bootloader Ovmf

Type: string Default: "OVMF_CODE.fd"

Autostart

Type: boolean Default: true

Hide From Msr

Type: boolean Default: false

Ensure Display Device

Type: boolean Default: true

Time

Type: enum (of string) Default: "LOCAL"
Must be one of:
  • "LOCAL"
  • "UTC"

Shutdown Timeout

Type: integer Default: 90

Value must be greater or equal to 5 and lesser or equal to 300

Arch Type

Default: null

Type: string
Type: null

Machine Type

Default: null

Type: string
Type: null

Uuid

Default: null

Type: string
Type: null

VMEntry

Type: object
No Additional Properties

Command Line Args

Type: string Default: ""

Cpu Mode

Type: enum (of string) Default: "CUSTOM"
Must be one of:
  • "CUSTOM"
  • "HOST-MODEL"
  • "HOST-PASSTHROUGH"

Cpu Model

Default: null

Type: string
Type: null

Name

Type: string

Must be at least 1 characters long

Description

Type: string Default: ""

Vcpus

Type: integer Default: 1

Value must be greater or equal to 1

Cores

Type: integer Default: 1

Value must be greater or equal to 1

Threads

Type: integer Default: 1

Value must be greater or equal to 1

Cpuset

Default: null

Type: string
Type: null

Nodeset

Default: null

Type: string
Type: null

Enable Cpu Topology Extension

Type: boolean Default: false

Pin Vcpus

Type: boolean Default: false

Suspend On Snapshot

Type: boolean Default: false

Trusted Platform Module

Type: boolean Default: false

Memory

Type: integer

Value must be greater or equal to 20

Min Memory

Default: null

Type: integer

Value must be greater or equal to 20

Type: null

Hyperv Enlightenments

Type: boolean Default: false

Bootloader

Type: enum (of string) Default: "UEFI"
Must be one of:
  • "UEFI_CSM"
  • "UEFI"

Bootloader Ovmf

Type: string Default: "OVMF_CODE.fd"

Autostart

Type: boolean Default: true

Hide From Msr

Type: boolean Default: false

Ensure Display Device

Type: boolean Default: true

Time

Type: enum (of string) Default: "LOCAL"
Must be one of:
  • "LOCAL"
  • "UTC"

Shutdown Timeout

Type: integer Default: 90

Value must be greater or equal to 5 and lesser or equal to 300

Arch Type

Default: null

Type: string
Type: null

Machine Type

Default: null

Type: string
Type: null

Uuid

Default: null

Type: string
Type: null

Devices

Type: array
No Additional Items
Each item of this array must be:
Type: object

Display Available

Type: boolean

Id

Type: integer

Type: object


Required roles: