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. .. raw:: html
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

Enable Secure Boot

Type: boolean

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 of object
No Additional Items
Each item of this array must be:

VMDeviceEntry

Type: object
No Additional Properties

Id

Type: integer

Attributes


VMCDROMDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "CDROM"
Specific value: "CDROM"

Path

Type: string Default: "*"

Path must not contain "{", "}" characters, and it should start with "/mnt/"

Must match regular expression: ^/mnt/[^{}]*$

Must be at least 1 characters long

VMDisplayDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "DISPLAY"
Specific value: "DISPLAY"

Resolution

Type: enum (of string) Default: "1024x768"
Must be one of:
  • "1920x1200"
  • "1920x1080"
  • "1600x1200"
  • "1600x900"
  • "1400x1050"
  • "1280x1024"
  • "1280x720"
  • "1024x768"
  • "800x600"
  • "640x480"

Port

Default: null

Type: integer

Value must be greater or equal to 5900 and lesser or equal to 65535

Type: null

Web Port

Default: null

Type: integer
Type: null

Bind

Type: string Default: "127.0.0.1"

Must be at least 1 characters long

Wait

Type: boolean Default: false

Password

Default: null

Type: string
Type: null

Web

Type: boolean Default: true

Type

Type: const Default: "SPICE"
Must be one of:
  • "SPICE"
Specific value: "SPICE"

VMNICDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "NIC"
Specific value: "NIC"

Trust Guest Rx Filters

Type: boolean Default: false

Type

Type: enum (of string) Default: "E1000"
Must be one of:
  • "E1000"
  • "VIRTIO"

Nic Attach

Default: null

Type: string
Type: null

Mac

Default: null

Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$
Type: null

VMPCIDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "PCI"
Specific value: "PCI"

Pptdev

Type: string

Must be at least 1 characters long

VMRAWDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "RAW"
Specific value: "RAW"

Path

Type: string Default: "127.0.0.1"

Path must not contain "{", "}" characters

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

Type

Type: enum (of string) Default: "AHCI"
Must be one of:
  • "AHCI"
  • "VIRTIO"

Exists

Type: boolean Default: false

Boot

Type: boolean Default: false

Size

Default: null

Type: integer
Type: null

Logical Sectorsize

Default: null

Type: enum (of integer or null)
Must be one of:
  • null
  • 512
  • 4096
Type: null

Physical Sectorsize

Default: null

Type: enum (of integer or null)
Must be one of:
  • null
  • 512
  • 4096
Type: null

Iotype

Type: enum (of string) Default: "THREADS"
Must be one of:
  • "NATIVE"
  • "THREADS"
  • "IO_URING"

Serial

Default: null

Type: string

Must be at least 1 characters long

Type: null

VMDiskDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "DISK"
Specific value: "DISK"

Path

Default: null

Type: string

Must be at least 1 characters long

Type: null

Type

Type: enum (of string) Default: "AHCI"
Must be one of:
  • "AHCI"
  • "VIRTIO"

Create Zvol

Type: boolean Default: false

Zvol Name

Default: null

Type: string
Type: null

Zvol Volsize

Default: null

Type: integer
Type: null

Logical Sectorsize

Default: null

Type: enum (of integer or null)
Must be one of:
  • null
  • 512
  • 4096
Type: null

Physical Sectorsize

Default: null

Type: enum (of integer or null)
Must be one of:
  • null
  • 512
  • 4096
Type: null

Iotype

Type: enum (of string) Default: "THREADS"
Must be one of:
  • "NATIVE"
  • "THREADS"
  • "IO_URING"

Serial

Default: null

Type: string

Must be at least 1 characters long

Type: null

VMUSBDevice

Type: object
No Additional Properties

Dtype

Type: const
Must be one of:
  • "USB"
Specific value: "USB"

Default: null

USBAttributes

Type: object
No Additional Properties

Vendor Id

Type: string Default: "127.0.0.1"

Vendor id must start with "0x" prefix e.g 0x16a8

Must match regular expression: ^0x.*

Must be at least 1 characters long

Product Id

Type: string Default: "127.0.0.1"

Product id must start with "0x" prefix e.g 0x16a8

Must match regular expression: ^0x.*

Must be at least 1 characters long

Type: null

Controller Type

Type: enum (of string) Default: "nec-xhci"
Must be one of:
  • "piix3-uhci"
  • "piix4-uhci"
  • "ehci"
  • "ich9-ehci1"
  • "vt82c686b-uhci"
  • "pci-ohci"
  • "nec-xhci"
  • "qemu-xhci"

Device

Default: null

Type: string

Must be at least 1 characters long

Type: null

Vm

Type: integer

Order

Type: integer

Display Available

Type: boolean

Id

Type: integer

VMStatus

Type: object
No Additional Properties

State

Type: string

Must be at least 1 characters long

Pid


Type: integer
Type: null

Domain State

Type: string

Must be at least 1 characters long

Enable Secure Boot

Type: boolean Default: false


*Required roles:* VM_WRITE