API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Update existing Ethernet Interface instance configuration

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/ethernet-interfaces/

Represents a single physical Ethernet or USB interface configuration on the device. Each interface is uniquely identified by its name (e.g., 0/0/1, enet0, usb0). Use these APIs to create, modify, or delete an interface configuration instance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Unique identifier for the Ethernet or USB interface. Supported formats include slot-based naming (e.g., 0/0/1 for slot 0, module 0, port 1) and logical naming (e.g., enet0, usb0). Device models enforce specific port ranges through capability constraints (e.g., gateway model GW_7005 supports 0/0/[0-3], GW_7205 supports 0/0/[0-5]). This field is mandatory and serves as the primary key for the interface instance.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

interfacebody object

ptp
object

PTP interface configuration.

string
enum
Show Details
PRIMARYptp lag role primary
SECONDARYptp lag role secondary
Allowed:
poe
object

Power-over-ethernet(PoE) configurations.
The power-over-ethernet (PoE) manages the power supplied to
devices using standard Ethernet data cables.

arp
object

Neighbor Discovery Manager parameters for ipv4.

nd
object

Neighbor Discovery Manager parameters for ipv6.

int32
0 to 255
Defaults to 4

Split into number of children ports.

boolean
Defaults to false

Enable split ports.

string
enum

Split into speed for children ports.

Show Details
PORT_100GThe children speed is 100Gbps.
PORT_10GThe children speed is 10Gbps.
PORT_200GThe children speed is 200Gbps.
PORT_25GThe children speed is 25Gbps.
PORT_50GThe children speed is 50Gbps.
Allowed:
app-aaa-contract
object

Application contracts

app-category-aaa-contract
object

Application category contracts

exclude-app-contract
object

Exclude applications from Bandwidth contracts

exclude-app-cat-contract
object

Exclude application categories from Bandwidth contracts

aaa-bw-contract
object

Bandwidth contracts

lldp
object

TLV parameters to advertise on the specified ports.

boolean
Defaults to false

Enable deep packet inspection (DPI) on an interface level.

boolean

Enable the interface.

boolean
Defaults to false

Enable auto-negotiation of Energy-Efficient Ethernet (EEE). Supported primarily on 1000BASE-T ports
for 4100i, 5420, 6000, 6100, 6200, 6300 and 6400 platforms.

string
enum
Defaults to AUTO_FEC

Forward Error Correction (FEC). Add redundant bits to a data stream
enabling the receiver to detect and correct transmission errors.

Show Details
AUTO_FECUse the transceiver default.
BASE_R_FECUse IEEE BASE-R (Firecode) FEC.
NO_FECDo not use any FEC.
RS_FECUse IEEE Reed-Solomon FEC.
Allowed:
string
length between 1 and 64

Fault monitoring profile to be applied.

boolean
Defaults to false

Narrow clock tolerance for a port in 100 Mb/sec mode. Note that this feature only applies to Smart Rate ports
and only when linked at 100Mbps. It has no effect at other speeds or on other ports. Supported primarily on
Smartrate ports for 6200 and 6300 platforms

mac-notify-traps
array of strings
length ≤ 2147483647
Show Details
AGEDOn the enabled port a MAC is aged out.
LEARNEDOn this port a MAC learn occurs.
MOVEDOn the enabled port a MAC is moved.
REMOVEDOn the enabled port a MAC is removed.
mac-notify-traps
string
length between 1 and 128

MACsec policy to use on the interface.

string
length between 1 and 128

MKA policy to use on the interface.

int64
46 to 9198
Defaults to 1500

Maximum Transmission Unit (MTU) of the interface in bytes. The MTU defines the largest packet size
that can be transmitted over the interface without fragmentation.

mvrp
object

MVRP Interface grouping.

string
enum

Port modes of private VLAN. Cannot configure PVLAN port mode on routed port.
A port with PVLAN port mode secondary/promiscuous cannot trunk all vlans.

Show Details
ISLExtends the PVLAN domain across multiple switches.
PROMISCUOUSConfigure the port to be a member of the primary VLAN.
SECONDARYSet the port as a member of a secondary VLAN.
Allowed:
boolean

Enable routing on the interface to make it layer-3 capable.

boolean
Defaults to false

Enable speed downshift for 1000BASE-T port. This is a non-standard mode for use only when standards-based
auto-negotiation is not able to establish a stable link. Enabling this may cause the port to link at a
lower than expected speed and should not be used on ports that are members of a LAG.

string
enum

Set ethernet speed and duplex based on port type and inserted transceiver.

