View NVMe subsystem controllers
Explore NVMe subsystem controllers to understand the dynamic connections between hosts and your storage solution. Use these endpoints to retrieve details about connected hosts and manage subsystem connections efficiently.
Overview
Non-Volatile Memory Express (NVMe) subsystem controllers represent dynamic connections between hosts and a storage solution.
The NVMe subsystem controllers REST API provides information about connected hosts.
Examples
Retrieving the NVMe subsystem controllers for the entire system
# The API:
GET /api/protocols/nvme/subsystem-controllers
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/nvme/subsystem-controllers' -H 'Accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "14875240-2594-11e9-abde-00a098984313",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_0",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/14875240-2594-11e9-abde-00a098984313"
}
}
},
"id": "0040h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313/0040h"
}
}
},
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "14875240-2594-11e9-abde-00a098984313",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_0",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/14875240-2594-11e9-abde-00a098984313"
}
}
},
"id": "0041h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313/0041h"
}
}
},
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "1489d0d5-2594-11e9-94c4-00a0989a1c8e",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_1",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/1489d0d5-2594-11e9-94c4-00a0989a1c8e"
}
}
},
"id": "0040h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/1489d0d5-2594-11e9-94c4-00a0989a1c8e/0040h"
}
}
},
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "1489d0d5-2594-11e9-94c4-00a0989a1c8e",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_1",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/1489d0d5-2594-11e9-94c4-00a0989a1c8e"
}
}
},
"id": "0041h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/1489d0d5-2594-11e9-94c4-00a0989a1c8e/0041h"
}
}
}
],
"num_records": 4,
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers"
}
}
}
Retrieving the NVMe subsystem controllers for a specific subsystem
# The API:
GET /api/protocols/nvme/subsystem-controllers
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/nvme/subsystem-controllers?subsystem.uuid=14875240-2594-11e9-abde-00a098984313' -H 'Accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "14875240-2594-11e9-abde-00a098984313",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_0",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/14875240-2594-11e9-abde-00a098984313"
}
}
},
"id": "0040h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313/0040h"
}
}
},
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "14875240-2594-11e9-abde-00a098984313",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_0",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/14875240-2594-11e9-abde-00a098984313"
}
}
},
"id": "0041h",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313/0041h"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313"
}
}
}
Retrieving a specific NVMe subsystem controller
# The API:
GET /api/protocols/nvme/subsystem-controllers/{subsystem.uuid}/{id}
# The call:
curl -X GET 'https://<mgmt-ip>/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313/0040h' -H 'Accept: application/hal+json'
# The response:
{
"svm": {
"uuid": "f0f5b928-2593-11e9-94c4-00a0989a1c8e",
"name": "symmcon_fcnvme_vserver_0",
"_links": {
"self": {
"href": "/api/svm/svms/f0f5b928-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"subsystem": {
"uuid": "14875240-2594-11e9-abde-00a098984313",
"name": "symmcon_symmcon_fcnvme_vserver_0_subsystem_0",
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystems/14875240-2594-11e9-abde-00a098984313"
}
}
},
"id": "0040h",
"interface": {
"name": "symmcon_lif_fcnvme_symmcon_fcnvme_vserver_0_3a_0",
"uuid": "fa1c5941-2593-11e9-94c4-00a0989a1c8e",
"transport_address": "nn-0x200400a0989a1c8d:pn-0x200500a0989a1c8d",
"_links": {
"self": {
"href": "/api/protocols/nvme/interfaces/fa1c5941-2593-11e9-94c4-00a0989a1c8e"
}
}
},
"node": {
"name": "ssan-8040-94a",
"uuid": "ebf66f05-2590-11e9-abde-00a098984313",
"_links": {
"self": {
"href": "/api/cluster/nodes/ebf66f05-2590-11e9-abde-00a098984313"
}
}
},
"host": {
"transport_address": "nn-0x20000090fae00806:pn-0x10000090fae00806",
"nqn": "nqn.2014-08.org.nvmexpress:uuid:c2846cb1-89d2-4020-a3b0-71ce907b4eef",
"id": "b8546ca6097349e5b1558dc154fc073b"
},
"io_queue": {
"count": 4,
"depth": [
32,
32,
32,
32
]
},
"admin_queue": {
"depth": 32
},
"dh_hmac_chap": {
"mode": "none"
},
"keep_alive_timeout": 4000,
"digest.header": true,
"digest.data": false,
"tls": {
"key_type": "configured",
"psk_identity": "NVMe1R01 nqn.2014-08.org.nvmexpress:uuid:c2846cb1-89d2-4020-a3b0-71ce907b4eef nqn.1992-08.com.netapp:sn.ca3cae02070811ef9a53005056bb9001:subsystem.ss1 c9X3RurQxGiGa76Tpk2tirifrUhHmVp035MOrtHXnAU=",
"cipher": "tls_aes_128_gcm_sha256"
},
"_links": {
"self": {
"href": "/api/protocols/nvme/subsystem-controllers/14875240-2594-11e9-abde-00a098984313/0040h"
}
}
}