Retrieve NVMe subsystems
GET /protocols/nvme/subsystems
Introduced In: 9.6
Retrieves NVMe subsystems.
Related ONTAP commands
-
vserver nvme subsystem host show
-
vserver nvme subsystem map show
-
vserver nvme subsystem show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string |
query |
False |
Filter by name
|
serial_number |
string |
query |
False |
Filter by serial_number
|
subsystem_maps.anagrpid |
string |
query |
False |
Filter by subsystem_maps.anagrpid |
subsystem_maps.namespace.uuid |
string |
query |
False |
Filter by subsystem_maps.namespace.uuid |
subsystem_maps.namespace.name |
string |
query |
False |
Filter by subsystem_maps.namespace.name |
subsystem_maps.nsid |
string |
query |
False |
Filter by subsystem_maps.nsid |
target_nqn |
string |
query |
False |
Filter by target_nqn
|
hosts.nqn |
string |
query |
False |
Filter by hosts.nqn |
hosts.dh_hmac_chap.mode |
string |
query |
False |
Filter by hosts.dh_hmac_chap.mode
|
hosts.dh_hmac_chap.group_size |
string |
query |
False |
Filter by hosts.dh_hmac_chap.group_size
|
hosts.dh_hmac_chap.hash_function |
string |
query |
False |
Filter by hosts.dh_hmac_chap.hash_function
|
hosts.priority |
string |
query |
False |
Filter by hosts.priority
|
delete_on_unmap |
boolean |
query |
False |
Filter by delete_on_unmap
|
vendor_uuids |
string |
query |
False |
Filter by vendor_uuids
|
comment |
string |
query |
False |
Filter by comment
|
uuid |
string |
query |
False |
Filter by uuid |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
os_type |
string |
query |
False |
Filter by os_type |
io_queue.default.count |
integer |
query |
False |
Filter by io_queue.default.count
|
io_queue.default.depth |
integer |
query |
False |
Filter by io_queue.default.depth
|
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
The number of records in the response. |
records |
array[nvme_subsystem] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"hosts": [
{
"dh_hmac_chap": {
"controller_secret_key": "DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:",
"group_size": "string",
"hash_function": "string",
"host_secret_key": "DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:",
"mode": "bidirectional"
},
"nqn": "nqn.1992-01.example.com:string",
"priority": "string"
}
],
"io_queue": {
"default": {
"count": 4,
"depth": 16
}
},
"name": "subsystem1",
"os_type": "string",
"serial_number": "wCVsgFMiuMhVAAAAAAAB",
"subsystem_maps": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"anagrpid": "00103050h",
"namespace": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "/vol/vol1/namespace1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"nsid": "00000001h"
}
],
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"target_nqn": "nqn.1992-01.example.com:string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
"vendor_uuids": [
"1447f0f4-42e5-0dfc-871a-dc9b3f92d8f8"
]
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
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 |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
dh_hmac_chap
A container for properties of NVMe in-band authentication with the DH-HMAC-CHAP protocol.
Name | Type | Description |
---|---|---|
controller_secret_key |
string |
The controller secret for NVMe in-band authentication. The value of this property is used by the NVMe host to authenticate the NVMe controller while establishing a connection. If unset, the controller is not authenticated. When supplied, the property This property is write-only. The |
group_size |
string |
The Diffie-Hellman group size for NVMe in-band authentication. When property |
hash_function |
string |
The hash function for NVMe in-band authentication. When property |
host_secret_key |
string |
The host secret for NVMe in-band authentication. The value of this property is used by the NVMe controller to authenticate the NVMe host while establishing a connection. If unset, no authentication is performed by the host or controller. This property must be supplied if any other NVMe in-band authentication properties are supplied. Optional in POST. This property is write-only. The |
mode |
string |
The expected NVMe in-band authentication mode for the host. This property is an indication of which secrets are configured for the host. When set to:
|
hosts
Name | Type | Description |
---|---|---|
dh_hmac_chap |
A container for properties of NVMe in-band authentication with the DH-HMAC-CHAP protocol. |
|
nqn |
string |
The NVMe qualified name (NQN) used to identify the NVMe storage target. |
priority |
string |
The host priority setting allocates appropriate NVMe I/O queues (count and depth) for the host to submit I/O commands. Absence of this property in GET implies user configured values of I/O queue count and I/O queue depth are being used. |
default
The default I/O queue parameters inherited by NVMe hosts in the NVMe subsystem.
Name | Type | Description |
---|---|---|
count |
integer |
The number of host I/O queue pairs. |
depth |
integer |
The host I/O queue depth. |
io_queue
The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
Name | Type | Description |
---|---|---|
default |
The default I/O queue parameters inherited by NVMe hosts in the NVMe subsystem. |
namespace
An NVMe namespace mapped to the NVMe subsystem.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the NVMe namespace. |
uuid |
string |
The unique identifier of the NVMe namespace. |
subsystem_maps
An NVMe namespace mapped to the NVMe subsystem.
Name | Type | Description |
---|---|---|
_links |
||
anagrpid |
string |
The Asymmetric Namespace Access Group ID (ANAGRPID) of the NVMe namespace. The format for an ANAGRPIP is 8 hexadecimal digits (zero-filled) followed by a lower case "h". |
namespace |
An NVMe namespace mapped to the NVMe subsystem. |
|
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". |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_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. |
nvme_subsystem
An NVMe subsystem maintains configuration state and namespace access control for a set of NVMe-connected hosts.
Name | Type | Description |
---|---|---|
_links |
||
comment |
string |
A configurable comment for the NVMe subsystem. Optional in POST and PATCH. |
delete_on_unma |