Show Details
AUTOAuto Negotiation for speed and duplex mode.
AUTO_100GB100 Gb/sec and auto-negotiate link parameters.
AUTO_100MB100 Mb/sec and auto-negotiate link parameters.
AUTO_10GB10 Gb/sec and auto-negotiate link parameters.
AUTO_10MB10 Mb/sec and auto-negotiate link parameters.
AUTO_10MB_100MB10 Mb/sec or 100 Mb/sec and auto-negotiate link parameters.
AUTO_1GB1 Gb/sec and auto-negotiate link parameters.
AUTO_1GB_2500MB1 Gb/sec or 2500 Mb/sec and auto-negotiate link parameters.
AUTO_1GB_2500MB_5GB1 Gb/sec or 2500 Mb/sec or 5 Gb/sec and auto-negotiate link parameters.
AUTO_200GB200 Gb/sec and auto-negotiate link parameters.
AUTO_2500MB2500 Mb/sec and auto-negotiate link parameters.
AUTO_2500MB_5GB2500 Mb/sec or 5 Gb/sec and auto-negotiate link parameters.
AUTO_25GB25 Gb/sec and auto-negotiate link parameters.
AUTO_400GB400 Gb/sec and auto-negotiate link parameters.
AUTO_40GB40 Gb/sec and auto-negotiate link parameters.
AUTO_50GB50 Gb/sec and auto-negotiate link parameters.
AUTO_5GB5 Gb/sec and auto-negotiate link parameters.
FULL_100GB100 Gbps, full duplex.
FULL_100MB100 Mbps, full duplex.
FULL_10GB10 Gbps, full duplex.
FULL_10MB10 Mbps, full duplex.
FULL_1GB1 Gbps, full duplex.
FULL_200GB200 Gbps, full duplex.
FULL_25GB25 Gbps, full duplex.
FULL_400GB400 Gbps, full duplex.
FULL_40GB40 Gbps, full duplex.
FULL_50GB50 Gbps, full duplex.
HALF_100MB100 Mbps, half duplex.
HALF_10MB10 Mbps, half duplex.
boolean
Defaults to false

Override default transceiver speed or auto-negotiation.

trusted-vlans
array of strings
length ≤ 2147483647
trusted-vlans
string
enum

Configure GVRP unknown VLANs handling mode for ethernet interface.
Learn: Accept join requests for new VLANs and propagate through GVRP.
Block: Process GVRP packets for known VLANs only, ignore new VLANs.
Disable: Ignore all GVRP packets.

Show Details
BLOCKOnly process GVRP packets that concern themselves with known VLANs and ignore new VLANs.
DISABLEIgnore all GVRP packets.
LEARNAccept join requests for new VLANs on this port and propagate requests through all other forwarding ports that are participating in GVRP.
Allowed:
string
length ≤ 9999

Add the interface to the VRF instance uniquely identified by its name.
This configuration is valid only on a layer3 interface.

vrrp
object

IPv4 and IPv6 Virtual Router Redundancy Protocol (VRRP) configurations when routing is enabled.

1 to 100000

Specifies the cable-length auto-detection mode or the value
in meters used to compute the headroom limit for lossless traffic
arriving on the interface. The default value is 350 meters.

string
enum

Flow-control mode for the interface: Link Level Flow Control (LLFC),
Priority Flow Control (PFC), or none. On some platforms, memory pools
must first be configured (using the aruba-qos-pool yang model) before
any interface flow-control configuration will take effect.

Show Details
LINK_LEVEL_FLOW_CONTROL802.3x link-level flow control.
NONEDisable flow control.
PRIORITY_FLOW_CONTROL802.1Qbb priority-based flow control.
Allowed:
llfc-flow-control
object

Configuration for 802.3x link-level flow control (LLFC). On some
platforms, a memory pool must first be created (using the
aruba-qos-pool yang model) that matches the llfc-pool-id value before
any 802.3X link-level Tx or RxTx flow-control configuration will
take effect.

lossless-buffer-based-link-level-flow-control
object

Common QoS buffer configurations.

lossless-buffer-based-priority-flow-control
object

Buffer threshold configuration for 802.1Qbb priority flow control,
including XOFF and XON limits, headroom, and other parameters.

boolean
Defaults to false

Enables the priority flow control watchdog. The watchdog detects when
flow-controlled egress queues are paused for an excessive duration, and
takes action when the globally-configured trigger time has elapsed with
the queue remaining paused.

priority-flow-control
object

Configuration for 802.1Qbb priority flow control.

excessive-broadcasts
object

Grouping threshold related leaves as single group.

excessive-multicasts
object

Grouping threshold related leaves as single group.

link-flap
object

fault-monitor-action config

policy
object

Grouping for access-list configurations.

policy-vlan-config
object

Container for Policy vlan references.

switchport
object

Switchport configuration. This configuration is valid only on a layer2 interface.

vlan-translate
array of objects
length ≤ 2147483647

VLAN translations.

vlan-translate
ip
object

IP configuration. This configuration is valid only on a layer3 interface.

ipv4
object

IPv4 configuration. This configuration is valid only on a layer3 interface.

