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

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string
Parameter 2: options

options

Type: object Default: {}
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

VirtInstanceEntry

Type: object
No Additional Properties

Id

Type: string

Name

Type: string

Must 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: boolean

Environment

Type: object

Each additional property must conform to the following schema

Type: string

Aliases

Type: array
No 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: boolean

Vnc 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: string

Storage pool in which the root of the instance is located.

Must be at least 1 characters long



Required roles: VIRT_INSTANCE_READ