Skip to main content
A newer release of this product is available.

Retrieve an NVMe subsystem host

Contributors
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

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.

Response

Status: 200, Ok
Name Type Description

_links

_links

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.

records

array[records]

An array of NVMe hosts specified to add multiple NVMe hosts to an NVMe subsystem in a single API call. Valid in POST only.

subsystem

subsystem

The NVMe subsystem to which the NVMe host has been provisioned.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "io_queue": {
    "count": "4",
    "depth": "32"
  },
  "nqn": "nqn.1992-01.example.com:string",
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "io_queue": {
        "count": "4",
        "depth": "32"
      },
      "nqn": "nqn.1992-01.example.com:string",
      "subsystem": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ],
  "subsystem": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

72090001

The NVMe subsystem does not exist.
Name Type Description

error

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

_links

Name Type Description

self

href

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.

subsystem

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

Name Type Description

_links

_links

uuid

string

The unique identifier of the NVMe subsystem.

records

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

Name Type Description

_links

_links

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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.