Table Of Contents

Previous topic

vm.poweroff

Next topic

vm.random_mac

vm.query

Type: object

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

Type: boolean Default: true

Extend

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
Each item of this array must be:
Type: object

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

Result


Type: array of object
No Additional Items
Each item of this array must be:

VMQueryResultItem

Type: object
No Additional Properties

Command Line Args

Type: string

Cpu Mode

Type: enum (of string)
Must be one of:
  • "CUSTOM"
  • "HOST-MODEL"
  • "HOST-PASSTHROUGH"

Cpu Model


Type: string
Type: null

Name

Type: string

Must be at least 1 characters long

Description

Type: string

Vcpus

Type: integer

Value must be greater or equal to 1

Cores

Type: integer

Value must be greater or equal to 1

Threads

Type: integer

Value must be greater or equal to 1

Cpuset


Type: string
Type: null

Nodeset


Type: string
Type: null

Enable Cpu Topology Extension

Type: boolean

Pin Vcpus

Type: boolean

Suspend On Snapshot

Type: boolean

Trusted Platform Module

Type: boolean

Memory

Type: integer

Value must be greater or equal to 20

Min Memory


Type: integer

Value must be greater or equal to 20

Type: null

Hyperv Enlightenments

Type: boolean

Bootloader

Type: enum (of string)
Must be one of:
  • "UEFI_CSM"
  • "UEFI"

Bootloader Ovmf

Type: string

Autostart

Type: boolean

Hide From Msr

Type: boolean

Ensure Display Device

Type: boolean

Time

Type: enum (of string)
Must be one of:
  • "LOCAL"
  • "UTC"

Shutdown Timeout

Type: integer

Value 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: array
No Additional Items
Each item of this array must be:
Type: object

Display Available

Type: boolean

Id

Type: integer

Type: object

VMQueryResultItem

Type: object
No Additional Properties

Command Line Args

Type: string

Cpu Mode

Type: enum (of string)
Must be one of:
  • "CUSTOM"
  • "HOST-MODEL"
  • "HOST-PASSTHROUGH"

Cpu Model


Type: string
Type: null

Name

Type: string

Must be at least 1 characters long

Description

Type: string

Vcpus

Type: integer

Value must be greater or equal to 1

Cores

Type: integer

Value must be greater or equal to 1

Threads

Type: integer

Value must be greater or equal to 1

Cpuset


Type: string
Type: null

Nodeset


Type: string
Type: null

Enable Cpu Topology Extension

Type: boolean

Pin Vcpus

Type: boolean

Suspend On Snapshot

Type: boolean

Trusted Platform Module

Type: boolean

Memory

Type: integer

Value must be greater or equal to 20

Min Memory


Type: integer

Value must be greater or equal to 20

Type: null

Hyperv Enlightenments

Type: boolean

Bootloader

Type: enum (of string)
Must be one of:
  • "UEFI_CSM"
  • "UEFI"

Bootloader Ovmf

Type: string

Autostart

Type: boolean

Hide From Msr

Type: boolean

Ensure Display Device

Type: boolean

Time

Type: enum (of string)
Must be one of:
  • "LOCAL"
  • "UTC"

Shutdown Timeout

Type: integer

Value 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: array
No Additional Items
Each item of this array must be:
Type: object

Display Available

Type: boolean

Id

Type: integer

Type: object
Type: integer


Required roles: