virt.instance.query¶
Query all instances with query-filters and query-options.
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 ItemsEach item of this array must be:
[
    [
        "name",
        "=",
        "bob"
    ]
]
[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 2: options
options
Type: objectQuery 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. 
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). 
Each item of this array must be:
[
    "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. 
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
    "username",
    "Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters. 
Get
Type: boolean Default: falseReturn 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: 0This 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: 0This 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: falseResult
No Additional Items
Each item of this array must be:
VirtInstanceQueryResultItem
Type: objectNo Additional Properties
Id
Type: stringName
Type: stringMust be at least 1 characters long
Must be at most 200 characters long
Type
Type: enum (of string)Must be one of:
- "CONTAINER"
- "VM"
Status
Type: enum (of string)Must be one of:
- "RUNNING"
- "STOPPED"
- "UNKNOWN"
- "ERROR"
- "FROZEN"
- "STARTING"
- "STOPPING"
- "FREEZING"
- "THAWED"
- "ABORTING"
Cpu
Memory
Autostart
Type: booleanEnvironment
Type: objectEach additional property must conform to the following schema
Type: stringAliases
Type: array of objectNo Additional Items
Each item of this array must be:
VirtInstanceAlias
Type: objectNo Additional Properties
Type
Type: enum (of string)Must be one of:
- "INET"
- "INET6"
Address
Type: stringMust be at least 1 characters long
Netmask
Image
Type: objectNo Additional Properties
Architecture
Description
Os
Release
Serial
Type
Variant
Secureboot
UserNsIdmap
Type: objectNo Additional Properties
IdmapUserNsEntry
Type: objectNo Additional Properties
Hostid
Type: integerMaprange
Type: integerNsid
Type: integerIdmapUserNsEntry
Type: objectNo Additional Properties
Hostid
Type: integerMaprange
Type: integerNsid
Type: integerRaw
Vnc Enabled
Type: booleanVnc Port
Vnc Password
Must be at least 1 characters long
Secure Boot
Privileged Mode
Root Disk Size
Root Disk Io Bus
Type: enum (of null or string)Must be one of:
- "NVME"
- "VIRTIO-BLK"
- "VIRTIO-SCSI"
- null
Storage Pool
Type: stringStorage pool in which the root of the instance is located.
Must be at least 1 characters long
VirtInstanceQueryResultItem
Type: objectNo Additional Properties
Id
Type: stringName
Type: stringMust be at least 1 characters long
Must be at most 200 characters long
Type
Type: enum (of string)Must be one of:
- "CONTAINER"
- "VM"
Status
Type: enum (of string)Must be one of:
- "RUNNING"
- "STOPPED"
- "UNKNOWN"
- "ERROR"
- "FROZEN"
- "STARTING"
- "STOPPING"
- "FREEZING"
- "THAWED"
- "ABORTING"
Cpu
Memory
Autostart
Type: booleanEnvironment
Type: objectEach additional property must conform to the following schema
Type: stringAliases
Type: arrayNo Additional Items
Each item of this array must be:
Raw
Vnc Enabled
Type: booleanVnc Port
Vnc Password
Must be at least 1 characters long
Secure Boot
Privileged Mode
Root Disk Size
Root Disk Io Bus
Type: enum (of null or string)Must be one of:
- "NVME"
- "VIRTIO-BLK"
- "VIRTIO-SCSI"
- null
Storage Pool
Type: stringStorage pool in which the root of the instance is located.
Must be at least 1 characters long
Required roles: VIRT_INSTANCE_READ