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

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: options

options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples
are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.

order_by

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may
also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
any null values at the head of the results list), nulls_last: (place any null values at the tail of the
results list).

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character .
may be used to explicitly select only subkeys of the query result.

No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails
if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option
it may be used to implement pagination of large results arrays. WARNING: some query methods provide
volatile results and the onus is on the developer to understand whether pagination is appropriate
for a particular query API method.

limit

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When
combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
pagination is appropriate for a particular query API method.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

VirtInstanceEntry

Type: object
No Additional Properties

id Required

Id

Type: string

name Required

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

Type: enum (of string) Default: "CONTAINER"

Must be one of:

• "CONTAINER"
• "VM"

status Required

Status

Type: enum (of string)

Must be one of:

• "RUNNING"
• "STOPPED"
• "UNKNOWN"
• "ERROR"
• "FROZEN"
• "STARTING"
• "STOPPING"
• "FREEZING"
• "THAWED"
• "ABORTING"

cpu Required

Cpu

Any of

• Option 1
• Option 2

Type: string

Type: null

memory Required

Memory

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart Required

Autostart

Type: boolean

environment Required

Environment

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases Required

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

type Required

Type

Type: enum (of string)

Must be one of:

• "INET"
• "INET6"

address Required

Address

Type: string

Must be at least 1 characters long

netmask Required

Netmask

Any of

• Option 1
• Option 2

Type: integer

Type: null

image Required

Image

Type: object
No Additional Properties

architecture Required

Architecture

Any of

• Option 1
• Option 2

Type: string

Type: null

description Required

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

os Required

Os

Any of

• Option 1
• Option 2

Type: string

Type: null

release Required

Release

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Any of

• Option 1
• Option 2

Type: string

Type: null

variant Required

Variant

Any of

• Option 1
• Option 2

Type: string

Type: null

secureboot Required

Secureboot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

userns_idmap Required

Any of

• UserNsIdmap
• Option 2

UserNsIdmap

Type: object
No Additional Properties

uid Required

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

gid Required

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

maprange Required

Maprange

Type: integer

nsid Required

Nsid

Type: integer

Type: null

Type: null

raw Required

Raw

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled Required

Vnc Enabled

Type: boolean

vnc_port Required

Vnc Port

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password Required

Vnc Password

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot Required

Secure Boot

Any of

• Option 1
• Option 2

Type: boolean

Type: null

privileged_mode Required

Privileged Mode

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size Required

Root Disk Size

Any of

• Option 1
• Option 2

Type: integer

Type: null

root_disk_io_bus Required

Root Disk Io Bus

Type: enum (of null or string)

Must be one of:

• "NVME"
• "VIRTIO-BLK"
• "VIRTIO-SCSI"
• null

storage_pool Required

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