Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: device

device

One of

Disk

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: string

Type: null

Boot Priority

Default: null

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 0

Type: null

Io Bus

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

Must be one of:

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

Storage Pool

Default: null

Storage pool in which the device is located. This must be one
of the storage pools listed in virt.global.config output.
If this is set to None during device creation, then the default storage
pool defined in virt.global.config will be used.

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

GPU

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: string

Type: null

Gid

Default: null

Any of

Option 1
Option 2

Type: integer

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

Type: null

Uid

Default: null

Any of

Option 1
Option 2

Type: integer

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

Type: null

Mode

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Mdev

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Mig Uuid

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Pci

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Productid

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Vendorid

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Proxy

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: string

Type: null

Pathrm

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

USB

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: integer

Type: null

Dev

Default: null

Any of

Option 1
Option 2

Type: integer

Type: null

Product Id

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Vendor Id

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

NIC

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Nic Type

Default: null

Any of

Option 1
Option 2

Type: enum (of string)

Must be one of:

"BRIDGED"
"MACVLAN"

Type: null

Parent

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Mac

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

PCI

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const

Must be one of:

"PCI"

Specific value: "PCI"

Address

Type: string

Must be at least 1 characters long

CDROM

Type: object
No Additional Properties

Name

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Description

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Readonly

Type: boolean Default: false

Dev Type

Type: const

Must be one of:

"CDROM"

Specific value: "CDROM"

Source

Type: string

Must be at least 1 characters long

Boot Priority

Default: null

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 0

Type: null

Result

Type: const

Must be one of:

true

Specific value: true

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: device

device

One of

Disk

name

Name

Any of

description

Description

Any of

readonly

Readonly

dev_type Required

Dev Type

Must be one of:

source

Source

Any of

destination

Destination

Any of

boot_priority

Boot Priority

Any of

io_bus

Io Bus

Must be one of:

storage_pool

Storage Pool

Any of

GPU

name

Name

Any of

description

Description

Any of

readonly

Readonly

dev_type Required

Dev Type

Must be one of:

gpu_type Required

Gpu Type

Must be one of:

id

Id

Any of

gid

Gid

Any of

uid

Uid

Any of

mode

Mode

Any of

mdev

Mdev

Any of

mig_uuid

Mig Uuid

Any of

pci

Pci

Any of

productid

Productid

Any of

vendorid

Vendorid

Any of

Proxy

name

Name

Any of