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

Retrieve NVMe namespaces

Contributors
PDFs

GET /storage/namespaces

Introduced In: 9.6

Retrieves NVMe namespaces.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • auto_delete

  • subsystem_map.*

  • status.mapped

  • statistics.*

  • metric.*

  • vserver nvme namespace show

  • vserver nvme subsystem map show

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

auto_delete

boolean

query

False

Filter by auto_delete

statistics.iops_raw.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.8

statistics.iops_raw.read

integer

query

False

Filter by statistics.iops_raw.read

  • Introduced in: 9.8

statistics.iops_raw.other

integer

query

False

Filter by statistics.iops_raw.other

  • Introduced in: 9.8

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • Introduced in: 9.8

statistics.latency_raw.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.8

statistics.latency_raw.read

integer

query

False

Filter by statistics.latency_raw.read

  • Introduced in: 9.8

statistics.latency_raw.other

integer

query

False

Filter by statistics.latency_raw.other

  • Introduced in: 9.8

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.8

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.8

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.8

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.8

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.8

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.8

subsystem_map.anagrpid

string

query

False

Filter by subsystem_map.anagrpid

subsystem_map.nsid

string

query

False

Filter by subsystem_map.nsid

subsystem_map.subsystem.name

string

query

False

Filter by subsystem_map.subsystem.name

subsystem_map.subsystem.uuid

string

query

False

Filter by subsystem_map.subsystem.uuid

create_time

string

query

False

Filter by create_time

  • Introduced in: 9.7

location.qtree.name

string

query

False

Filter by location.qtree.name

location.qtree.id

integer

query

False

Filter by location.qtree.id

location.volume.uuid

string

query

False

Filter by location.volume.uuid

location.volume.name

string

query

False

Filter by location.volume.name

location.namespace

string

query

False

Filter by location.namespace

enabled

boolean

query

False

Filter by enabled

status.mapped

boolean

query

False

Filter by status.mapped

status.read_only

boolean

query

False

Filter by status.read_only

status.container_state

string

query

False

Filter by status.container_state

status.state

string

query

False

Filter by status.state

name

string

query

False

Filter by name

comment

string

query

False

Filter by comment

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.8

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.8

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.8

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.8

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.8

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.8

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.8

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.8

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.8

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.8

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.8

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.8

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.8

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.8

os_type

string

query

False

Filter by os_type

uuid

string

query

False

Filter by uuid

space.guarantee.requested

boolean

query

False

Filter by space.guarantee.requested

space.guarantee.reserved

boolean

query

False

Filter by space.guarantee.reserved

space.used

integer

query

False

Filter by space.used

space.block_size

integer

query

False

Filter by space.block_size

space.size

integer

query

False

Filter by space.size

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

Number of records.

records

array[nvme_namespace]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "clone": {
        "source": {
          "name": "/vol/volume1/namespace1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "comment": "string",
      "create_time": "2018-06-04T19:00:00Z",
      "location": {
        "namespace": "namespace1",
        "qtree": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "id": "1",
          "name": "qt1"
        },
        "volume": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "volume1",
          "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
        }
      },
      "metric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "duration": "PT15S",
        "iops": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "latency": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "status": "ok",
        "throughput": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "timestamp": "2017-01-25T11:20:13Z"
      },
      "name": "/vol/volume1/qtree1/namespace1",
      "os_type": "string",
      "space": {
        "block_size": "512",
        "size": "1073741824",
        "used": 0
      },
      "statistics": {
        "iops_raw": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "latency_raw": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "status": "ok",
        "throughput_raw": {
          "read": "200",
          "total": "1000",
          "write": "100"
        },
        "timestamp": "2017-01-25T11:20:13Z"
      },
      "status": {
        "container_state": "string",
        "state": "online"
      },
      "subsystem_map": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "anagrpid": "00103050h",
        "nsid": "00000001h",
        "subsystem": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "string",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

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

source

The source NVMe namespace for a namespace clone operation. This can be specified using property clone.source.uuid or clone.source.name. If both properties are supplied, they must refer to the same namespace.

Valid in POST to create a new NVMe namespace as a clone of the source.

Valid in PATCH to overwrite an existing NVMe namespace's data as a clone of another.

Name Type Description

name

string

The fully qualified path name of the clone source NVMe namespace composed of a "/vol" prefix, the volume name, the (optional) qtree name and base name of the namespace. Valid in POST and PATCH.

uuid

string

The unique identifier of the clone source NVMe namespace. Valid in POST and PATCH.

