Add portset network interfaces
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
POST /protocols/san/portsets/{portset.uuid}/interfaces
Introduced In: 9.9
Adds one or more interfaces to a portset.
Required properties
-
fc
,ip
orrecords
- Network interface(s) to add to the portset.
Related ONTAP commands
-
lun portset add
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
portset.uuid |
string |
path |
True |
The unique identifier of the portset. |
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
Name | Type | Description |
---|---|---|
_links |
||
fc |
An FC interface. |
|
ip |
A network interface. Either UUID or name may be supplied on input. |
|
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. |
|
records |
array[records] |
An array of network interfaces specified to add multiple interfaces to a portset in a single API call. Valid in POST only and not allowed when the |
uuid |
string |
The unique identifier of the network interface. |
Example request
{
"_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"
},
"records": [
{
"_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"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
Response
Status: 201, Created
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
The number of records in the response. |
records |
array[portset_interface] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_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"
},
"records": [
{
"_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"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
],
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
]
}
Headers
Name | Description | Type |
---|---|---|
Location |
Useful for tracking the resource location |
string |
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
5374906 |
A specified network interface was not found. |
5374907 |
The specified network interface UUID and name don't identify the same network interface. |
5374909 |
An invalid combination of network interface properties was specified. |
5374910 |
An incomplete set of network interface properties was specified. |
5374914 |
An attempt was made to add a network interface of an incompatible protocol to a portset. |
5374915 |
An attempt was made to add a duplicate network interface to a portset. |
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 |
---|---|---|
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
A network interface. Either UUID or name may be supplied on input.
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 |
A network interface. Either UUID or name may be supplied on input. |
|
uuid |
string |
Th |