Table Of Contents

Previous topic

vm.suspend

Next topic

vm.virtualization_details

vm.update

Update all information of a specific VM.

devices is a list of virtualized hardware to attach to the virtual machine. If devices is not present, no change is made to devices. If either the device list order or data stored by the device changes when the attribute is passed, these actions are taken:

  1. If there is no device in the devices list which was previously attached to the VM, that device is removed from the virtual machine. 2) Devices are updated in the devices list when they contain a valid id attribute that corresponds to an existing device. 3) Devices that do not have an id attribute are created and attached to id VM.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: vm_update

vm_update

Type: object
No Additional Properties

Command Line Args

Type: string

Cpu Mode

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

Cpu Model


Type: string
Type: null

Name

Type: string

Must be at least 1 characters long

Description

Type: string

Vcpus

Type: integer

Value must be greater or equal to 1

Cores

Type: integer

Value must be greater or equal to 1

Threads

Type: integer

Value must be greater or equal to 1

Cpuset


Type: string
Type: null

Nodeset


Type: string
Type: null

Enable Cpu Topology Extension

Type: boolean

Pin Vcpus

Type: boolean

Suspend On Snapshot

Type: boolean

Trusted Platform Module

Type: boolean

Memory

Type: integer

Value must be greater or equal to 20

Min Memory


Type: integer

Value must be greater or equal to 20

Type: null

Hyperv Enlightenments

Type: boolean

Bootloader

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

Bootloader Ovmf

Type: string

Autostart

Type: boolean

Hide From Msr

Type: boolean

Ensure Display Device

Type: boolean

Time

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

Shutdown Timeout

Type: integer

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

Arch Type


Type: string
Type: null

Machine Type


Type: string
Type: null

Uuid


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: