REST API reference
A newer release of this product is available.
Network FC interfaces endpoint overview
Contributors
Suggest changes
PDFs
Overview
Fibre Channel (FC) interfaces are the logical endpoints for FC network connections to an SVM. An FC interface provides FC access to storage within the interface SVM using either Fibre Channel Protocol or NVMe over FC (NVMe/FC).
The Fibre Channel interface REST API allows you to create, delete, update, and discover FC interfaces, and obtain status information for FC interfaces.
An FC interface is created on an FC port which is located on a cluster node. The FC port must be specified to identify the location of the interface for a POST or PATCH request that relocates an interface. You can identify the port by supplying either the node and port names or the port UUID.
Performance monitoring
Performance of an FC interface can be monitored by observing the metric.* and statistics.* properties. These properties show the performance of an FC interface in terms of IOPS, latency, and throughput. The metric.* properties denote an average, whereas statistics.* properties denote a real-time monotonically increasing value aggregated across all nodes.
Examples
Creating an FC interface using the port node and name to identify the location
This example uses the return_records query parameter to retrieve the newly created FC interface in the POST response.
# The API:
POST /api/network/fc/interfaces
# The call:
curl -X POST 'https://<mgmt-ip>/api/network/fc/interfaces?return_records=true' -H 'accept: application/hal+json' -d '{ "svm": { "name": "svm1" }, "name": "lif1", "location": { "home_port": { "name": "0a", "home_node": { "name": "node1" } } }, "data_protocol": "fcp" }'
# The response:
{
"num_records": 1,
"records": [
{
"svm": {
"uuid": "cf300f5c-db83-11e8-bd46-005056bba0e0",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/cf300f5c-db83-11e8-bd46-005056bba0e0"
}
}
},
"uuid": "f6045b92-dec7-11e8-a733-005056bba0e0",
"name": "lif1",
"location": {
"home_node": {
"uuid": "bafe9b9f-db81-11e8-bd46-005056bba0e0",
"name": "node1",
"_links": {
"self": {
"href": "/api/cluster/nodes/bafe9b9f-db81-11e8-bd46-005056bba0e0"
}
}
},
"home_port": {
"uuid": "300c1ae3-db82-11e8-bd46-005056bba0e0",
"name": "0a",
"node": {
"name": "node1"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/300c1ae3-db82-11e8-bd46-005056bba0e0"
}
}
},
"node": {
"uuid": "bafe9b9f-db81-11e8-bd46-005056bba0e0",
"name": "node1",
"_links": {
"self": {
"href": "/api/cluster/nodes/bafe9b9f-db81-11e8-bd46-005056bba0e0"
}
}
},
"port": {
"uuid": "300c1ae3-db82-11e8-bd46-005056bba0e0",
"name": "0a",
"node": {
"name": "node1"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/300c1ae3-db82-11e8-bd46-005056bba0e0"
}
}
}
},
"enabled": true,
"state": "down",
"data_protocol": "fcp",
"wwpn": "20:04:00:50:56:bb:a0:e0",
"wwnn": "20:00:00:50:56:bb:a0:e0",
"port_address": "9da2cb1",
"_links": {
"self": {
"href": "/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0"
}
}
}
]
}
Creating an FC interface using the port UUID to identify the location
This example uses the return_records query parameter to retrieve the newly created FC interface in the POST response.
# The API:
POST /api/network/fc/interfaces
# The call:
curl -X POST 'https://<mgmt-ip>/api/network/fc/interfaces?return_records=true' -H 'accept: application/hal+json' -d '{ "svm": { "name": "svm3" }, "name": "lif2", "location": { "home_port": { "uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6" } }, "data_protocol": "fc_nvme" }'
# The response:
{
"num_records": 1,
"records": [
{
"svm": {
"uuid": "a5060466-dbab-11e8-bd46-005056bba0e0",
"name": "svm3",
"_links": {
"self": {
"href": "/api/svm/svms/a5060466-dbab-11e8-bd46-005056bba0e0"
}
}
},
"uuid": "cdeb5591-dec9-11e8-a733-005056bba0e0",
"name": "lif2",
"location": {
"home_node": {
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
}
},
"home_port": {
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"name": "1b",
"node": {
"name": "node3"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
}
},
"node": {
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
}
},
"port": {
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"name": "1b",
"node": {
"name": "node3"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
}
}
},
"enabled": true,
"state": "down",
"data_protocol": "fc_nvme",
"wwpn": "20:05:00:50:56:bb:a0:e0",
"wwnn": "20:02:00:50:56:bb:a0:e0",
"port_address": "612e202b",
"_links": {
"self": {
"href": "/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0"
}
}
}
]
}
Retrieving all properties for all FC interfaces
This example uses the fields query parameter to retrieve all properties.
# The API:
GET /api/network/fc/interfaces
# The call:
curl -X GET 'https://<mgmt-ip>/api/network/fc/interfaces?fields=*' -H 'accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "a5060466-dbab-11e8-bd46-005056bba0e0",
"name": "svm3",
"_links": {
"self": {
"href": "/api/svm/svms/a5060466-dbab-11e8-bd46-005056bba0e0"
}
}
},
"uuid": "cdeb5591-dec9-11e8-a733-005056bba0e0",
"name": "lif2",
"location": {
"home_node": {
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
}
},
"home_port": {
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"name": "1b",
"node": {
"name": "node3"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
}
},
"node": {
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
}
},
"port": {
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"name": "1b",
"node": {
"name": "node3"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
}
}
},
"enabled": true,
"state": "down",
"data_protocol": "fc_nvme",
"wwpn": "20:05:00:50:56:bb:a0:e0",
"wwnn": "20:02:00:50:56:bb:a0:e0",
"port_address": "612e202b",
"_links": {
"self": {
"href": "/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0"
}
}
},
{
"svm": {
"uuid": "cf300f5c-db83-11e8-bd46-005056bba0e0",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/cf300f5c-db83-11e8-bd46-005056bba0e0"
}
}
},
"uuid": "f6045b92-dec7-11e8-a733-005056bba0e0",
"name": "lif1",
"location": {
"home_node": {
"uuid": "bafe9b9f-db81-11e8-bd46-005056bba0e0",
"name": "node1",
"_links": {
"self": {
"href": "/api/cluster/nodes/bafe9b9f-db81-11e8-bd46-005056bba0e0"
}
}
},
"home_port": {
"uuid": "300c1ae3-db82-11e8-bd46-005056bba0e0",
"name": "0a",
"node": {
"name": "node1"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/300c1ae3-db82-11e8-bd46-005056bba0e0"
}
}
},
"node": {
"uuid": "bafe9b9f-db81-11e8-bd46-005056bba0e0",
"name": "node1",
"_links": {
"self": {
"href": "/api/cluster/nodes/bafe9b9f-db81-11e8-bd46-005056bba0e0"
}
}
},
"port": {
"uuid": "300c1ae3-db82-11e8-bd46-005056bba0e0",
"name": "0a",
"node": {
"name": "node1"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/300c1ae3-db82-11e8-bd46-005056bba0e0"
}
}
}
},
"enabled": true,
"state": "down",
"data_protocol": "fcp",
"wwpn": "20:04:00:50:56:bb:a0:e0",
"wwnn": "20:00:00:50:56:bb:a0:e0",
"port_address": "9da2cb1",
"_links": {
"self": {
"href": "/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/network/fc/interfaces?fields=*"
}
}
}
Retrieving a list of selected FC interfaces
This example uses property query parameters to retrieve FC interfaces configured for the FC Protocol that are set to up.
# The API:
GET /api/network/fc/interfaces
# The call:
curl -X GET 'https://<mgmt-ip>/api/network/fc/interfaces?data_protocol=fcp&state=up' -H 'accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "cf300f5c-db83-11e8-bd46-005056bba0e0",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/cf300f5c-db83-11e8-bd46-005056bba0e0"
}
}
},
"uuid": "f6045b92-dec7-11e8-a733-005056bba0e0",
"name": "lif1",
"state": "up",
"data_protocol": "fcp",
"_links": {
"self": {
"href": "/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0"
}
}
}
],
"num_records": 1,
"_links": {
"self": {
"href": "/api/network/fc/interfaces?data_protocol=fcp&state=up"
}
}
}
Retrieving a specific FC interface
# The API:
GET /api/network/fc/interfaces/{uuid}
# The call:
curl -X GET 'https://<mgmt-ip>/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0' -H 'accept: application/hal+json'
# The response:
{
"svm": {
"uuid": "a5060466-dbab-11e8-bd46-005056bba0e0",
"name": "svm3",
"_links": {
"self": {
"href": "/api/svm/svms/a5060466-dbab-11e8-bd46-005056bba0e0"
}
}
},
"uuid": "cdeb5591-dec9-11e8-a733-005056bba0e0",
"name": "lif2",
"location": {
"home_node": {
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
}
},
"home_port": {
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"name": "1b",
"node": {
"name": "node3"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
}
},
"node": {
"uuid": "e85aa147-db83-11e8-9a48-005056bb1ec6",
"name": "node3",
"_links": {
"self": {
"href": "/api/cluster/nodes/e85aa147-db83-11e8-9a48-005056bb1ec6"
}
}
},
"port": {
"uuid": "24bb636a-db83-11e8-9a49-005056bb1ec6",
"name": "1b",
"node": {
"name": "node3"
},
"_links": {
"self": {
"href": "/api/network/fc/ports/24bb636a-db83-11e8-9a49-005056bb1ec6"
}
}
}
},
"enabled": true,
"state": "down",
"data_protocol": "fc_nvme",
"wwpn": "20:05:00:50:56:bb:a0:e0",
"wwnn": "20:02:00:50:56:bb:a0:e0",
"port_address": "612e202b",
"metric": {
"timestamp": "2019-04-09T05:50:15Z",
"duration": "PT15S",
"status": "ok",
"latency": {
"other": 0,
"total": 0,
"read": 0,
"write": 0
},
"iops": {
"read": 0,
"write": 0,
"other": 0,
"total": 0
},
"throughput": {
"read": 0,
"write": 0,
"total": 0
}
},
"statistics": {
"timestamp": "2019-04-09T05:50:42Z",
"status": "ok",
"latency_raw": {
"other": 38298,
"total": 38298,
"read": 0,
"write": 0
},
"iops_raw": {
"read": 0,
"write": 0,
"other": 3,
"total": 3
},
"throughput_raw": {
"read": 0,
"write": 0,
"total": 0
}
},
"_links": {
"self": {
"href": "/api/network/fc/interfaces/cdeb5591-dec9-11e8-a733-005056bba0e0"
}
}
}
Disabling an FC interface
When updating certain properties or deleting an FC interface, the interface must first be disabled using the following:
# The API:
PATCH /api/network/fc/interfaces/{uuid}
# The call:
curl -X PATCH 'https://<mgmt-ip>/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0' -H 'accept: application/hal+json' -d '{ "enabled": false }'
Moving an FC interface to a new node and port
To move an FC interface to another node or port, the destination FC port must be specified in a PATCH request. Either the port UUID or node and port names can be used to identify the port.
Note that only FC interfaces configured for the FC Protocol can be moved. FC interfaces configured for NVMe/FC cannot be moved. The interface must also be set to the disabled state before being moved.
# The API:
PATCH /api/network/fc/interfaces/{uuid}
# The call:
curl -X PATCH 'https://<mgmt-ip>/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0' -H 'accept: application/hal+json' -d '{ "location": { "home_port": { "uuid": "a1dc7aa5-db83-11e8-9ef7-005056bbbbcc" } } }'
Deleting an FC interface
The FC interface must be disabled before being deleted.
# The API:
DELETE /api/network/fc/interfaces/{uuid}
# The call:
curl -X DELETE 'https://<mgmt-ip>/api/network/fc/interfaces/f6045b92-dec7-11e8-a733-005056bba0e0' -H 'accept: application/hal+json'