clone

This sub-object is used in POST to create a new NVMe namespace as a clone of an existing namespace, or PATCH to overwrite an existing namespace as a clone of another. Setting a property in this sub-object indicates that a namespace clone is desired.

When used in a PATCH, the patched NVMe namespace's data is over-written as a clone of the source and the following properties are preserved from the patched namespace unless otherwise specified as part of the PATCH: auto_delete (unless specified in the request), subsystem_map, status.state, and uuid.

Name Type Description

source

source

The source NVMe namespace for a namespace clone operation. This can be specified using property clone.source.uuid or clone.source.name. If both properties are supplied, they must refer to the same namespace.

Valid in POST to create a new NVMe namespace as a clone of the source.

Valid in PATCH to overwrite an existing NVMe namespace's data as a clone of another.

qtree

The qtree in which the NVMe namespace is optionally located. Valid in POST.

If properties name and location.qtree.name and/or location.qtree.uuid are specified in the same request, they must refer to the same qtree.

NVMe namespaces do not support rename.

Name Type Description

_links

_links

id

integer

The identifier for the qtree, unique within the qtree's volume.

name

string

The name of the qtree.

volume

The volume in which the NVMe namespace is located. Valid in POST.

If properties name and location.volume.name and/or location.volume.uuid are specified in the same request, they must refer to the same volume.

NVMe namespaces do not support movement between volumes.

Name Type Description

_links

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

location

The location of the NVMe namespace within the ONTAP cluster. Valid in POST.

NVMe namespaces do not support rename, or movement between volumes.

Name Type Description

namespace

string

The base name component of the NVMe namespace. Valid in POST.

If properties name and location.namespace are specified in the same request, they must refer to the base name.

NVMe namespaces do not support rename.

qtree

qtree

The qtree in which the NVMe namespace is optionally located. Valid in POST.

If properties name and location.qtree.name and/or location.qtree.uuid are specified in the same request, they must refer to the same qtree.

NVMe namespaces do not support rename.

volume

volume

The volume in which the NVMe namespace is located. Valid in POST.

If properties name and location.volume.name and/or location.volume.uuid are specified in the same request, they must refer to the same volume.

NVMe namespaces do not support movement between volumes.

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

Performance numbers, such as IOPS latency and throughput

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

guarantee

Properties that request and report the space guarantee for the NVMe namespace.

Name Type Description

requested

boolean

The requested space reservation policy for the NVMe namespace. If true, a space reservation is requested for the namespace; if false, the namespace is thin provisioned. Guaranteeing a space reservation request for a namespace requires that the volume in which the namespace resides also be space reserved and that the fractional reserve for the volume be 100%.

The space reservation policy for an NVMe namespace is determined by ONTAP.

  • readOnly: 1

  • Introduced in: 9.6

reserved

boolean

Reports if the NVMe namespace is space guaranteed.

This property is true if a space guarantee is requested and the containing volume and aggregate support the request. This property is false if a space guarantee is not requested or if a space guarantee is requested and either the containing volume and aggregate do not support the request.

space

The storage space related properties of the NVMe namespace.

Name Type Description

block_size

integer

The size of blocks in the namespace in bytes.

Valid in POST when creating an NVMe namespace that is not a clone of another. Disallowed in POST when creating a namespace clone. Valid in POST.

guarantee

guarantee

Properties that request and report the space guarantee for the NVMe namespace.

size

integer

The total provisioned size of the NVMe namespace.

NVMe namespaces do not support resize.

The maximum and minimum sizes listed here are the absolute maximum and absolute minimum sizes in bytes. The maximum size is variable with respect to large NVMe namespace support in ONTAP. If large namespaces are supported, the maximum size is 128 TB (140737488355328 bytes) and if not supported, the maximum size is just under 16 TB (17557557870592 bytes). The minimum size supported is always 4096 bytes.

For more information, see Size properties in the docs section of the ONTAP REST API documentation.

  • example: 1073741824

  • Max value: 140737488355328

  • Min value: 4096

  • Introduced in: 9.6

  • readCreate: 1

used

integer

The amount of space consumed by the main data stream of the NVMe namespace.

This value is the total space consumed in the volume by the NVMe namespace, including filesystem overhead, but excluding prefix and suffix streams. Due to internal filesystem overhead and the many ways NVMe filesystems and applications utilize blocks within a namespace, this value does not necessarily reflect actual consumption/availability from the perspective of the filesystem or application. Without specific knowledge of how the namespace blocks are utilized outside of ONTAP, this property should not be used and an indicator for an out-of-space condition.

