Retrieve an NVMe subsystem host

09/09/2025

PDFs

GET /protocols/nvme/subsystems/{subsystem.uuid}/hosts/{nqn}

Introduced In: 9.6

Retrieves an NVMe subsystem host of an NVMe subsystem.

vserver nvme subsystem host show

Learn more

DOC /protocols/nvme/subsystems

Parameters

Name	Type	In	Required	Description
subsystem.uuid	string	path	True	The unique identifier of the NVMe subsystem.
nqn	string	path	True	The NVMe qualified name (NQN) used to identify the NVMe subsystem host.
fields	array[string]	query	False	Specify the fields to return.

Name

Type

Required

Description

subsystem.uuid

string

path

True

The unique identifier of the NVMe subsystem.

nqn

string

path

True

The NVMe qualified name (NQN) used to identify the NVMe subsystem host.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok

Name	Type	Description
_links	_links
dh_hmac_chap	dh_hmac_chap	A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.
io_queue	io_queue	The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
nqn	string	The NVMe qualified name (NQN) used to identify the NVMe storage target.
priority	string	The host priority setting allocates appropriate NVMe I/O queues (count and depth) for the host to submit I/O commands. Absence of this property in GET implies io_queue count and I/O queue depth are being used.
subsystem	subsystem	The NVMe subsystem to which the NVMe host has been provisioned.
tls	tls	A container for the configuration for NVMe/TCP-TLS transport session for the host.

Name

Type

Description

_links

dh_hmac_chap

A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

nqn

string

The NVMe qualified name (NQN) used to identify the NVMe storage target.

priority

string

The host priority setting allocates appropriate NVMe I/O queues (count and depth) for the host to submit I/O commands. Absence of this property in GET implies io_queue count and I/O queue depth are being used.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

tls

A container for the configuration for NVMe/TCP-TLS transport session for the host.

Example response

{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "dh_hmac_chap": {
    "group_size": "string",
    "hash_function": "string",
    "mode": "bidirectional"
  },
  "io_queue": {
    "count": 4,
    "depth": 32
  },
  "nqn": "nqn.1992-01.example.com:string",
  "priority": "string",
  "subsystem": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "subsystem1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "tls": {
    "key_type": "configured"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
72090001	The NVMe subsystem does not exist.
72090004	The NVMe subsystem host does not exist.
72090022	The NVMe subsystem host does not exist in the specified subsystem.

Also see the table of common errors in the Response body overview section of this documentation.

Name	Type	Description
error	returned_error

Name

Type

Description

error

returned_error

Example error

{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

dh_hmac_chap

A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.

Name Type Description

Name	Type	Description
group_size	string	The Diffie-Hellman group size for NVMe in-band authentication. When property `host_secret_key` is provided, this property defaults to `2048_bit`. When supplied, the property `host_secret_key` must also be supplied. Optional in POST.
hash_function	string	The hash function for NVMe in-band authentication. When property `host_secret_key` is provided, this property defaults to `sha_256`. When supplied, the property `host_secret_key` must also be supplied. Optional in POST.
mode	string	The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to: none: The host has neither the host nor controller secret configured, and no authentication is performed. unidirectional: The host has a host secret configured. The controller will authenticate the host. bidirectional: The host has both a host and controller secret configured. The controller will authenticate the host and the host will authenticate the controller.

group_size

string

The Diffie-Hellman group size for NVMe in-band authentication. When property host_secret_key is provided, this property defaults to 2048_bit. When supplied, the property host_secret_key must also be supplied. Optional in POST.

hash_function

string

The hash function for NVMe in-band authentication. When property host_secret_key is provided, this property defaults to sha_256. When supplied, the property host_secret_key must also be supplied. Optional in POST.

mode

string

The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to:

none: The host has neither the host nor controller secret configured, and no authentication is performed.
unidirectional: The host has a host secret configured. The controller will authenticate the host.
bidirectional: The host has both a host and controller secret configured. The controller will authenticate the host and the host will authenticate the controller.

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

Name	Type	Description
count	integer	The number of I/O queue pairs. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue count is being used. Valid in GET only.
depth	integer	The I/O queue depth. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue depth is being used. Valid in GET only.

Name

Type

Description

count

integer

The number of I/O queue pairs. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue count is being used. Valid in GET only.

depth

integer

The I/O queue depth. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue depth is being used. Valid in GET only.

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

Name	Type	Description
count	integer	The number of I/O queue pairs. The default value is inherited from the owning NVMe subsystem.
depth	integer	The I/O queue depth. The default value is inherited from the owning NVMe subsystem.

Name

Type

Description

count

integer

The number of I/O queue pairs. The default value is inherited from the owning NVMe subsystem.

depth

integer

The I/O queue depth. The default value is inherited from the owning NVMe subsystem.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

Name	Type	Description
_links	_links
name	string	The name of the NVMe subsystem.
uuid	string	The unique identifier of the NVMe subsystem.

Name

Type

Description

_links

name

string

The name of the NVMe subsystem.

uuid

string

The unique identifier of the NVMe subsystem.

tls

A container for the configuration for NVMe/TCP-TLS transport session for the host.

Name Type Description

Name	Type	Description
key_type	string	The method by which the TLS pre-shared key (PSK) is configured for the host. Optional in POST. The values for property `key_type` and property `configured_psk` must logically agree. Possible values: `none` - TLS is not configured for the host connection. No value is allowed for property `configured_psk`. `configured` - A user supplied PSK is configured for the NVMe/TCP-TLS transport connection between the host and the NVMe subsystem. A valid value for property `configured_psk` is required. This property defaults to `none` unless a value is supplied for `configured_psk` in which case it defaults to `configured`.

key_type

string

The method by which the TLS pre-shared key (PSK) is configured for the host. Optional in POST.

The values for property key_type and property configured_psk must logically agree.

Possible values:

none - TLS is not configured for the host connection. No value is allowed for property configured_psk.
configured - A user supplied PSK is configured for the NVMe/TCP-TLS transport connection between the host and the NVMe subsystem. A valid value for property configured_psk is required.

This property defaults to none unless a value is supplied for configured_psk in which case it defaults to configured.

records

The NVMe host provisioned to access NVMe namespaces mapped to a subsystem.

Name Type Description

Name	Type	Description
_links	_links
dh_hmac_chap	dh_hmac_chap	A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.
io_queue	io_queue	The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
nqn	string	The NVMe qualified name (NQN) used to identify the NVMe storage target. Not allowed in POST when the `records` property is used.
subsystem	subsystem	The NVMe subsystem to which the NVMe host has been provisioned.
tls	tls	A container for the configuration for NVMe/TCP-TLS transport session for the host.

_links

dh_hmac_chap

A container for the configuration of NVMe in-band authentication using the DH-HMAC-CHAP protocol for a host.

io_queue

The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.

nqn

string

The NVMe qualified name (NQN) used to identify the NVMe storage target. Not allowed in POST when the records property is used.

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.

tls

A container for the configuration for NVMe/TCP-TLS transport session for the host.

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

returned_error

Name	Type	Description
arguments	array[error_arguments]	Message arguments
code	string	Error code
message	string	Error message
target	string	The target parameter that caused the error.

Name

Type

Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

Retrieve an NVMe subsystem host

Creating your file...

Related ONTAP commands

Learn more

Parameters

Response

Error

Definitions