Table Of Contents

Previous topic

virt.instance.device_list

Next topic

virt.instance.get_instance

virt.instance.device_update

Update a device in an instance.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string
Parameter 2: device

device


Disk

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

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

Source

Default: null

For CONTAINER instances, this would be a valid pool path. For VM instances, it
can be a valid zvol path or an incus storage volume name

Type: string

Must be at least 1 characters long

Type: null

Destination

Default: null

Type: string
Type: null

Boot Priority

Default: null

Type: integer

Value must be greater or equal to 0

Type: null

GPU

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

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

Gpu Type

Type: enum (of string)
Must be one of:
  • "PHYSICAL"
  • "MDEV"
  • "MIG"
  • "SRIOV"

Id

Default: null

Type: string
Type: null

Gid

Default: null

Type: integer

Value must be greater or equal to 0 and lesser or equal to 90000000

Type: null

Uid

Default: null

Type: integer

Value must be greater or equal to 0 and lesser or equal to 90000000

Type: null

Mode

Default: null

Type: string
Type: null

Mdev

Default: null

Type: string

Must be at least 1 characters long

Type: null

Mig Uuid

Default: null

Type: string

Must be at least 1 characters long

Type: null

Pci

Default: null

Type: string

Must be at least 1 characters long

Type: null

Productid

Default: null

Type: string

Must be at least 1 characters long

Type: null

Vendorid

Default: null

Type: string

Must be at least 1 characters long

Type: null

Proxy

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

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

Source Proto

Type: enum (of string)
Must be one of:
  • "UDP"
  • "TCP"

Source Port

Type: integer

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

Dest Proto

Type: enum (of string)
Must be one of:
  • "UDP"
  • "TCP"

Dest Port

Type: integer

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

TPM

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

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

Path

Default: null

Type: string
Type: null

Pathrm

Default: null

Type: string
Type: null

USB

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

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

Bus

Default: null

Type: integer
Type: null

Dev

Default: null

Type: integer
Type: null

Product Id

Default: null

Type: string
Type: null

Vendor Id

Default: null

Type: string
Type: null

NIC

Type: object
No Additional Properties

Name

Default: null

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

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

Network

Default: null

Type: string

Must be at least 1 characters long

Type: null

Nic Type

Default: null

Type: enum (of string)
Must be one of:
  • "BRIDGED"
  • "MACVLAN"
Type: null

Parent

Default: null

Type: string

Must be at least 1 characters long

Type: null

Result

Type: const
Must be one of:
  • true
Specific value: true


Required roles: VIRT_INSTANCE_WRITE