virt.instance.device_list

List all devices associated to an instance.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Return value

Result

Type: array
No Additional Items

Each item of this array must be:

One of

• Disk
• GPU
• Proxy
• TPM
• USB
• NIC
• PCI
• CDROM

Disk

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "DISK"

Specific value: "DISK"

source

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

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

destination

Destination

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

boot_priority

Boot Priority

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 0

Type: null

io_bus

Io Bus

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

Must be one of:

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

storage_pool

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

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "GPU"

Specific value: "GPU"

gpu_type Required

Gpu Type

Type: enum (of string)

Must be one of:

• "PHYSICAL"
• "MDEV"
• "MIG"
• "SRIOV"

id

Id

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

gid

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

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

Mode

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

mdev

Mdev

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

mig_uuid

Mig Uuid

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

pci

Pci

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

productid

Productid

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

vendorid

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

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "PROXY"

Specific value: "PROXY"

source_proto Required

Source Proto

Type: enum (of string)

Must be one of:

• "UDP"
• "TCP"

source_port Required

Source Port

Type: integer

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

dest_proto Required

Dest Proto

Type: enum (of string)

Must be one of:

• "UDP"
• "TCP"

dest_port Required

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

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "TPM"

Specific value: "TPM"

path

Path

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

pathrm

Pathrm

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

USB

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "USB"

Specific value: "USB"

bus

Bus

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

dev

Dev

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

product_id

Product Id

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

vendor_id

Vendor Id

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

NIC

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "NIC"

Specific value: "NIC"

network

Network

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

nic_type

Nic Type

Default: null

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "BRIDGED"
• "MACVLAN"

Type: null

parent

Parent

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

mac

Mac

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

PCI

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "PCI"

Specific value: "PCI"

address Required

Address

Type: string

Must be at least 1 characters long

CDROM

Type: object
No Additional Properties

name

Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

description

Description

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

readonly

Readonly

Type: boolean Default: false

dev_type Required

Dev Type

Type: const

Must be one of:

• "CDROM"

Specific value: "CDROM"

source Required

Source

Type: string

Must be at least 1 characters long

boot_priority

Boot Priority

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 0

Type: null

Required roles: VIRT_INSTANCE_READ