HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Update a Port configuration by UUID

put
https://example.com/api/ports/
  • If the value not_applicable is submitted for the qsfp_mode property, it will be ignored
  • The properties ecn, pause and enable_lossless are not currently supported and will be ignored
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 32 and 36

UUID of Port to update

Body Params

Port properties to be updated.

string
enum
required

Administratively controlled state

Allowed:
bridge_loop_detection
object
required

Bridge loop detection setting for this port.

string | null
required
string | null

UUID of the downlink switch connected to this port.

ecn
array of numbers
length ≤ 8

Set ECN on packets that experience congestion on these COS levels when leaving this port. An empty list will disable ECN on this port.

ecn
boolean
Defaults to false

When true, priority flow control will be enabled and configured with settings defined for queue_configuration in the fabric settings.

l2vpn_information
array of objects

If the l2vpn query parameter is true, this list will contain any associated L2VPN UUIDs and their names.

l2vpn_information
string
required

The user-defined port name (if any)

number | null
required
0 to 4094

This VLAN is:

  • Applied to all untagged traffic coming in to this Port (ingress)
  • Removed from all traffic tagged with this VLAN which is leaving this Port (egress)
  • NOTE: a native_vlan value of 0 means that any untagged traffic will be dropped on either ingress or egress
string
enum
Defaults to none

Pause (802.3x) mode of this port.

Allowed:
qos_ingress_policies
array

QoS ingress policies for this port. This is an ordered list. On a PUT:

  • If the field is not set, leave the existing list alone.
  • If the field is set to an empty list, remove all QoS policies associated with this port.
  • If the field is set to a non-empty list, replace the existing QoS policy list with the given list.
qos_ingress_policies
string

QSFP transform status of this port.split - ports are in split modeno-split - ports are in unsplit modenot applicable

string
enum
required

QSFP mode of this port.

speed
object
required
speed_group
array
speed_group
string
length ≤ 255
string
string
enum
required
Allowed:
string | null

VLANs directly assigned to this port, not assigned through a VLAN group; presented as a sorted set of ranges.

vlan_group_uuids
array
required

UUIDs of the VLAN groups associated with this port.

vlan_group_uuids*
integer
46 to 9198
Defaults to 9198

Sets the MTU (maximum transmission unit) for an interface.

boolean
Defaults to false

Indicates that this port is:

  • true - routed
  • false - not routed
integer
≤ 4

Number of lanes

string | null
enum
Allowed:
boolean | null
Responses

Updated over 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; version=1.0

Updated over 2 years ago