Skip to main content

Retrieve an NVMe subsystem controller

Contributors
PDFs

GET /protocols/nvme/subsystem-controllers/{subsystem.uuid}/{id}

Introduced In: 9.6

Retrieves an NVMe subsystem controller.

  • vserver nvme subsystem controller show

Learn more

Parameters

Name Type In Required Description

subsystem.uuid

string

path

True

The unique identifier of the NVMe subsystem.

id

string

path

True

The unique identifier of the NVMe subsystem controller.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

admin_queue

admin_queue

dh_hmac_chap

dh_hmac_chap

A container for properties of the NVMe in-band authentication DH-HMAC-CHAP protocol used by the the host connection to the controller.

host

host

Properties of the connected host.

id

string

The identifier of the subsystem controller. This field consists of 4 zero-filled hexadecimal digits followed by an 'h'.

interface

interface

The logical interface through which the host is connected.

io_queue

io_queue

Properties of the I/O queues available to the controller.

keep_alive_timeout

integer

The keep-alive timeout value for the controller and all of its host connections, in milliseconds.

If the NVMe controller does not receive a keep-alive request or an I/O request within the timeout window, the NVMe controller terminates its admin queue and I/O queue connections leading to NVMe controller teardown. If the NVMe host does not receive a response to a keep-alive request or an I/O request within the timeout window, the NVMe host initiates a connection disconnect.

node

node

subsystem

subsystem

An NVMe subsystem maintains configuration state and NVMe namespace access control for a set of NVMe-connected hosts.

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "admin_queue": {
    "depth": 0
  },
  "dh_hmac_chap": {
    "group_size": "none",
    "hash_function": "sha_256",
    "mode": "bidirectional"
  },
  "host": {
    "id": "b8546ca6097349e5b1558dc154fc073b",
    "nqn": "nqn.2014-08.org.nvmexpress:uuid:c2846cb1-89d2-4020-a3b0-71ce907b4eef",
    "transport_address": "nn-0x20000090fae00806:pn-0x10000090fae00806"
  },
  "id": "0040h",
  "interface": {
    "name": "lif1",
    "transport_address": "nn-0x200400a0989a1c8d:pn-0x200500a0989a1c8d",
    "uuid": "fa1c5941-2593-11e9-94c4-00a0989a1c8e"
  },
  "io_queue": {
    "count": 0,
    "depth": {
    }
  },
  "keep_alive_timeout": 1500,
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "subsystem": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "subsystem1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

72090001

The supplied subsystem identifier does not exist.

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

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

_links

Name Type Description

self

href

admin_queue

Name Type Description

depth

integer

The depth of the admin queue for the controller.

dh_hmac_chap

A container for properties of the NVMe in-band authentication DH-HMAC-CHAP protocol used by the the host connection to the controller.

Name Type Description

group_size

string

The Diffie-Hellman group size used for NVMe in-band authentication.

hash_function

string

The hash function used for NVMe in-band authentication.

mode

string

The NVMe in-band authentication mode used for the host connection. When set to:

  • none: Neither the host nor controller was authenticated.

  • unidirectional: The controller authenticated the host.

  • bidirectional: The controller authenticated the host and the host authenticated the controller.

host

Properties of the connected host.

Name Type Description

id

string

The host identifier registered with the controller.

nqn

string

The NVMe qualified name of the host.

transport_address

string

The transport address of the host.

interface

The logical interface through which the host is connected.

Name Type Description

name

string

The name of the logical interface.

transport_address

string

The transport address of the logical interface.

uuid

string

The unique identifier of the logical interface.

io_queue

Properties of the I/O queues available to the controller.

Name Type Description

count

integer

The number of I/O queues available to the controller.

depth

array[integer]

The depths of the I/O queues.

node

Name Type Description

_links

_links

name

string

uuid

string

subsystem

An NVMe subsystem maintains configuration state and NVMe namespace access control for a set of NVMe-connected hosts.

Name Type Description

_links

_links

name

string

The name of the NVMe subsystem.

uuid

string

The unique identifier of the NVMe subsystem.

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

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.