virt.instance.query¶
Query all instances with query-filters and query-options.
Type: object
No Additional Properties
No Additional Items
Type: array
No Additional Items
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
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: objectDefault:
{
"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
Type: boolean Default: trueExtend
Default: null Type: string
Type: null
Extend Context
Default: null Type: string
Type: null
Prefix
Default: null Type: string
Type: null
Extra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Select
Type: array Default: []No Additional Items
Each item of this array must be:
Type: string
Type: array
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseResult
Type: array of object
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
Each item of this array must be:
VirtInstanceQueryResultItem
Type: objectNo Additional Properties
Id
Type: stringName
Type: stringMust be at least 1
characters long
Must be at most 200
characters long
Type
Type: enum (of string)Must be one of:
- "CONTAINER"
- "VM"
Status
Type: enum (of string)Must be one of:
- "RUNNING"
- "STOPPED"
- "UNKNOWN"
Cpu
Type: string
Type: null
Memory
Type: integer
Type: null
Autostart
Type: booleanEnvironment
Type: objectEach additional property must conform to the following schema
Type: stringAliases
Type: arrayNo Additional Items
Each item of this array must be:
Type: object
Type: object
Type: object
Type: null
Raw
Type: object
Type: null
Vnc Enabled
Type: booleanVnc Port
Type: integer
Type: null
Vnc Password
Type: string
Must be at least 1
characters long
Type: null
Secure Boot
Type: boolean
Type: null
Root Disk Size
Type: integer
Type: null
Root Disk Io Bus
Type: enum (of null or string)Must be one of:
- "NVME"
- "VIRTIO-BLK"
- "VIRTIO-SCSI"
- null
Storage Pool
Type: stringStorage pool in which the root of the instance is located.
Must be at least 1
characters long
VirtInstanceQueryResultItem
Type: objectNo Additional Properties
Id
Type: stringName
Type: stringMust be at least 1
characters long
Must be at most 200
characters long
Type
Type: enum (of string)Must be one of:
- "CONTAINER"
- "VM"
Status
Type: enum (of string)Must be one of:
- "RUNNING"
- "STOPPED"
- "UNKNOWN"
Cpu
Type: string
Type: null
Memory
Type: integer
Type: null
Autostart
Type: booleanEnvironment
Type: objectEach additional property must conform to the following schema
Type: stringAliases
Type: arrayNo Additional Items
Each item of this array must be:
Type: object
Type: object
Type: object
Type: null
Raw
Type: object
Type: null
Vnc Enabled
Type: booleanVnc Port
Type: integer
Type: null
Vnc Password
Type: string
Must be at least 1
characters long
Type: null
Secure Boot
Type: boolean
Type: null
Root Disk Size
Type: integer
Type: null
Root Disk Io Bus
Type: enum (of null or string)Must be one of:
- "NVME"
- "VIRTIO-BLK"
- "VIRTIO-SCSI"
- null
Storage Pool
Type: stringStorage pool in which the root of the instance is located.
Must be at least 1
characters long
Type: integer
Required roles: VIRT_INSTANCE_READ