For more information, see Size properties in the docs section of the ONTAP REST API documentation.

  • readOnly: 1

  • Introduced in: 9.6

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

status

Status information about the NVMe namespace.

Name Type Description

container_state

string

The state of the volume and aggregate that contain the NVMe namespace. Namespaces are only available when their containers are available.

mapped

boolean

Reports if the NVMe namespace is mapped to an NVMe subsystem.

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

read_only

boolean

Reports if the NVMe namespace allows only read access.

state

string

The state of the NVMe namespace. Normal states for a namespace are online and offline. Other states indicate errors.

subsystem

The NVMe subsystem to which the NVMe namespace is mapped.

Name Type Description

_links

_links

name

string

The name of the NVMe subsystem.

uuid

string

The unique identifier of the NVMe subsystem.

subsystem_map

The NVMe subsystem with which the NVMe namespace is associated. A namespace can be mapped to zero (0) or one (1) subsystems.

There is an added cost to retrieving property values for subsystem_map. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

Name Type Description

_links

_links

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".

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.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

nvme_namespace

An NVMe namespace is a collection of addressable logical blocks presented to hosts connected to the storage virtual machine using the NVMe over Fabrics protocol.

In ONTAP, an NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume.

An NVMe namespace is created to a specified size using thin or thick provisioning as determined by the volume on which it is created. NVMe namespaces support being cloned. An NVMe namespace cannot be renamed, resized, or moved to a different volume. NVMe namespaces do not support the assignment of a QoS policy for performance management, but a QoS policy can be assigned to the volume containing the namespace. See the NVMe namespace object model to learn more about each of the properties supported by the NVMe namespace REST API.

An NVMe namespace must be mapped to an NVMe subsystem to grant access to the subsystem's hosts. Hosts can then access the NVMe namespace and perform I/O using the NVMe over Fabrics protocol.

Name Type Description

_links

_links

auto_delete

boolean

This property marks the NVMe namespace for auto deletion when the volume containing the namespace runs out of space. This is most commonly set on namespace clones.

When set to true, the NVMe namespace becomes eligible for automatic deletion when the volume runs out of space. Auto deletion only occurs when the volume containing the namespace is also configured for auto deletion and free space in the volume decreases below a particular threshold.

This property is optional in POST and PATCH. The default value for a new NVMe namespace is false.

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

clone

clone

This sub-object is used in POST to create a new NVMe namespace as a clone of an existing namespace, or PATCH to overwrite an existing namespace as a clone of another. Setting a property in this sub-object indicates that a namespace clone is desired.

When used in a PATCH, the patched NVMe namespace's data is over-written as a clone of the source and the following properties are preserved from the patched namespace unless otherwise specified as part of the PATCH: auto_delete (unless specified in the request), subsystem_map, status.state, and uuid.

comment

string

A configurable comment available for use by the administrator. Valid in POST and PATCH.

create_time

string

The time the NVMe namespace was created.

enabled

boolean

The enabled state of the NVMe namespace. Certain error conditions cause the namespace to become disabled. If the namespace is disabled, you can check the state property to determine what error disabled the namespace. An NVMe namespace is enabled automatically when it is created.

location

location

The location of the NVMe namespace within the ONTAP cluster. Valid in POST.

NVMe namespaces do not support rename, or movement between volumes.

  • Introduced in: 9.6

  • readCreate: 1

metric

metric

Performance numbers, such as IOPS latency and throughput

name

string

The fully qualified path name of the NVMe namespace composed of a "/vol" prefix, the volume name, the (optional) qtree name and base name of the namespace. Valid in POST.

NVMe namespaces do not support rename, or movement between volumes.

os_type

string

The operating system type of the NVMe namespace.

Required in POST when creating an NVMe namespace that is not a clone of another. Disallowed in POST when creating a namespace clone.

space

space

The storage space related properties of the NVMe namespace.

statistics

statistics

These are raw performance numbers, such as IOPS latency and throughput. These numbers are aggregated across all nodes in the cluster and increase with the uptime of the cluster.

status

status

Status information about the NVMe namespace.

subsystem_map

subsystem_map

The NVMe subsystem with which the NVMe namespace is associated. A namespace can be mapped to zero (0) or one (1) subsystems.

There is an added cost to retrieving property values for subsystem_map. They are not populated for either a collection GET or an instance GET unless explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

svm

svm

uuid

string

The unique identifier of the NVMe namespace.

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.