virt.instance.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: stringParameter 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: falseVirtInstanceEntry
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) Default: "CONTAINER"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
Required roles: