virt.instance.update

Update instance.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

ID of the virtual instance to update.

Parameter 2: virt_instance_update

virt_instance_update

Type: object

Updated configuration data for the virtual instance.

No Additional Properties

environment

Environment

Environment variables to set inside the instance.

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

Whether the instance should automatically start when the host boots.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

cpu

Cpu

CPU allocation specification or null for automatic allocation.

Any of

• Option 1
• Option 2

Type: string

Type: null

memory

Memory

Memory allocation in bytes or null for automatic allocation.

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_port

Vnc Port

TCP port number for VNC access (5900-65535) or null to disable VNC.

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

Whether to enable VNC remote access for the instance.

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

Whether to enable UEFI Secure Boot (VMs only).

root_disk_size

Root Disk Size

Size of the root disk in GB (minimum 5GB) or null to keep current 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)

I/O bus type for the root disk or null to keep current setting.

Must be one of:

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

image_os

Image Os

Operating system type for the instance or null for auto-detection.

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

The updated virtual instance configuration.

No Additional Properties

id Required

Id

Type: string

Unique identifier for the virtual instance.

name Required

Name

Type: string

Human-readable name for the virtual instance.

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

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

Type of virtual instance.

Must be one of:

• "CONTAINER"
• "VM"

status Required

Status

Type: enum (of string)

Current operational status of the virtual instance.

Must be one of:

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

cpu Required

Cpu

CPU configuration string or null for default allocation.

Any of

• Option 1
• Option 2

Type: string

Type: null

memory Required

Memory

Memory allocation in bytes or null for default allocation.

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart Required

Autostart

Type: boolean

Whether the instance automatically starts when the host boots.

environment Required

Environment

Type: object

Environment variables to set inside the instance.

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases Required

Aliases

Type: array of object

Array of IP aliases configured for the instance.

No Additional Items

Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

type Required

Type

Type: enum (of string)

Type of IP address (INET for IPv4, INET6 for IPv6).

Must be one of:

• "INET"
• "INET6"

address Required

Address

Type: string

IP address for the virtual instance.

Must be at least 1 characters long

netmask Required

Netmask

Network mask in CIDR notation.

Any of

• Option 1
• Option 2

Type: integer

Type: null

image Required

Image

Type: object

Image information used to create this instance.

No Additional Properties

architecture Required

Architecture

Hardware architecture of the image (e.g., amd64, arm64).

Any of

• Option 1
• Option 2

Type: string

Type: null

description Required

Description

Human-readable description of the image.

Any of

• Option 1
• Option 2

Type: string

Type: null

os Required

Os

Operating system family of the image.

Any of

• Option 1
• Option 2

Type: string

Type: null

release Required

Release

Version or release name of the operating system.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Unique serial identifier for the image.

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Type of image (container, virtual-machine, etc.).

Any of

• Option 1
• Option 2

Type: string

Type: null

variant Required

Variant

Image variant (default, cloud, minimal, etc.).

Any of

• Option 1
• Option 2

Type: string

Type: null

secureboot Required

Secureboot

Whether the image supports UEFI Secure Boot.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

userns_idmap Required

User namespace ID mapping configuration for privilege isolation.

Any of

• UserNsIdmap
• Option 2

UserNsIdmap

Type: object
No Additional Properties

uid Required

User ID mapping configuration for user namespace isolation.

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

Starting host ID for the mapping range.

maprange Required

Maprange

Type: integer

Number of IDs to map in this range.

nsid Required

Nsid

Type: integer

Starting namespace ID for the mapping range.

Type: null

gid Required

Group ID mapping configuration for user namespace isolation.

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

Starting host ID for the mapping range.

maprange Required

Maprange

Type: integer

Number of IDs to map in this range.

nsid Required

Nsid

Type: integer

Starting namespace ID for the mapping range.

Type: null

Type: null

raw Required

Raw

Raw low-level configuration options (advanced use only).

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled Required

Vnc Enabled

Type: boolean

Whether VNC remote access is enabled for the instance.

vnc_port Required

Vnc Port

TCP port number for VNC connections or null if VNC is disabled.

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password Required

Vnc Password

Password for VNC access or null if no password is set.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot Required

Secure Boot

Whether UEFI Secure Boot is enabled (VMs only) or null for containers.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

privileged_mode Required

Privileged Mode

Whether the container runs in privileged mode or null for VMs.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size Required

Root Disk Size

Size of the root disk in GB or null for default 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)

I/O bus type for the root disk or null for default.

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