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

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

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Return value

VirtInstanceEntry

Type: object
No Additional Properties

id Required

Id

Type: string

Unique identifier for the virtual instance.

name Required

Name

Type: string

Human-readable name for the virtual instance.

Must be at least 1 characters long

Must be at most 200 characters long

type

Type

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

Type of virtual instance.

Must be one of:

• "CONTAINER"
• "VM"

status Required

Status

Type: enum (of string)

Current operational status of the virtual instance.

Must be one of:

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

cpu Required

Cpu

CPU configuration string or null for default allocation.

Any of

• Option 1
• Option 2

Type: string

Type: null

memory Required

Memory

Memory allocation in bytes or null for default allocation.

Any of

• Option 1
• Option 2

Type: integer

Type: null

autostart Required

Autostart

Type: boolean

Whether the instance automatically starts when the host boots.

environment Required

Environment

Type: object

Environment variables to set inside the instance.

Additional Properties

Each additional property must conform to the following schema

Type: string

aliases Required

Aliases

Type: array of object

Array of IP aliases configured for the instance.

No Additional Items

Each item of this array must be:

VirtInstanceAlias

Type: object
No Additional Properties

type Required

Type

Type: enum (of string)

Type of IP address (INET for IPv4, INET6 for IPv6).

Must be one of:

• "INET"
• "INET6"

address Required

Address

Type: string

IP address for the virtual instance.

Must be at least 1 characters long

netmask Required

Netmask

Network mask in CIDR notation.

Any of

• Option 1
• Option 2

Type: integer

Type: null

image Required

Image

Type: object

Image information used to create this instance.

No Additional Properties

architecture Required

Architecture

Hardware architecture of the image (e.g., amd64, arm64).

Any of

• Option 1
• Option 2

Type: string

Type: null

description Required

Description

Human-readable description of the image.

Any of

• Option 1
• Option 2

Type: string

Type: null

os Required

Os

Operating system family of the image.

Any of

• Option 1
• Option 2

Type: string

Type: null

release Required

Release

Version or release name of the operating system.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial Required

Serial

Unique serial identifier for the image.

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Type of image (container, virtual-machine, etc.).

Any of

• Option 1
• Option 2

Type: string

Type: null

variant Required

Variant

Image variant (default, cloud, minimal, etc.).

Any of

• Option 1
• Option 2

Type: string

Type: null

secureboot Required

Secureboot

Whether the image supports UEFI Secure Boot.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

userns_idmap Required

User namespace ID mapping configuration for privilege isolation.

Any of

• UserNsIdmap
• Option 2

UserNsIdmap

Type: object
No Additional Properties

uid Required

User ID mapping configuration for user namespace isolation.

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

Starting host ID for the mapping range.

maprange Required

Maprange

Type: integer

Number of IDs to map in this range.

nsid Required

Nsid

Type: integer

Starting namespace ID for the mapping range.

Type: null

gid Required

Group ID mapping configuration for user namespace isolation.

Any of

• IdmapUserNsEntry
• Option 2

IdmapUserNsEntry

Type: object
No Additional Properties

hostid Required

Hostid

Type: integer

Starting host ID for the mapping range.

maprange Required

Maprange

Type: integer

Number of IDs to map in this range.

nsid Required

Nsid

Type: integer

Starting namespace ID for the mapping range.

Type: null

Type: null

raw Required

Raw

Raw low-level configuration options (advanced use only).

Any of

• Option 1
• Option 2

Type: object

Type: null

vnc_enabled Required

Vnc Enabled

Type: boolean

Whether VNC remote access is enabled for the instance.

vnc_port Required

Vnc Port

TCP port number for VNC connections or null if VNC is disabled.

Any of

• Option 1
• Option 2

Type: integer

Type: null

vnc_password Required

Vnc Password

Password for VNC access or null if no password is set.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

secure_boot Required

Secure Boot

Whether UEFI Secure Boot is enabled (VMs only) or null for containers.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

privileged_mode Required

Privileged Mode

Whether the container runs in privileged mode or null for VMs.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

root_disk_size Required

Root Disk Size

Size of the root disk in GB or null for default 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)

I/O bus type for the root disk or null for default.

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