networking_switch_port_list

List switch ports
get/v1/system/hardware/switch-port

Query Parameters

limit

Maximum number of items returned by a single call

page_token

Token returned by previous call to retrieve the subsequent page

sort_by

Supported set of sort modes for scanning by id only.

Currently, we only support scanning in ascending order.

switch_port_id

An optional switch port id to use when listing switch ports.

Responses

Object
items

list of items on this page of results

A switch port represents a physical external port on a rack switch.

Object
id

The id of the switch port.

port_name

The name of this switch port.

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

port_settings_id

The primary settings group of this switch port. Will be None until this switch port is configured.

rack_id

The rack this switch port belongs to.

switch_location

The switch location of this switch port.

next_page

token used to fetch the next page of results (if any)