Retrieve NVMe subsystem hosts
GET /protocols/nvme/subsystems/{subsystem.uuid}/hosts
Introduced In: 9.6
Retrieves the NVMe subsystem hosts of an NVMe subsystem.
Expensive properties
There is an added computational 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.
-
subsystem_maps.*
Related ONTAP commands
-
vserver nvme subsystem map show
-
vserver nvme subsystem show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
subsystem.uuid |
string |
path |
True |
The unique identifier of the NVMe subsystem. |
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_host] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"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"
},
"io_queue": {
"count": 4,
"depth": 32
},
"nqn": "nqn.1992-01.example.com:string",
"priority": "string",
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"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"
},
"io_queue": {
"count": 4,
"depth": 32
},
"nqn": "nqn.1992-01.example.com:string",
"subsystem": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "subsystem1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
],
"subsystem": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "subsystem1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
]
}
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
72090001 |
The NVMe subsystem does not exist. |
Also see the table of common errors in the Response body overview section of this documentation.
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:
|
io_queue
The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
Name | Type | Description |
---|---|---|
count |
integer |
The number of I/O queue pairs. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue count is being used. Valid in GET only. |
depth |
integer |
The I/O queue depth. Absence of this property in GET implies property priority is set and platform and transport protocol specific values for I/O queue depth is being used. Valid in GET only. |
io_queue
The properties of the submission queue used to submit I/O commands for execution by the NVMe controller.
Name | Type | Description |
---|---|---|
count |
integer |
The number of I/O queue pairs. The default value is inherited from the owning NVMe subsystem. |
depth |
integer |
The I/O queue depth. The default value is inherited from the owning NVMe subsystem. |
subsystem
The NVMe subsystem to which the NVMe host has been provisioned.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the NVMe subsystem. |
uuid |
string |
The unique identifier of the NVMe subsystem. |
records
The NVMe host provisioned to access NVMe namespaces mapped to a subsystem.
Name | Type | Description |
---|---|---|
_links |
||
dh_hmac_chap |
A container for properties of NVMe in-band authentication with the DH-HMAC-CHAP protocol. |
|
io_queue |
The properties of the submission queue used to submit I/O commands for execution by the NVMe controller. |
|
nqn |
string |
The NVMe qualified name (NQN) used to identify the NVMe storage target. Not allowed in POST when the |
subsystem |
The NVMe subsystem to which the NVMe host has been provisioned. |
nvme_subsystem_host
The NVMe host provisioned to access NVMe namespaces mapped to a subsystem.
Name | Type | Description |
---|---|---|
_links |
||
dh_hmac_chap |
A container for properties of NVMe in-band authentication with the DH-HMAC-CHAP protocol. |
|
io_queue |
The properties of the submission queue used to submit I/O commands for execution by the NVMe controller. |
|
nqn |
string |
The NVMe qualified name (NQN) used to identify the NVMe storage target. Not allowed in POST when the |
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 io_queue count and I/O queue depth are being used. |
records |
array[records] |
An array of NVMe hosts specified to add multiple NVMe hosts to an NVMe subsystem in a single API call. Valid in POST only. |
subsystem |
The NVMe subsystem to which the NVMe host has been provisioned. |
error_arguments