vm.device.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

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

Return value

Result

Any of

• Option 1
• VMDeviceQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

VMDeviceQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

attributes

Attributes

One of

• VMCDROMDevice
• VMDisplayDevice
• VMNICDevice
• VMPCIDevice
• VMRAWDevice
• VMDiskDevice
• VMUSBDevice

VMCDROMDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Must be one of:

• "CDROM"

Specific value: "CDROM"

path

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 Required

Dtype

Type: const

Must be one of:

• "DISPLAY"

Specific value: "DISPLAY"

resolution

Resolution

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

Must be one of:

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

port

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

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

Bind

Type: string Default: "127.0.0.1"

Must be at least 1 characters long

wait

Wait

Type: boolean Default: false

password Required

Password

Type: string

Must be at least 1 characters long

web

Web

Type: boolean Default: true

type

Type

Type: const Default: "SPICE"

Must be one of:

• "SPICE"

Specific value: "SPICE"

VMNICDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Must be one of:

• "NIC"

Specific value: "NIC"

trust_guest_rx_filters

Trust Guest Rx Filters

Type: boolean Default: false

type

Type

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

Must be one of:

• "E1000"
• "VIRTIO"

nic_attach

Nic Attach

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

mac

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 Required

Dtype

Type: const

Must be one of:

• "PCI"

Specific value: "PCI"

pptdev Required

Pptdev

Type: string

Must be at least 1 characters long

VMRAWDevice

Type: object
No Additional Properties

dtype Required

Dtype

Type: const

Must be one of:

• "RAW"

Specific value: "RAW"

path

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

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

Must be one of:

• "AHCI"
• "VIRTIO"

exists

Exists

Type: boolean Default: false

boot

Boot

Type: boolean Default: false

size

Size

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

logical_sectorsize

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

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

Iotype

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

Must be one of:

• "NATIVE"
• "THREADS"
• "IO_URING"

serial

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 Required

Dtype

Type: const

Must be one of:

• "DISK"

Specific value: "DISK"

path

Path

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

type

Type

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

Must be one of:

• "AHCI"
• "VIRTIO"

create_zvol

Create Zvol

Type: boolean Default: false

zvol_name

Zvol Name

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

zvol_volsize

Zvol Volsize

Default: null

Any of

• Option 1
• Option 2

Type: integer

Type: null

logical_sectorsize

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

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

Iotype

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

Must be one of:

• "NATIVE"
• "THREADS"
• "IO_URING"

serial

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 Required

Dtype

Type: const

Must be one of:

• "USB"

Specific value: "USB"

usb

Default: null

Any of

• USBAttributes
• Option 2

USBAttributes

Type: object
No Additional Properties

vendor_id

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

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

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

Device

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

vm

Vm

Type: integer

order

Order

Type: integer

VMDeviceQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

attributes

Attributes

One of

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

Type: object

vm

Vm

Type: integer

order

Order

Type: integer

Type: integer

Required roles: VM_DEVICE_READ