Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

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

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

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

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:

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
        "username",
        "Authentication.status"
    ]

Count

Type: boolean Default: false

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

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

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

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

Type: boolean Default: false

VMEntry

Type: object
No 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

Any of

Option 1
Option 2

Type: string

Type: null

Name

Type: string

Must be at least 1 characters long

Description

Type: string Default: ""

Vcpus

Type: integer Default: 1

Value must be greater or equal to 1

Cores

Type: integer Default: 1

Value must be greater or equal to 1

Threads

Type: integer Default: 1

Value must be greater or equal to 1

Cpuset

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Nodeset

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Enable Cpu Topology Extension

Type: boolean Default: false

Pin Vcpus

Type: boolean Default: false

Suspend On Snapshot

Type: boolean Default: false

Trusted Platform Module

Type: boolean Default: false

Memory

Type: integer

Value must be greater or equal to 20

Min Memory

Default: null

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 20

Type: null

Hyperv Enlightenments

Type: boolean Default: false

Bootloader

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: true

Hide From Msr

Type: boolean Default: false

Ensure Display Device

Type: boolean Default: true

Time

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

Must be one of:

"LOCAL"
"UTC"

Shutdown Timeout

Type: integer Default: 90

Value must be greater or equal to 5 and lesser or equal to 300

Arch Type

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Machine Type

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Uuid

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Devices

Type: array of object
No Additional Items

Each item of this array must be:

VMDeviceEntry

Type: object
No Additional Properties

Id

Type: integer

Attributes

One of

VMCDROMDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"CDROM"

Specific value: "CDROM"

Path

Type: string Default: "*"

Path must not contain "{", "}" characters, and it should start with "/mnt/".

Must match regular expression: ^/mnt/[^{}]*$

Must be at least 1 characters long

VMDisplayDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"DISPLAY"

Specific value: "DISPLAY"

Resolution

Type: enum (of string) Default: "1024x768"

Must be one of:

"1920x1200"
"1920x1080"
"1600x1200"
"1600x900"
"1400x1050"
"1280x1024"
"1280x720"
"1024x768"
"800x600"
"640x480"

Port

Default: null

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 5900 and lesser or equal to 65535

Type: null

Web Port

Default: null

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 5900 and lesser or equal to 65535

Type: null

Bind

Type: string Default: "127.0.0.1"

Must be at least 1 characters long

Wait

Type: boolean Default: false

Password

Type: string

Must be at least 1 characters long

Web

Type: boolean Default: true

Type

Type: const Default: "SPICE"

Must be one of:

"SPICE"

Specific value: "SPICE"

VMNICDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"NIC"

Specific value: "NIC"

Trust Guest Rx Filters

Type: boolean Default: false

Type

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

Must be one of:

"E1000"
"VIRTIO"

Nic Attach

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Mac

Default: null

Any of

Option 1
Option 2

Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$

Type: null

VMPCIDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"PCI"

Specific value: "PCI"

Pptdev

Type: string

Must be at least 1 characters long

VMRAWDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"RAW"

Specific value: "RAW"

Path

Type: string Default: "127.0.0.1"

Path must not contain "{", "}" characters.

Must match regular expression: ^[^{}]*$

Must be at least 1 characters long

Type

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

Must be one of:

"AHCI"
"VIRTIO"

Exists

Type: boolean Default: false

Boot

Type: boolean Default: false

Size

Default: null

Any of

Option 1
Option 2

Type: integer

Type: null

Logical Sectorsize

Default: null

Any of

Option 1
Option 2

Type: enum (of integer or null)

Must be one of:

null
512
4096

Type: null

Physical Sectorsize

Default: null

Any of

Option 1
Option 2

Type: enum (of integer or null)

Must be one of:

null
512
4096

Type: null

Iotype

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

Must be one of:

"NATIVE"
"THREADS"
"IO_URING"

Serial

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

VMDiskDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"DISK"

Specific value: "DISK"

Path

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Type

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

Must be one of:

"AHCI"
"VIRTIO"

Create Zvol

Type: boolean Default: false

Zvol Name

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Zvol Volsize

Default: null

Any of

Option 1
Option 2

Type: integer

Type: null

Logical Sectorsize

Default: null

Any of

Option 1
Option 2

Type: enum (of integer or null)

Must be one of:

null
512
4096

Type: null

Physical Sectorsize

Default: null

Any of

Option 1
Option 2

Type: enum (of integer or null)

Must be one of:

null
512
4096

Type: null

Iotype

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

Must be one of:

"NATIVE"
"THREADS"
"IO_URING"

Serial

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

VMUSBDevice

Type: object
No Additional Properties

Dtype

Type: const

Must be one of:

"USB"

Specific value: "USB"

Default: null

Any of

USBAttributes
Option 2

USBAttributes

Type: object
No Additional Properties

Vendor Id

Type: string Default: "127.0.0.1"

Vendor id must start with "0x" prefix e.g 0x16a8.

Must match regular expression: ^0x.*

Must be at least 1 characters long

Product Id

Type: string Default: "127.0.0.1"

Product id must start with "0x" prefix e.g 0x16a8.

Must match regular expression: ^0x.*

Must be at least 1 characters long

Type: null

Controller Type

Type: enum (of string) Default: "nec-xhci"

Must be one of:

"piix3-uhci"
"piix4-uhci"
"ehci"
"ich9-ehci1"
"vt82c686b-uhci"
"pci-ohci"
"nec-xhci"
"qemu-xhci"

Device

Default: null

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Vm

Type: integer

Order

Type: integer

Display Available

Type: boolean

Id

Type: integer

VMStatus

Type: object
No Additional Properties

State

Type: string

Must be at least 1 characters long

Pid

Any of

Option 1
Option 2

Type: integer

Type: null

Domain State

Type: string

Must be at least 1 characters long

Enable Secure Boot

Type: boolean Default: false

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: options

options

extra

Extra

order_by

Order By

Each item of this array must be:

select

Select

Each item of this array must be:

Any of

Each item of this array must be:

count

Count

get

Get

offset

Offset

limit

Limit

force_sql_filters

Force Sql Filters

Return value

VMEntry

command_line_args

Command Line Args

cpu_mode

Cpu Mode

Must be one of:

cpu_model

Cpu Model

Any of

name Required

Name

description

Description

vcpus

Vcpus

cores

Cores

threads

Threads

cpuset

Cpuset

Any of

nodeset

Nodeset

Any of

enable_cpu_topology_extension

Enable Cpu Topology Extension

pin_vcpus

Pin Vcpus

suspend_on_snapshot

Suspend On Snapshot

trusted_platform_module

Trusted Platform Module

memory Required

Memory

min_memory

Min Memory

Any of

hyperv_enlightenments

Hyperv Enlightenments

bootloader

Bootloader

Must be one of:

bootloader_ovmf

Bootloader Ovmf

autostart

Autostart

hide_from_msr

Hide From Msr

ensure_display_device

Ensure Display Device

time

Time