Skip to main content
REST API reference

Retrieve an Ethernet switch port

PDFs

GET /network/ethernet/switch/ports/{switch}/{identity.name}/{identity.index}

Introduced In: 9.8

Retrieves an ethernet switch port.

  • system switch ethernet interface show

Parameters

Name Type In Required Description

switch

string

path

True

Switch Name

identity.name

string

path

True

Interface Name

identity.index

integer

path

True

Interface Index

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

configured

string

Administrative Status.

duplex_type

string

Duplex Settings.

identity

identity

isl

boolean

Is configured as an ISL link.

mac_address

string

MAC Address.

mtu

integer

MTU.

remote_port

remote_port

Remote port.

roles

array[roles]

speed

integer

Interface Speed(Mbps).

state

string

Operational Status.

statistics

statistics

These are raw counters for the device associated with the Ethernet port.

switch

switch

The name of the specified cluster or storage switch.

type

string

Interface Type.

vlan_id

array[integer]

vpc_peer_link

boolean

Is configured as a Virtual Port Channel (vPC) peer-link.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "configured": "string",
  "duplex_type": "string",
  "identity": {
    "breakout": {
      "number": 1,
      "physical_port": "Ethernet1/9"
    },
    "index": 0,
    "name": "string",
    "number": 0
  },
  "mac_address": "string",
  "mtu": 0,
  "remote_port": {
    "device": {
      "discovered_name": "stiA400-311",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "shelf": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "module": "string",
        "name": "1.1",
        "uid": "12439000444923584512"
      }
    },
    "functional_roles": [
      "string"
    ],
    "mtu": 0,
    "name": "string"
  },
  "roles": [
    {
      "dr_group": "string",
      "type": "string"
    }
  ],
  "speed": 0,
  "state": "string",
  "statistics": {
    "receive_raw": {
      "discards": 100,
      "errors": 200,
      "packets": 500
    },
    "timestamp": "2024-11-18 10:52:17 -0500",
    "transmit_raw": {
      "discards": 100,
      "errors": 200,
      "packets": 500
    }
  },
  "switch": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "RTP-SS01-510R03(FOC223443KQ)"
  },
  "type": "string",
  "vlan_id": [
    "integer"
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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
Name Type Description

self

href

breakout

Name Type Description

number

integer

Breakout port sub-interface number.

physical_port

string

Breakout physical port name.

identity

Name Type Description

breakout

breakout

index

integer

Interface Index.

name

string

Interface Name.

number

integer

Interface Number.

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

shelf

Shelf connected to this port.

Name Type Description

_links

_links

module

string

Shelf module connected to this port.

name

string

uid

string

device

Device connected to port.

Name Type Description

discovered_name

string

Raw name of the discovered device.

node

node

shelf

shelf

Shelf connected to this port.

remote_port

Remote port.

Name Type Description

device

device

Device connected to port.

functional_roles

array[string]

mtu

integer

MTU in octets.

name

string

Remote port name.

roles

Allowed use for this port.

Name Type Description

dr_group

string

DR group.

type

string

Allowed use type.

zone

integer

Zone ID to differentiate between roles with the same type.

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.

statistics

These are raw counters for the device associated with the Ethernet port.

Name Type Description

receive_raw

receive_raw

Packet receive counters for the Ethernet port.

timestamp

string

The time the statistics were gathered.

transmit_raw

transmit_raw

Packet transmit counters for the Ethernet port.

switch

The name of the specified cluster or storage switch.

Name Type Description

_links

self_link

name

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.