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

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

NVMetNamespaceEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the NVMe-oF namespace.

Nsid

Default: null

Namespace ID (NSID).

Each namespace within a subsystem has an associated NSID, unique within that subsystem.

If not supplied during namespace creation then the next available NSID will be used.

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 1 and strictly lesser than 4294967295

Type: null

NVMetSubsysEntry

Type: object

NVMe-oF subsystem that contains this namespace.

No Additional Properties

Id

Type: integer

Unique identifier for the NVMe-oF subsystem.

Name

Type: string

Human readable name for the subsystem.

If subnqn is not provided on creation, then this name will be appended to the basenqn from nvmet.global.config to generate a subnqn.

Must be at least 1 characters long

Subnqn

Default: null

NVMe Qualified Name (NQN) for the subsystem.

If not provided during creation, will be auto-generated by appending the name to the basenqn from nvmet.global.config.

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Serial

Type: string

Serial number assigned to the subsystem.

Allow Any Host

Type: boolean Default: false

Any host can access the storage associated with this subsystem (i.e. no access control).

Pi Enable

Default: null

Enable Protection Information (PI) for data integrity checking.

Any of

Option 1
Option 2

Type: boolean

Type: null

Qid Max

Default: null

Maximum number of queue IDs allowed for this subsystem.

Any of

Option 1
Option 2

Type: integer

Type: null

Ieee Oui

Default: null

IEEE Organizationally Unique Identifier for the subsystem.

Any of

Option 1
Option 2

Type: string

Type: null

Ana

Default: null

If set to either True or False, then override the global ana setting from nvmet.global.config for this subsystem only.

If null, then the global ana setting will take effect.

Any of

Option 1
Option 2

Type: boolean

Type: null

Hosts

Default: []

List of host ids which have access to this subsystem.

Only populated on query if extra.options.verbose is set.

Any of

Option 1
Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

Namespaces

Default: []

List of namespaces ids in this subsystem.

Only populated on query if extra.options.verbose is set.

Any of

Option 1
Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

Ports

Default: []

List of ports ids on which this subsystem is available.

Only populated on query if extra.options.verbose is set.

Any of

Option 1
Option 2

Type: array of integer
No Additional Items

Each item of this array must be:

Type: integer

Type: null

Device Type

Type: enum (of string)

Type of device (or file) used to implement the namespace.

Must be one of:

"ZVOL"
"FILE"

Device Path

Type: string

Path to the device or file being used to implement the namespace.

When device_type is:

"ZVOL": device_path is e.g. "zvol/poolname/zvolname"
"FILE": device_path is e.g. "/mnt/poolmnt/path/to/file". The file will be created if necessary.

Must be at least 1 characters long

Filesize

Default: null

When device_type is "FILE" then this will be the size of the file in bytes.

Any of

Option 1
Option 2

Type: integer

Type: null

Device Uuid

Type: string

Unique device identifier for the namespace.

Must be at least 1 characters long

Device Nguid

Type: string

Namespace Globally Unique Identifier for the namespace.

Must be at least 1 characters long

Enabled

Type: boolean Default: true

If enabled is False then the namespace will not be accessible.

Some namespace configuration changes are blocked when that namespace is enabled.

Locked

Reflect the locked state of the namespace.

The underlying device_path could be an encrypted ZVOL, or a file on an encrypted dataset. In either case locked will be True if the underlying entity is locked.

Any of

Option 1
Option 2

Type: boolean

Type: null

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

NVMetNamespaceEntry

id Required

Id

nsid

Nsid

Any of

subsys Required

NVMetSubsysEntry

id Required

Id

name Required

Name

subnqn

Subnqn

Any of

serial Required

Serial

allow_any_host

Allow Any Host

pi_enable

Pi Enable

Any of

qid_max

Qid Max

Any of

ieee_oui

Ieee Oui

Any of

ana

Ana

Any of

hosts

Hosts

Any of

Each item of this array must be:

namespaces

Namespaces

Any of

Each item of this array must be:

ports

Ports

Any of

Each item of this array must be:

device_type Required

Device Type

Must be one of:

device_path Required

Device Path

filesize

Filesize

Any of

device_uuid Required

Device Uuid