Type: object

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"
        ]
    ]

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 including pagination, ordering, and additional parameters.

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.

Result

Any of

Type: array of object
No Additional Items

Each item of this array must be:

NVMetPortSubsysQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the port-subsystem association.

NVMetPortEntry

Type: object

NVMe-oF port that provides access to the subsystem.

No Additional Properties

Id

Type: integer

Unique identifier for the NVMe-oF port.

Index

Type: integer

Index of the port, for internal use.

Addr Trtype

Type: enum (of string)

Fabric transport technology name.

Must be one of:

"TCP"
"RDMA"
"FC"

Addr Trsvcid

Transport-specific TRSVCID field. When configured for TCP/IP or RDMA this will be the port number.

Any of

Type: integer

Type: string

Must be at least 1 characters long

Type: null

Addr Traddr

Type: string

A transport-specific field identifying the NVMe host port to use for the connection to the controller.

For TCP or RDMA transports, this will be an IPv4 or IPv6 address.

Addr Adrfam

Type: enum (of string)

Address family.

Must be one of:

"IPV4"
"IPV6"
"FC"

Inline Data Size

Default: null

Maximum size for inline data transfers or null for default.

Any of

Option 1
Option 2

Type: integer

Type: null

Max Queue Size

Default: null

Maximum number of queue entries or null for default.

Any of

Option 1
Option 2

Type: integer

Type: null

Pi Enable

Default: null

Whether Protection Information (PI) is enabled or null for default.

Any of

Option 1
Option 2

Type: boolean

Type: null

Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

NVMetSubsysEntry

Type: object

NVMe-oF subsystem that is accessible through the port.

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

NVMetPortSubsysQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the port-subsystem association.

Type: object

NVMe-oF port that provides access to the subsystem.

Type: object

NVMe-oF subsystem that is accessible through the port.

Type: integer

Call parameters

Tuple Validation

Parameter 1: filters

filters

Each item of this array must be:

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

Result

Any of

Each item of this array must be:

NVMetPortSubsysQueryResultItem

id

Id

port

NVMetPortEntry

id Required

Id

index Required

Index

addr_trtype Required

Addr Trtype

Must be one of:

addr_trsvcid Required

Addr Trsvcid

Any of

addr_traddr Required

Addr Traddr

addr_adrfam Required

Addr Adrfam

Must be one of:

inline_data_size

Inline Data Size

Any of

max_queue_size

Max Queue Size

Any of

pi_enable

Pi Enable

Any of

enabled

Enabled

subsys

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