vm.query¶
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:
VMQueryResultItem
Type: objectNo Additional Properties
Command Line Args
Type: stringCpu Mode
Type: enum (of string)Must be one of:
- "CUSTOM"
- "HOST-MODEL"
- "HOST-PASSTHROUGH"
Cpu Model
Type: string
Type: null
Name
Type: stringMust be at least 1
characters long
Description
Type: stringVcpus
Type: integerValue must be greater or equal to 1
Cores
Type: integerValue must be greater or equal to 1
Threads
Type: integerValue must be greater or equal to 1
Cpuset
Type: string
Type: null
Nodeset
Type: string
Type: null
Enable Cpu Topology Extension
Type: booleanPin Vcpus
Type: booleanSuspend On Snapshot
Type: booleanTrusted Platform Module
Type: booleanMemory
Type: integerValue must be greater or equal to 20
Min Memory
Type: integer
Value must be greater or equal to 20
Type: null
Hyperv Enlightenments
Type: booleanBootloader
Type: enum (of string)Must be one of:
- "UEFI_CSM"
- "UEFI"
Bootloader Ovmf
Type: stringAutostart
Type: booleanHide From Msr
Type: booleanEnsure Display Device
Type: booleanTime
Type: enum (of string)Must be one of:
- "LOCAL"
- "UTC"
Shutdown Timeout
Type: integerValue must be greater or equal to 5
and lesser or equal to 300
Arch Type
Type: string
Type: null
Machine Type
Type: string
Type: null
Uuid
Type: string
Type: null
Devices
Type: arrayNo Additional Items
Each item of this array must be:
Type: object
Display Available
Type: booleanId
Type: integer Type: object
VMQueryResultItem
Type: objectNo Additional Properties
Command Line Args
Type: stringCpu Mode
Type: enum (of string)Must be one of:
- "CUSTOM"
- "HOST-MODEL"
- "HOST-PASSTHROUGH"
Cpu Model
Type: string
Type: null
Name
Type: stringMust be at least 1
characters long
Description
Type: stringVcpus
Type: integerValue must be greater or equal to 1
Cores
Type: integerValue must be greater or equal to 1
Threads
Type: integerValue must be greater or equal to 1
Cpuset
Type: string
Type: null
Nodeset
Type: string
Type: null
Enable Cpu Topology Extension
Type: booleanPin Vcpus
Type: booleanSuspend On Snapshot
Type: booleanTrusted Platform Module
Type: booleanMemory
Type: integerValue must be greater or equal to 20
Min Memory
Type: integer
Value must be greater or equal to 20
Type: null
Hyperv Enlightenments
Type: booleanBootloader
Type: enum (of string)Must be one of:
- "UEFI_CSM"
- "UEFI"
Bootloader Ovmf
Type: stringAutostart
Type: booleanHide From Msr
Type: booleanEnsure Display Device
Type: booleanTime
Type: enum (of string)Must be one of:
- "LOCAL"
- "UTC"
Shutdown Timeout
Type: integerValue must be greater or equal to 5
and lesser or equal to 300
Arch Type
Type: string
Type: null
Machine Type
Type: string
Type: null
Uuid
Type: string
Type: null
Devices
Type: arrayNo Additional Items
Each item of this array must be:
Type: object
Display Available
Type: booleanId
Type: integer Type: object
Type: integer
Required roles: