REST API reference
Update a port
Suggest changes
PDFs
PATCH /network/ethernet/ports/{uuid}
Introduced In: 9.6
Updates a port.
Related ONTAP commands
-
network port broadcast-domain add-ports -
network port broadcast-domain remove-ports -
network port ifgrp modify -
network port modify -
network port vlan modify -
network port reachability repair
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
path |
True |
Port UUID |
Request Body
| Name | Type | Description |
|---|---|---|
_links |
||
broadcast_domain |
Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input. |
|
enabled |
boolean |
|
lag |
||
mac_address |
string |
|
metric |
The most recent sample of I/O metrics for the port. |
|
mtu |
integer |
MTU of the port in bytes. Set by broadcast domain. |
name |
string |
Portname, such as e0a, e1b-100 (VLAN on Ethernet), a0c (LAG/ifgrp), a0d-200 (VLAN on LAG/ifgrp), e0a.pv1 (p-VLAN, in select environments only) |
node |
||
rdma_protocols |
array[string] |
Supported RDMA offload protocols |
reachability |
string |
Reachability status of the port. Enum value "ok" is the only acceptable value for a PATCH request to repair a port. |
reachable_broadcast_domains |
array[reachable_broadcast_domains] |
Reachable broadcast domains. |
speed |
integer |
Link speed in Mbps |
state |
string |
Operational state of the port. The state is set to 'down' if the operational state of the port is down. The state is set to 'up' if the link state of the port is up and the port is healthy. The state is set to 'up' if the link state of the port is up and configured to ignore health status. The state is 'degraded' if the link state of the port is up, and the port is not healthy. |
statistics |
The real time I/O statistics for the port. |
|
type |
string |
Type of physical or virtual port |
uuid |
string |
Port UUID |
vlan |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"broadcast_domain": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ipspace": {
"name": "ipspace1"
},
"name": "bd1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"lag": {
"active_ports": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"distribution_policy": "string",
"member_ports": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"mode": "string"
},
"mac_address": "01:02:03:04:05:06",
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"duration": "PT15S",
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25T11:20:13Z"
},
"mtu": 1500,
"name": "e1b",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"rdma_protocols": [
"roce"
],
"reachability": "ok",
"reachable_broadcast_domains": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ipspace": {
"name": "ipspace1"
},
"name": "bd1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"speed": 1000,
"state": "string",
"statistics": {
"device": {
"link_down_count_raw": 3,
"receive_raw": {
"discards": 100,
"errors": 200,
"packets": 500
},
"timestamp": "2017-01-25T11:20:13Z",
"transmit_raw": {
"discards": 100,
"errors": 200,
"packets": 500
}
},
"status": "ok",
"throughput_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25T11:20:13Z"
},
"type": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
"vlan": {
"base_port": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"tag": 100
}
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
1376361 |
Port is already a member of a LAG. |
1376488 |
Disabling the last operational cluster port on a node is not allowed. |
1377562 |
Port cannot be used because it is currently the home port or current port of an interface. |
1377563 |
Port is already a member of a LAG. |
1967087 |
The specified broadcast domain UUID is not valid. |
1967088 |
The specified broadcast domain name does not exist in the specified IPspace. |
1967089 |
The specified broadcast domain UUID, name and IPspace name do not match. |
1967094 |
The specified LAG member port UUID is not valid. |
1967095 |
The specified LAG member port name and node name combination is not valid. |
1967096 |
The specified node does not match the specified LAG member port node. |
1967097 |
The specified LAG member ports UUID, name, and node name do not match. |
1967148 |
Failure to remove port from broadcast domain. |
1967149 |
Failure to add port to broadcast domain. |
1967184 |
The reachability parameter cannot be patched in the same request as other parameters that might affect the target port's reachability status. |
1967185 |
The port cannot be repaired because the port is deemed as non-repairable. |
1967186 |
Invalid value for the reachability parameter. |
1967580 |
This command is not supported as the effective cluster version is earlier than 9.8. |
1967582 |
The reachability parameter is not supported on this cluster. |
| 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 |
ipspace
| Name | Type | Description |
|---|---|---|
name |
string |
Name of the broadcast domain's IPspace |
broadcast_domain
Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input.
| Name | Type | Description |
|---|---|---|
_links |
||
ipspace |
||
name |
string |
Name of the broadcast domain, scoped to its IPspace |
uuid |
string |
Broadcast domain UUID |
node
| Name | Type | Description |
|---|---|---|
name |
string |
Name of node on which the port is located. |
active_ports
Port UUID along with readable names. Either the UUID or both names may be supplied on input.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
member_ports
Port UUID along with readable names. Either the UUID or both names may be supplied on input.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
lag
| Name | Type | Description |
|---|---|---|
active_ports |
array[active_ports] |
Active ports of a LAG (ifgrp). (Some member ports may be inactive.) |
distribution_policy |
string |
Policy for mapping flows to ports for outbound packets through a LAG (ifgrp). |
member_ports |
array[member_ports] |
|
mode |
string |
Determines how the ports interact with the switch. |
throughput
The rate of throughput bytes per second observed at the interface.
| Name | Type | Description |
|---|---|---|
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
metric
The most recent sample of I/O metrics for the port.
| Name | Type | Description |
|---|---|---|
_links |
||
duration |
string |
The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations: |
status |
string |
Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "inconsistent_old_data" is returned when one or more nodes do not have the latest data. |
throughput |
The rate of throughput bytes per second observed at the interface. |
|
timestamp |
string |
The timestamp of the performance data. |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
reachable_broadcast_domains
Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input.
| Name | Type | Description |
|---|---|---|
_links |
||
ipspace |
||
name |
string |
Name of the broadcast domain, scoped to its IPspace |
uuid |
string |
Broadcast domain UUID |
receive_raw
Packet receive counters for the Ethernet port.
| Name | Type | Description |
|---|---|---|
discards |
integer |
Total number of discarded packets. |
errors |
integer |
Number of packet errors. |
packets |
integer |
Total packet count. |
transmit_raw
Packet transmit counters for the Ethernet port.
| Name | Type | Description |
|---|---|---|
discards |
integer |
Total number of discarded packets. |
errors |
integer |
Number of packet errors. |
packets |
integer |
Total packet count. |
device
Device-related counters for the port object. These counters are applicable at the lowest layer of the networking stack. These values can be used to calculate both transmit and receive packet and error rates by comparing two samples taken at different times and calculating the increase in counter value divided by the elapsed time between the two samples.
| Name | Type | Description |
|---|---|---|
link_down_count_raw |
integer |
The number of link state changes from up to down seen on the device. |
receive_raw |
Packet receive counters for the Ethernet port. |
|
timestamp |
string |
The timestamp when the device specific counters were collected. |
transmit_raw |
Packet transmit counters for the Ethernet port. |
throughput_raw
Throughput bytes observed at the port object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.
| Name | Type | Description |
|---|---|---|
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
statistics
The real time I/O statistics for the port.
| Name | Type | Description |
|---|---|---|
device |
Device-related counters for the port object. These counters are applicable at the lowest layer of the networking stack. These values can be used to calculate both transmit and receive packet and error rates by comparing two samples taken at different times and calculating the increase in counter value divided by the elapsed time between the two samples. |
|
status |
string |
Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "inconsistent_old_data" is returned when one or more nodes do not have the latest data. |
throughput_raw |
Throughput bytes observed at the port object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time. |
|
timestamp |
string |
The timestamp of the throughput_raw performance data. |
base_port
Port UUID along with readable names. Either the UUID or both names may be supplied on input.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
vlan
| Name | Type | Description |
|---|---|---|
base_port |
Port UUID along with readable names. Either the UUID or both names may be supplied on input. |
|
tag |
integer |
VLAN ID |
port
| Name | Type | Description |
|---|---|---|
_links |
||
broadcast_domain |
Broadcast domain UUID along with a readable name. Either the UUID or both names may be provided on input. |
|
enabled |
boolean |
|
lag |
||
mac_address |
string |
|
metric |
The most recent sample of I/O metrics for the port. |
|
mtu |
integer |
MTU of the port in bytes. Set by broadcast domain. |
name |
string |
Portname, such as e0a, e1b-100 (VLAN on Ethernet), a0c (LAG/ifgrp), a0d-200 (VLAN on LAG/ifgrp), e0a.pv1 (p-VLAN, in select environments only) |
node |
||
rdma_protocols |
array[string] |
Supported RDMA offload protocols |
reachability |
string |
Reachability status of the port. Enum value "ok" is the only acceptable value for a PATCH request to repair a port. |
reachable_broadcast_domains |
array[reachable_broadcast_domains] |
Reachable broadcast domains. |
speed |
integer |
Link speed in Mbps |
state |
string |
Operational state of the port. The state is set to 'down' if the operational state of the port is down. The state is set to 'up' if the link state of the port is up and the port is healthy. The state is set to 'up' if the link state of the port is up and configured to ignore health status. The state is 'degraded' if the link state of the port is up, and the port is not healthy. |
statistics |
The real time I/O statistics for the port. |
|
type |
string |
Type of physical or virtual port |
uuid |
string |
Port UUID |
vlan |
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. |