vm.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
Type: object
No Additional Properties
No Additional Items
Type: array
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: options
options
Type: object Default: {}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: falseVMEntry
Type: objectNo Additional Properties
Command Line Args
Type: string Default: ""Cpu Mode
Type: enum (of string) Default: "CUSTOM"Must be one of:
- "CUSTOM"
- "HOST-MODEL"
- "HOST-PASSTHROUGH"
Cpu Model
Default: null Type: string
Type: null
Name
Type: stringMust be at least 1
characters long
Description
Type: string Default: ""Vcpus
Type: integer Default: 1Value must be greater or equal to 1
Cores
Type: integer Default: 1Value must be greater or equal to 1
Threads
Type: integer Default: 1Value must be greater or equal to 1
Cpuset
Default: null Type: string
Type: null
Nodeset
Default: null Type: string
Type: null
Enable Cpu Topology Extension
Type: boolean Default: falsePin Vcpus
Type: boolean Default: falseSuspend On Snapshot
Type: boolean Default: falseTrusted Platform Module
Type: boolean Default: falseMemory
Type: integerValue must be greater or equal to 20
Min Memory
Default: null Type: integer
Value must be greater or equal to 20
Type: null
Hyperv Enlightenments
Type: boolean Default: falseBootloader
Type: enum (of string) Default: "UEFI"Must be one of:
- "UEFI_CSM"
- "UEFI"
Bootloader Ovmf
Type: string Default: "OVMF_CODE.fd"Autostart
Type: boolean Default: trueHide From Msr
Type: boolean Default: falseEnsure Display Device
Type: boolean Default: trueTime
Type: enum (of string) Default: "LOCAL"Must be one of:
- "LOCAL"
- "UTC"
Shutdown Timeout
Type: integer Default: 90Value must be greater or equal to 5
and lesser or equal to 300
Arch Type
Default: null Type: string
Type: null
Machine Type
Default: null Type: string
Type: null
Uuid
Default: null 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
Required roles: