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

Retrieve NVMe subsystem controllers

Contributors
PDFs

GET /protocols/nvme/subsystem-controllers

Introduced In: 9.6

Retrieves NVMe subsystem controllers.

  • vserver nvme subsystem controller show

Learn more

Parameters

Name Type In Required Description

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

io_queue.count

integer

query

False

Filter by io_queue.count

io_queue.depth

integer

query

False

Filter by io_queue.depth

interface.uuid

string

query

False

Filter by interface.uuid

interface.name

string

query

False

Filter by interface.name

interface.transport_address

string

query

False

Filter by interface.transport_address

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

id

string

query

False

Filter by id

host.transport_address

string

query

False

Filter by host.transport_address

host.nqn

string

query

False

Filter by host.nqn

  • maxLength: 223

  • minLength: 1

host.id

string

query

False

Filter by host.id

subsystem.uuid

string

query

False

Filter by subsystem.uuid

subsystem.name

string

query

False

Filter by subsystem.name

  • maxLength: 96

  • minLength: 1

admin_queue.depth

integer

query

False

Filter by admin_queue.depth

dh_hmac_chap.mode

string

query

False

Filter by dh_hmac_chap.mode

  • Introduced in: 9.12

dh_hmac_chap.group_size

string

query

False

Filter by dh_hmac_chap.group_size

  • Introduced in: 9.12

dh_hmac_chap.hash_function

string

query

False

Filter by dh_hmac_chap.hash_function

  • Introduced in: 9.12

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

The number of records in the response.

records

array[nvme_subsystem_controller]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "admin_queue": {
        "depth": 0
      },
      "dh_hmac_chap": {
        "group_size": "string",
        "hash_function": "string",
        "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": [
          "integer"
        ]
      },
      "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, Error
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

next

href

self

href

_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

Name Type Description

_links

_links

name

string

The name of the NVMe subsystem.

uuid

string

The unique identifier of the NVMe subsystem.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

nvme_subsystem_controller

A Non-Volatile Memory Express (NVMe) subsystem controller represents a connection between a host and a storage solution.

An NVMe subsystem controller is identified by the NVMe subsystem UUID and the controller ID.

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.

node

node

subsystem

subsystem

svm

svm

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.