ipv6
object

IPv6 configurations. This configuration is valid only on a layer3 interface.

lacp
object

LACP interface configuration.

boolean
Defaults to false

Enable Multiprotocol Label Switching (MPLS) on the interface.
This configuration is valid only on a layer3 interface.

boolean
Defaults to false

Enable Label Distribution Protocol (LDP) on the interface.
This configuration is valid only on a layer3 interface.

int32
15 to 65535

Defines the time for which a neighbor adjacency will
be kept by the router while it waits for a new link
Hello message. This configuration is valid only on a layer3 interface.

int32
15 to 65535

Defines the interval for holding the session on
each link LDP adjacency. This configuration is valid only on a layer3 interface.

cdp
object

CDP configuration.

boolean
Defaults to false

Enable IP Directed Broadcast on the interface. This configuration is valid only on a layer3 interface.

sflow
object

sFlow configuration.

qinq
object

QinQ interface level configuration.This feature
is not supported.

vsx
object

VSX configuration.

qos
object

Rate-limit a specific traffic-type on this port.

igmp
object

Grouping for common MGMD Configurations on interface

mld
object

Grouping for common MGMD Configurations on interface

ipfix-flow-monitor-in
object

Configuration to apply flow monitor(s) to an interface. The flow monitors will monitor traffic in the ingress direction

igmp-snooping-eth
object

MGMD Snooping Common Configurations

mld-snooping-eth
object

MGMD Snooping Common Configurations

loop-protect
object

Top-level container for advanced loop protect configuration. This is split in two
grouping as CX and PVOS devices have some of these in global context.

stp
object

Interface level spanning-tree configuration. This configuration is valid only on a layer2 interface.

ipv4-relay
object

DHCPv4 Relay Configurations

string
length between 1 and 144

Multicast Boundary ACL to filter all multicast data
and control packets

pim-dense
object

PIM-DM protocol common configuration.

pim-sparse
object

PIM-SM protocol common configuration.

pim6-dense
object

PIM-DM protocol common configuration.

pim6-sparse
object

PIM-SM protocol common configuration.

pim-bidir
object

PIM-Bidir protocol.

dhcpv4-snooping
object

Port-specific DHCPv4-Snooping parameters. This configuration is valid only on a layer2 interface.

dhcpv6-snooping
object

Port-specific DHCPv6-Snooping parameters. This configuration is valid only on a layer2 interface.

nd-snooping
object

Port-specific ND-Snooping parameters. This configuration is valid only on a layer2 interface.

ip-source-lockdown
object

IP source lockdown interface. This configuration is valid only on a layer2 interface.

int32
1 to 4096

Specifiy Maximum number of clients allowed on the port/portlist for Device Fingerprinting.
This configuration is valid only on a layer2 interface.

boolean
Defaults to false

Enables fingerprinting for the clients that comes in after
enabling the fingerprinting feature on the port of AOS-S switch.
This configuration is valid only on a layer2 interface.

string
length between 1 and 128

Apply a Device Fingerprinting Profile to a port/portlist.
This configuration is valid only on a layer2 interface.

int32
1 to 4096
Defaults to 128

Configure the maximum number of clients tracked on this port. It is applicable to AOS-CX switch.
This configuration is valid only on a layer2 interface.

boolean
Defaults to false

Marks a port as being connected with a network device. It is applicable to AOS-S switch.
This configuration is valid only on a layer2 interface.

string
enum

Specifies client IP tracking mode on the port of AOS-CX switch.
This configuration is valid only on a layer2 interface.

Show Details
AUTODefault mode. Track limited set of clients based on LLDP/CDP signature and access/trunk configuration.
DISABLEClient IP addresses are not tracked on this port.
ENABLETrack all client IP addresses on this port.
Allowed:
int32
60 to 28000
Defaults to 1800

Configure the IP address update interval in seconds. It is applicable to AOS-CX switch.
This configuration is valid only on a layer2 interface.

dynamic-arp-inspection
object

Configuration of Dynamic ARP Inspection on interface.
This configuration is valid only on a layer2 interface.

urpf
object

Unicast Reverse Path Forwarding (uRPF) on the interface to prevent IP address spoofing.

aaa
object

Group for security violation configurations shared by aaa-profile and port-security.

port-security
object

Port security port configurations.

boolean
Defaults to false

Enables Direct Attach Copper (DAC) alternate link detection mechanism for improved cable compatibility. This feature helps resolve link-up issues with certain DAC cables by using an alternative link establishment method. Useful for troubleshooting connectivity problems with passive copper cables. Corresponds to the dac-alternate-linkup command on gateway devices.

string
length between 1 and 32

AP Port Profile (if any) associated with the interface.

string
length between 1 and 32

BRIDGE Port Profile (if any) associated with the interface.

string
length between 1 and 64

