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 PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
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).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
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.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
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.
Value must be greater or equal to 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.
Value must be greater or equal to 0 and lesser or equal to 10000
Force use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for the VM device.
Device-specific configuration attributes.
Device type identifier for CD-ROM/DVD devices.
Specific value:"CDROM"
Path must not contain "{", "}" characters, and it should start with "/mnt/".
Must match regular expression:^[^{}]*$
Must be at least 1 characters long
Device type identifier for display/graphics devices.
Specific value:"DISPLAY"
Screen resolution for the virtual display.
VNC/SPICE port number for remote display access. null for auto-assignment.
Value must be greater or equal to 5900 and lesser or equal to 65535
Web-based display access port number. null for auto-assignment.
IP address to bind the display server to.
Must be at least 1 characters long
Whether to wait for a client connection before starting the VM.
Password for display server authentication.
Whether to enable web-based display access.
Display protocol type.
Device type identifier for iSCSI disk devices.
Specific value:"ISCSI_DISK"
IP address of the iSCSI target portal.
""
iSCSI targets to attach, one entry per target IQN.
Must contain a minimum of 1 items
iSCSI Qualified Name of the target.
Must be at least 1 characters long
LUN numbers to access on this target.
Must contain a minimum of 1 items
IQN identifying this VM as an iSCSI initiator.
Must be at least 1 characters long
PCI slot for the virtio-scsi-pci controller on the root bus (pcie.0 on q35/aarch64, pci.0 on i440fx). Conflicts with other explicitly-placed devices are detected at device creation time.
Value must be greater or equal to 1 and lesser or equal to 30
Device type identifier for network interface cards.
Specific value:"NIC"
Whether to trust guest OS receive filter settings for better performance.
Network interface controller type. E1000 for Intel compatibility, VIRTIO for performance.
Host network interface or bridge to attach to. null for no attachment.
MAC address for the virtual network interface. null for auto-generation.
Pin this NIC to a specific PCI controller bus rather than letting libvirt auto-assign an address. null for automatic assignment.
PCI bus number. Must be >= 1; bus 0 is the root complex.
Value must be greater or equal to 1 and lesser or equal to 255
PCI slot number (0-31). No default: correct value depends on machine type.
Value must be greater or equal to 0 and lesser or equal to 31
PCI function number (0-7).
Value must be greater or equal to 0 and lesser or equal to 7
PCI domain number. Must be 0; multi-segment topologies are not supported.
Value must be greater or equal to 0 and lesser or equal to 0
Device type identifier for PCI passthrough devices.
Specific value:"PCI"
Host PCI device identifier to pass through to the VM.
Must be at least 1 characters long
Device type identifier for raw disk devices.
Specific value:"RAW"
Filesystem path to the raw disk device or image file.
Must match regular expression:^[^{}]*$
Must be at least 1 characters long
Disk controller interface type. AHCI for compatibility, VIRTIO for performance.
Whether the disk file already exists or should be created.
Whether this disk should be marked as bootable.
Size of the disk in bytes. Required if creating a new disk file.
Logical sector size for the disk. null for default.
Physical sector size for the disk. null for default.
I/O backend type for disk operations.
Serial number to assign to the virtual disk. null for auto-generated.
Must be at least 1 characters long
Device type identifier for virtual disk devices.
Specific value:"DISK"
Path to existing disk file or ZFS volume. null if creating a new ZFS volume.
Must be at least 1 characters long
Disk controller interface type. AHCI for compatibility, VIRTIO for performance.
Whether to create a new ZFS volume for this disk.
Name for the new ZFS volume. Required if create_zvol is true.
Size of the new ZFS volume in bytes. Required if create_zvol is true.
Logical sector size for the disk. null for default.
Physical sector size for the disk. null for default.
I/O backend type for disk operations.
Serial number to assign to the virtual disk. null for auto-generated.
Must be at least 1 characters long
Device type identifier for USB devices.
Specific value:"USB"
USB device attributes for identification. null for USB host controller only.
USB vendor identifier in hexadecimal format (e.g., '0x1d6b' for Linux Foundation).
Must match regular expression:^0x.*
Must be at least 1 characters long
USB product identifier in hexadecimal format (e.g., '0x0002' for 2.0 root hub).
Must match regular expression:^0x.*
Must be at least 1 characters long
USB controller type for the virtual machine.
Host USB device path to pass through. null for controller only.
Must be at least 1 characters long
ID of the virtual machine this device belongs to.
Boot order priority for this device (lower numbers boot first).