virt.instance.query

Query all instances with query-filters and query-options.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

Parameter 2: options

options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• VirtInstanceQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

VirtInstanceQueryResultItem

Type: object
No Additional Properties

id

Id

Type: string

name

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

Type: enum (of string)

Must be one of:

• "CONTAINER"
• "VM"

status

Status

Type: enum (of string)

Must be one of:

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

cpu

Cpu

Any of

• Option 1
• Option 2

Type: string

Type: null

memory

Memory

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart

Autostart

Type: boolean

environment

Environment

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

type Required

Type

Type: enum (of string)

Must be one of:

• "INET"
• "INET6"

address Required

Address

Type: string

Must be at least 1 characters long

netmask Required

Netmask

Any of

• Option 1
• Option 2

Type: integer

Type: null

image

Image

Type: object
No Additional Properties

architecture Required

Architecture

Any of

• Option 1
• Option 2

Type: string

Type: null

description Required

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

os Required

Os

Any of

• Option 1
• Option 2

Type: string

Type: null

release Required

Release

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Any of

• Option 1
• Option 2

Type: string

Type: null

variant Required

Variant

Any of

• Option 1
• Option 2

Type: string

Type: null

secureboot Required

Secureboot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

userns_idmap

Any of

• UserNsIdmap
• Option 2

UserNsIdmap

Type: object
No Additional Properties

uid Required

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

gid Required

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

raw

Raw

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled

Vnc Enabled

Type: boolean

vnc_port

Vnc Port

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password

Vnc Password

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot

Secure Boot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size

Root Disk Size

Any of

• Option 1
• Option 2

Type: integer

Type: null

root_disk_io_bus

Root Disk Io Bus

Type: enum (of null or string)

Must be one of:

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

storage_pool

Storage Pool

Type: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long

VirtInstanceQueryResultItem

Type: object
No Additional Properties

id

Id

Type: string

name

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

Type: enum (of string)

Must be one of:

• "CONTAINER"
• "VM"

status

Status

Type: enum (of string)

Must be one of:

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

cpu

Cpu

Any of

• Option 1
• Option 2

Type: string

Type: null

memory

Memory

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart

Autostart

Type: boolean

environment

Environment

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases

Aliases

Type: array
No Additional Items

Each item of this array must be:

Type: object

image

Type: object

userns_idmap

Any of

• Option 1
• Option 2

Type: object

Type: null

raw

Raw

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled

Vnc Enabled

Type: boolean

vnc_port

Vnc Port

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password

Vnc Password

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot

Secure Boot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size

Root Disk Size

Any of

• Option 1
• Option 2

Type: integer

Type: null

root_disk_io_bus

Root Disk Io Bus

Type: enum (of null or string)

Must be one of:

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

storage_pool

Storage Pool

Type: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long

Type: integer

Required roles: VIRT_INSTANCE_READ