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.

NVMetHostSubsysEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the host-subsystem association.

NVMetHostEntry

Type: object

NVMe-oF host that is authorized to access the subsystem.

No Additional Properties

Id

Type: integer

Unique identifier for the NVMe-oF host.

Hostnqn

Type: string

NQN of the host that will connect to this TrueNAS.

Must be at least 1 characters long

Dhchap Key

Default: null

If set, the secret that the host must present when connecting.

A suitable secret can be generated using nvme gen-dhchap-key, or by using the nvmet.host.generate_key API.

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Dhchap Ctrl Key

Default: null

If set, the secret that this TrueNAS will present to the host when the host is connecting (Bi-Directional Authentication).

A suitable secret can be generated using nvme gen-dhchap-key, or by using the nvmet.host.generate_key API.

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

Type: null

Dhchap Dhgroup

Default: null

If selected, the DH (Diffie-Hellman) key exchange built on top of CHAP to be used for authentication.

Any of

Option 1
Option 2

Type: enum (of string)

Must be one of:

"2048-BIT"
"3072-BIT"
"4096-BIT"
"6144-BIT"
"8192-BIT"

Type: null

Dhchap Hash

Type: enum (of string) Default: "SHA-256"

HMAC (Hashed Message Authentication Code) to be used in conjunction if a dhchap_dhgroup is selected.

Must be one of:

"SHA-256"
"SHA-384"
"SHA-512"

NVMetSubsysEntry

Type: object

NVMe-oF subsystem that the host is authorized to access.

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

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

NVMetHostSubsysEntry

id Required

Id

host Required

NVMetHostEntry

id Required

Id

hostnqn Required

Hostnqn

dhchap_key

Dhchap Key

Any of

dhchap_ctrl_key

Dhchap Ctrl Key

Any of

dhchap_dhgroup

Dhchap Dhgroup

Any of

Must be one of:

dhchap_hash

Dhchap Hash

Must be one 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