# virt.instance.update

Update instance.

This method is a job.

Type: object

##

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 variables to set inside the instance.

## Any of

Type: object

##

Each additional property must conform to the following schema

Type: string
Type: null

##

#### Autostart

Whether the instance should automatically start when the host boots.

## Any of

Type: boolean
Type: null

##

#### Cpu

CPU allocation specification or `null` for automatic allocation.

## Any of

Type: string
Type: null

##

#### Memory

Memory allocation in bytes or `null` for automatic allocation.

## Any of

Type: integer
Type: null

##

#### Vnc Port

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

## Any of

Type: integer

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

Type: null

##

#### Enable Vnc

Type: boolean

Whether to enable VNC remote access for the instance.

##

#### Vnc Password

Setting vnc_password to null will unset VNC password.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Secure Boot

Type: boolean

Whether to enable UEFI Secure Boot (VMs only).

##

#### Root Disk Size

Size of the root disk in GB (minimum 5GB) or `null` to keep current size.

## Any of

Type: integer

Value must be greater or equal to `5`

Type: null

##

#### 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

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

## Any of

Type: string
Type: enum (of null or string)

##### Must be one of:

- "LINUX"
- "FREEBSD"
- "WINDOWS"
- "ARCHLINUX"
- null

##

#### 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.

##

#### VirtInstanceEntry

Type: object

The updated virtual instance configuration.

No Additional Properties

##

#### Id

Type: string

Unique identifier for the virtual instance.

##

#### 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: enum (of string) Default: "CONTAINER"

Type of virtual instance.

##### Must be one of:

- "CONTAINER"
- "VM"

##

#### 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

CPU configuration string or `null` for default allocation.

## Any of

Type: string
Type: null

##

#### Memory

Memory allocation in bytes or `null` for default allocation.

## Any of

Type: integer
Type: null

##

#### Autostart

Type: boolean

Whether the instance automatically starts when the host boots.

##

#### Environment

Type: object

Environment variables to set inside the instance.

##

Each additional property must conform to the following schema

Type: string

##

#### 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

Type: enum (of string)

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

##### Must be one of:

- "INET"
- "INET6"

##

#### Address

Type: string

IP address for the virtual instance.

Must be at least `1` characters long

##

#### Netmask

Network mask in CIDR notation.

## Any of

Type: integer
Type: null

##

#### Image

Type: object

Image information used to create this instance.

No Additional Properties

##

#### Architecture

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

## Any of

Type: string
Type: null

##

#### Description

Human-readable description of the image.

## Any of

Type: string
Type: null

##

#### Os

Operating system family of the image.

## Any of

Type: string
Type: null

##

#### Release

Version or release name of the operating system.

## Any of

Type: string
Type: null

##

#### Serial

Unique serial identifier for the image.

## Any of

Type: string
Type: null

##

#### Type

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

## Any of

Type: string
Type: null

##

#### Variant

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

## Any of

Type: string
Type: null

##

#### Secureboot

Whether the image supports UEFI Secure Boot.

## Any of

Type: boolean
Type: null

##

User namespace ID mapping configuration for privilege isolation.

## Any of

#### UserNsIdmap

Type: object
No Additional Properties

##

User ID mapping configuration for user namespace isolation.

## Any of

#### IdmapUserNsEntry

Type: object
No Additional Properties

##

#### Hostid

Type: integer

Starting host ID for the mapping range.

##

#### Maprange

Type: integer

Number of IDs to map in this range.

##

#### Nsid

Type: integer

Starting namespace ID for the mapping range.

Type: null

##

Group ID mapping configuration for user namespace isolation.

## Any of

#### IdmapUserNsEntry

Type: object
No Additional Properties

##

#### Hostid

Type: integer

Starting host ID for the mapping range.

##

#### Maprange

Type: integer

Number of IDs to map in this range.

##

#### Nsid

Type: integer

Starting namespace ID for the mapping range.

Type: null
Type: null

##

#### Raw

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

## Any of

Type: object
Type: null

##

#### Vnc Enabled

Type: boolean

Whether VNC remote access is enabled for the instance.

##

#### Vnc Port

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

## Any of

Type: integer
Type: null

##

#### Vnc Password

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

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Secure Boot

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

## Any of

Type: boolean
Type: null

##

#### Privileged Mode

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

## Any of

Type: boolean
Type: null

##

#### Root Disk Size

Size of the root disk in GB or `null` for default size.

## Any of

Type: integer
Type: null

##

#### 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

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