Description of the interface.
AOS-CX: length: 1-64

string
enum

Configures the duplex mode for the Ethernet interface. Full-duplex allows simultaneous bidirectional communication for maximum throughput. Half-duplex only permits one direction at a time and is rarely used in modern networks. Auto-negotiation (default) automatically selects the best duplex mode supported by both devices. Manual settings must match on both ends of the link to avoid connectivity issues.

Show Details
AUTO_DUPLEXAuto-duplex.
FULL_DUPLEXFull-duplex.
HALF_DUPLEXHalf-duplex.
Allowed:
forbid-vlans
array of int32s
length ≤ 2147483647
forbid-vlans
string
length between 1 and 64

References an existing Gateway Port Profile to apply centrally managed port policies to this interface. Gateway profiles provide template-based configuration for firewall rules, AAA settings, and other gateway-specific features. When assigned, profile settings override local interface configurations unless the retain-profile-configs option is enabled.

isolated-vlans
array of int32s
length ≤ 2147483647
isolated-vlans
boolean
Defaults to false

Enables support for Jumbo frames (Ethernet frames larger than the standard 1500-byte MTU, typically up to 9000 bytes). Jumbo frames improve network throughput and reduce CPU overhead for large data transfers such as storage traffic, backups, and virtualization workloads. All devices in the network path must support Jumbo frames to prevent fragmentation. Corresponds to the jumbo command on gateway devices.

string
length ≤ 9999

Unique identifier for the Ethernet or USB interface. Supported formats include slot-based naming (e.g., 0/0/1 for slot 0, module 0, port 1) and logical naming (e.g., enet0, usb0). Device models enforce specific port ranges through capability constraints (e.g., gateway model GW_7005 supports 0/0/[0-3], GW_7205 supports 0/0/[0-5]). This field is mandatory and serves as the primary key for the interface instance.

port-monitor
object

Configures this interface as a monitoring port that receives mirrored traffic from another source interface (SPAN/port mirroring). The source can be a physical GigabitEthernet interface or a Port-Channel/LAG. All traffic from the source interface is duplicated and sent to this monitoring port for analysis, troubleshooting, or security monitoring purposes. Gateway devices only.

string
enum

Designates the interface as either a WAN (Wide Area Network) or LAN (Local Area Network) port. WAN ports typically connect to external networks or service providers and may apply different security policies, NAT rules, and routing behaviors. LAN ports connect to internal trusted networks. This designation affects firewall rules, routing decisions, and security policy enforcement.

Show Details
LANPort type LAN.
WANPort type WAN.
Allowed:
string
length ≤ 9999

Attach a link aggreagatioin group (LAG) to physical interface.

boolean
Defaults to false

To decide whether or not to retain profile configs on an interface when
the profile is removed from the said interface

string
enum
Defaults to SPEED_AUTO

Configures the link speed for the Ethernet interface. When set to SPEED_AUTO (default), the interface automatically negotiates the highest supported speed with the connected device. Manual speed settings force the interface to operate at a specific rate, which may require matching configuration on the peer device.

Show Details
SPEED_1000GB1000 Gb/sec Ethernet.
SPEED_100GB100 Gb/sec Ethernet.
SPEED_100MB100 Mb/sec Ethernet.
SPEED_10GB10 Gb/sec Ethernet.
SPEED_10MB10 Mb/sec Ethernet.
SPEED_1GB1 Gb/sec Ethernet.
SPEED_2_5GB2.5 Gb/sec Ethernet.
SPEED_40GB40 Gb/sec Ethernet.
SPEED_5GB5 Gb/sec Ethernet.
SPEED_AUTOAuto negotiation Ethernet.
string
enum

Configures the operational speed mode for multi-rate capable interfaces. Only supported on 7280 hardware. Determines whether the interface operates in 40Gbps, 10Gbps, or 1Gbps mode. Changing this setting may affect port availability or require a reboot. Consult hardware documentation for supported speed modes per interface.

Show Details
INTERFACE_10GInterface speed mode of 10 Gb/sec.
INTERFACE_1GInterface speed mode of 1 Gb/sec.
INTERFACE_40GInterface speed mode of 40 Gb/sec.
Allowed:
string
length between 1 and 64

Switch Port Profile (if any) associated with the interface.

boolean

Marks the interface as trusted for security policy purposes. Trusted interfaces bypass certain security checks and firewall rules, allowing unrestricted communication. Typically applied to internal management interfaces or connections to known secure networks. Use with caution as this reduces security enforcement on the interface.

boolean
Defaults to false

Enables tunneled node functionality on the interface, allowing it to participate in overlay network tunneling. When enabled, traffic received on this port can be automatically encapsulated and forwarded through SD-WAN or VPN tunnels based on routing policies. Typically used for branch office deployments where local devices need transparent access to central resources over secure tunnels.

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago