nvmet.port_subsys.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

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

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Fk

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

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

NVMetPortSubsysEntry

Type: object
No Additional Properties

Id

Type: integer

NVMetPortEntry

Type: object
No Additional Properties

Id

Type: integer

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.

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

Type: integer
Type: null

Max Queue Size

Default: null

Type: integer
Type: null

Pi Enable

Default: null

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
No Additional Properties

Id

Type: integer

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

Type: string

Must be at least 1 characters long

Must be at most 223 characters long

Type: null

Serial

Type: string

Allow Any Host

Type: boolean Default: false

If True then any host can access the storage associated with this subsystem (i.e. no access control).

Pi Enable

Default: null

Type: boolean
Type: null

Qid Max

Default: null

Type: integer
Type: null

Ieee Oui

Default: null

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.

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.

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.

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.

Type: array of integer
No Additional Items
Each item of this array must be:
Type: integer
Type: null


Required roles: SHARING_NVME_TARGET_READ