Retrieve specific portset network interfaces
Retrieves a specific network interface associated with a portset to access details about its configuration and status. Use this endpoint to manage or review portset network interfaces as part of your network setup or troubleshooting.
HTTP method and endpoint
GET /protocols/san/portsets/{portset.uuid}/interfaces/{uuid}
Introduced in
ONTAP 9.9
Usage notes
Retrieves a network interface of a portset.
Related ONTAP commands
-
lun portset show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
portset.uuid |
string |
path |
True |
The unique identifier of the portset. |
uuid |
string |
path |
True |
The unique identifier of the network interface in the portset. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
fc |
An FC interface. |
|
ip |
||
portset |
The portset in which the network interface is found. Note that this does not mean that the network interface cannot also be found in other portsets. |
|
uuid |
string |
The unique identifier of the network interface. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"fc": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "fc_lif1",
"uuid": "3a09ab42-4da1-32cf-9d35-3385a6101a0b",
"wwpn": "20:00:00:50:56:b4:13:a8"
},
"ip": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ip": {
"address": "10.10.10.7"
},
"name": "lif1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"portset": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
Error
Status: Default
ONTAP Error Response Codes
| Error Code | Description |
|---|---|
4 |
The interface is not a member of the portset. |
5374908 |
The portset specified in the URI does not exist. |
| 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 |
|---|---|---|
self |
fc
An FC interface.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the FC interface. |
uuid |
string |
The unique identifier of the FC interface. |
wwpn |
string |
The WWPN of the FC interface. |
ip
IP information
| Name | Type | Description |
|---|---|---|
address |
string |
IPv4 or IPv6 address |
ip
| Name | Type | Description |
|---|---|---|
_links |
||
ip |
IP information |
|
name |
string |
The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in. |
uuid |
string |
The UUID that uniquely identifies the interface. |
portset
The portset in which the network interface is found.
Note that this does not mean that the network interface cannot also be found in other portsets.
| Name | Type | Description |
|---|---|---|
_links |
||
uuid |
string |
The unique identifier of the portset. |
records
A container for either a Fibre Channel network interface or an IP network interface. On POST fc and ip are mutually exclusive.
| Name | Type | Description |
|---|---|---|
_links |
||
fc |
An FC interface. |
|
ip |
||
uuid |
string |
The unique identifier of the network interface. |
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. |