Skip to main content
REST API reference

Create an NVMe subsystem map

PDFs

POST /protocols/nvme/subsystem-maps

Introduced In: 9.6

Creates an NVMe subsystem map.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the NVMe subsystem map.

  • namespace.uuid or namespace.name - Existing NVMe namespace to map to the specified NVme subsystem.

  • subsystem.uuid or subsystem.name - Existing NVMe subsystem to map to the specified NVMe namespace.

  • vserver nvme subsystem map add

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

anagrpid

string

The Asymmetric Namespace Access Group ID (ANAGRPID) of the NVMe namespace.

The format for an ANAGRPID is 8 hexadecimal digits (zero-filled) followed by a lower case "h".

There is an added computational cost to retrieving this property's value. It is not populated for a GET request unless it is explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

namespace

namespace

The NVMe namespace to which the NVMe subsystem is mapped. Required in POST by supplying either the UUID, name, or both.

nsid

string

The NVMe namespace identifier. This is an identifier used by an NVMe controller to provide access to the NVMe namespace.

The format for an NVMe namespace identifier is 8 hexadecimal digits (zero-filled) followed by a lower case "h".

subsystem

subsystem

The NVMe subsystem to which the NVMe namespace is mapped. Required in POST by supplying either subsystem.uuid, subsystem.name or both.

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "anagrpid": "00103050h",
  "namespace": {
    "name": "/vol/vol1/namespace1",
    "node": {
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "nsid": "00000001h",
  "subsystem": {
    "name": "subsystem1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
Name Type Description

num_records

integer

The number of records in the response.

records

array[nvme_subsystem_map]
Example response 
{
  "num_records": 1,
  "records": [
    {
      "anagrpid": "00103050h",
      "namespace": {
        "name": "/vol/vol1/namespace1",
        "node": {
          "name": "node1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        },
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "nsid": "00000001h",
      "subsystem": {
        "name": "subsystem1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "svm": {
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5374127

The specified namespace name is invalid.

5376461

The specified namespace name is invalid.

5376462

The specified namespace name is too long.

72089731

The specified NVMe namespace does not exist.

72089790

The supplied NVMe namespace is already mapped to the supplied NVMe subsystem.

72089793

An NVMe namespace in a snapshot cannot be mapped.

72089799

The NVMe namespace is the destination of an ongoing restore operation and is inaccessible for I/O and management.

72089902

A node does not have an NVMe interface configured.

72089903

Multiple nodes do not have an NVMe interface configured.

72089904

The aggregate must be given back to its home node prior to mapping the NVMe namespace it contains.

72090001

The NVMe subsystem specified by subsystem.uuid was not found.

72090005

The specified namespace.uuid and namespace.name refer to different NVMe namespaces.

72090006

The NVMe namespace specified by namespace.uuid was not found.

72090007

The NVMe namespace specified by namespace.name was not found.

72090020

The specified subsystem.uuid and subsystem.name refer to different NVMe subsystems.

72090021

The NVMe subsystem specified by subsystem.name was not found.

72091102

The NVMe namespace is part of a SnapMirror active sync relationship that has a different SVM peering relationship than the subsystem.

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

node

Name Type Description

name

string

uuid

string

namespace

The NVMe namespace to which the NVMe subsystem is mapped. Required in POST by supplying either the UUID, name, or both.

Name Type Description

name

string

The name of the NVMe namespace. Valid in POST. An NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume.

NVMe namespace names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

node

node

uuid

string

The unique identifier of the NVMe namespace. Valid in POST.

subsystem

The NVMe subsystem to which the NVMe namespace is mapped. Required in POST by supplying either subsystem.uuid, subsystem.name or both.

Name Type Description

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

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.

nvme_subsystem_map

An NVMe subsystem map is an association of an NVMe namespace with an NVMe subsystem. When an NVMe namespace is mapped to an NVMe subsystem, the NVMe subsystem's hosts are granted access to the NVMe namespace. The relationship between an NVMe subsystem and an NVMe namespace is one subsystem to many namespaces.

Name Type Description

anagrpid

string

The Asymmetric Namespace Access Group ID (ANAGRPID) of the NVMe namespace.

The format for an ANAGRPID is 8 hexadecimal digits (zero-filled) followed by a lower case "h".

There is an added computational cost to retrieving this property's value. It is not populated for a GET request unless it is explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

namespace

namespace

The NVMe namespace to which the NVMe subsystem is mapped. Required in POST by supplying either the UUID, name, or both.

nsid

string

The NVMe namespace identifier. This is an identifier used by an NVMe controller to provide access to the NVMe namespace.

The format for an NVMe namespace identifier is 8 hexadecimal digits (zero-filled) followed by a lower case "h".

subsystem

subsystem

The NVMe subsystem to which the NVMe namespace is mapped. Required in POST by supplying either subsystem.uuid, subsystem.name or both.

svm

svm

SVM, applies only to SVM-scoped objects.

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.