REST API reference
Retrieve a physical port, VLAN, or LAG details
Suggest changes
PDFs
GET /network/ethernet/ports/{uuid}
Introduced In: 9.6
Retrieves the details of a physical port, VLAN, or LAG.
Related ONTAP commands
-
network port show -
network port ifgrp show -
network port vlan show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
uuid |
string |
path |
True |
Port UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| 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. |
|
discovered_devices |
array[discovered_devices] |
Discovered devices |
enabled |
boolean |
|
interface_count |
integer |
Number of interfaces hosted. This field is only applicable for cluster administrators. No value is returned for SVM administrators. If the node hosting a port is not healthy no value will be returned. |
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 response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"broadcast_domain": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ipspace": {
"name": "ipspace1"
},
"name": "bd1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"discovered_devices": {
"capabilities": [
"router",
"switch"
],
"ip_addresses": [
"192.168.100.24",
"192.168.100.26"
],
"name": "ETY-R1S4-510Q13.datacenter.example.com",
"platform": "93180YC-EX",
"protocol": "cdp",
"remote_port": "FastEthernet0/12",
"version": "Cisco Nexus Operating System (NX-OS) Software, Version 8.1"
},
"interface_count": 0,
"lag": {
"active_ports": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"distribution_policy": "port",
"member_ports": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "e1b",
"node": {
"name": "node1"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"mode": "multimode_lacp"
},
"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": {
},
"reachability": "ok",
"reachable_broadcast_domains": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ipspace": {
"name": "ipspace1"
},
"name": "bd1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"speed": 1000,
"state": "up",
"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": "vlan",
"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
}
}Error
Status: Default, Error| 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 |
discovered_devices
| Name | Type | Description |
|---|---|---|
capabilities |
array[string] |
The list of the capabilities of the discovered device. |
chassis_id |
string |
Identifier associated with this specific discovered device, useful for locating the device in a data center. |
ip_addresses |
array[string] |
The IP addresses on the discovered device. |
name |
string |
Name of the discovered device. |
platform |
string |
Hardware platform of the discovered device. |
protocol |
string |
The protocol used to identify the discovered device. This can have a value of CDP or LLDP. |
remaining_hold_time |
integer |
The number of seconds until the discovered device entry expires and is removed. |
remote_port |
string |
The name of the remote port on the discovered device. The format is dependent on the reporting device. |
system_name |
string |
Additional name used to identifiy a specific piece of equipment. |
version |
string |
The version of the software running on the discovered device. |
node
| Name | Type | Description |
|---|---|---|
name |
string |
Name of node on which the port is located. |
active_ports
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
member_ports
| 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] |
Array of ports belonging to the LAG, regardless of their state. |
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
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
node |
||
uuid |
string |
vlan
| Name | Type | Description |
|---|---|---|
base_port |
||
tag |
integer |
VLAN ID |
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. |