Switch ports REST API

Get all Switch Ports

Returns a list of Switch Ports.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body

[
   {
      "ttl_pckts_out": 806236807,
      "lacp_state": "--",
      "created_time_raw": 1465935962826,
      "events": [
      ],
      "rate_pckts_out": 12,
      "rx_flow_ctrl": "no",
      "state": "available",
      "ttl_pckts_in": 395946602,
      "rate_pckts_in": 16,
      "link_aggregation": null,
      "updated_time": "Tue 09 Aug 2016 13:43:05.576 UTC",
      "ttl_pckt_errors": 0,
      "version": "2.2.2.0",
      "network_utilization_in": 0,
      "network_utilization_out": 0,
      "lacp_mode": "off",
      "id": "/admin/resources/switch_ports/50648910-fa0f-458c-bc5f-d58c518ded8a",
      "switches": "/admin/resources/switches/9ac233c4-d2b6-48ed-9bc4-6e9776def292",
      "pna_port_id": null,
      "leds": null,
      "wwpn": null,
      "name": "1",
      "port_number": 1,
      "tx_flow_ctrl": "no",
      "trunk_groups": null,
      "rate_pckt_errors": 0,
      "lacp_aggregator": "--",
      "link_state": "available",
      "speed": 10,
      "isas_rn": 1,
      "label_text": "Top of Rack Switch Port",
      "label_key": "pure2317",
      "units": "Gbps",
      "mac_address": "a4:8c:db:67:8a:00",
      "updated_time_raw": 1470750185576,
      "created_time": "Tue 14 Jun 2016 20:26:02.826 UTC",
      "duplex": "full"
   }
]

created_time

The time at which the object is created

duplex

The duplex of this port, either full or half

id

The unique ID of the object in the system.

label_key

The key for retrieving the label for the virtual link aggregation

label_text

Default translated message text

lacp_aggregator

The Link Aggregation Control Protocol aggregator of this port

lacp_mode

The Link Aggregation Control Protocol mode of this port, either active or passive

lacp_state

The Link Aggregation Control Protocol state of this port

leds

The ID of the LED associated with this port.

link_aggregation

The link aggregation of this port

link_state

The state of this port's link, either available, unavailable or down

mac_address

The MAC address of this port

name

A descriptive name for this port

pna_port_id

The PNA ID of this port

port_number

The number of this port

rate_pckt_errors

The rate of packet errors on the port

rate_pckts_in

The rate of packets flowing into the port

rate_pckts_out

The rate of packets flowing out of the port

rx_flow_ctrl

Whether or not RX (receive) flow control is enabled on this port?

speed

The speed of this port

state

The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.

switches

The ID of the switch associated with this port

trunk_group

The trunk group of this port

ttl_pckt_errors

The total number of packet errors on the port

ttl_pckts_in

The total number of packets flowing into the port

ttl_pckts_out

The total number of packets flowing out of the port

tx_flow_ctrl

Whether or not TX (transmit) flow control is enabled on this port

units

The units of this port speed

updated_time

The time at which the object was last updated

wwpn

The World Wide Port Name of this port

Parents:

switches

Get a specific Switch Port

Returns a single Switch Port identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Re-enable errdisable Switch Port

Returns the state of a re-enabled Switch Port identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.