virt.instance.update

Update instance.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: virt_instance_update

virt_instance_update

Type: object
No Additional Properties

environment

Environment

Any of

• Option 1
• Option 2

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

Type: null

autostart

Autostart

Any of

• Option 1
• Option 2

Type: boolean

Type: null

cpu

Cpu

Any of

• Option 1
• Option 2

Type: string

Type: null

memory

Memory

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_port

Vnc Port

Any of

• Option 1
• Option 2

Type: integer

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

Type: null

enable_vnc

Enable Vnc

Type: boolean

vnc_password

Vnc Password

Setting vnc_password to null will unset VNC password

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot

Secure Boot

Type: boolean

root_disk_size

Root Disk Size

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 5

Type: null

root_disk_io_bus

Root Disk Io Bus

Type: enum (of null or string)

Must be one of:

• "NVME"
• "VIRTIO-BLK"
• "VIRTIO-SCSI"
• null

image_os

Image Os

Any of

• Option 1
• Option 2

Type: string

Type: enum (of null or string)

Must be one of:

• "LINUX"
• "FREEBSD"
• "WINDOWS"
• "ARCHLINUX"
• null

privileged_mode

Privileged Mode

Type: boolean

This is only valid for containers and should only be set when container instance which is to be deployed is to
run in a privileged mode.

Return value

VirtInstanceEntry

Type: object
No Additional Properties

id Required

Id

Type: string

name Required

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

Type: enum (of string) Default: "CONTAINER"

Must be one of:

• "CONTAINER"
• "VM"

status Required

Status

Type: enum (of string)

Must be one of:

• "RUNNING"
• "STOPPED"
• "UNKNOWN"
• "ERROR"
• "FROZEN"
• "STARTING"
• "STOPPING"
• "FREEZING"
• "THAWED"
• "ABORTING"

cpu Required

Cpu

Any of

• Option 1
• Option 2

Type: string

Type: null

memory Required

Memory

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart Required

Autostart

Type: boolean

environment Required

Environment

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases Required

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

type Required

Type

Type: enum (of string)

Must be one of:

• "INET"
• "INET6"

address Required

Address

Type: string

Must be at least 1 characters long

netmask Required

Netmask

Any of

• Option 1
• Option 2

Type: integer

Type: null

image Required

Image

Type: object
No Additional Properties

architecture Required

Architecture

Any of

• Option 1
• Option 2

Type: string

Type: null

description Required

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

os Required

Os

Any of

• Option 1
• Option 2

Type: string

Type: null

release Required

Release

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Any of

• Option 1
• Option 2

Type: string

Type: null

variant Required

Variant

Any of

• Option 1
• Option 2

Type: string

Type: null

secureboot Required

Secureboot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

userns_idmap Required

Any of

• UserNsIdmap
• Option 2

UserNsIdmap

Type: object
No Additional Properties

uid Required

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

gid Required

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

Type: null

raw Required

Raw

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled Required

Vnc Enabled

Type: boolean

vnc_port Required

Vnc Port

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password Required

Vnc Password

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot Required

Secure Boot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

privileged_mode Required

Privileged Mode

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size Required

Root Disk Size

Any of

• Option 1
• Option 2

Type: integer

Type: null

root_disk_io_bus Required

Root Disk Io Bus

Type: enum (of null or string)

Must be one of:

• "NVME"
• "VIRTIO-BLK"
• "VIRTIO-SCSI"
• null

storage_pool Required

Storage Pool

Type: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long

Required roles: VIRT_INSTANCE_WRITE