Create port channel interface configurations

post

https://de1.api.central.arubanetworks.com/network-config/v1alpha1/portchannels/{name}

Port channel interface aggregating multiple physical Ethernet ports
into a single logical trunk. Each entity is identified by portchannel
ID. Configure member ports, LACP parameters, VLANs, IP addresses,
routing protocols, and port-security settings. Device Limits: Gateway
supports port channels 0-7. Use these APIs to create, modify, or
delete a port channel interface.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

length ≤ 9999

Port channel interface name.

Query Params

object-type

string

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

scope-id

string

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

device-function

string

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

Body Params

interfacebody object

policy

object

Grouping for access-list configurations.

policy-vlan-config

object

Container for Policy vlan references.

urpf

object

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

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.

aaa-lag

object

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

vlan-translate

array of objects

length ≤ 2147483647

VLAN translations.

vlan-translate

qos

object

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

lacp

object

LACP interface configuration.

cdp

object

CDP configuration.

qinq

object

QinQ interface level configuration.This feature
is not supported.

switchport

object

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

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.

arp

object

Neighbor Discovery Manager parameters for ipv4.

object

Neighbor Discovery Manager parameters for ipv6.

ip-directed-broadcast-enable

boolean

Defaults to false

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

sflow

object

sFlow configuration.

vsx

object

VSX configuration.

boundary-acl

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.

igmp

object

Grouping for common MGMD Configurations on interface

mld

object

Grouping for common MGMD Configurations on interface

ipv4-relay

object

DHCPv4 Relay Configurations

ipfix-flow-monitor-in

object

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

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.

client-limit-max

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.

connect-to-network-device

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.

mode

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

AUTO	Default mode. Track limited set of clients based on LLDP/CDP signature and access/trunk configuration.
DISABLE	Client IP addresses are not tracked on this port.
ENABLE	Track all client IP addresses on this port.

Allowed:

update-interval

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.

client-limit

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.

incoming-clients-only

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.

profile-name

string

length between 1 and 128

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

hashing

string

enum

L2/L3 src-dst hashing

Show Details

L2	L2
L3	L3
L4	L4

Allowed:

trunk-type

string

enum

Type of trunk.
For gateways, the aggregation types supported are TRUNK for static and LACP for dynamic.
The change of LAG type is not allowed without deleting the members in it. All the members need to be
deleted before changing the LAG type

Show Details

DT_TRUNK	Distributed Manual Trunk.
LACP	IEEE 802.3ad Link Aggregation protocol.
MULTI_CHASSIS	Distributed Trunk Port.
MULTI_CHASSIS_STATIC	Static multi-chassis LAG which does not use LACP
TRUNK	Manual static trunk that does not use LACP protocol.

Allowed:

unknown-vlans

string

enum

Configure GVRP unknown VLANs handling mode for port channel 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

BLOCK	Only process GVRP packets that concern themselves with known VLANs and ignore new VLANs.
DISABLE	Ignore all GVRP packets.
LEARN	Accept join requests for new VLANs on this port and propagate requests through all other forwarding ports that are participating in GVRP.

Allowed:

igmp-snooping-lag

object

MGMD Snooping Common Configurations

mld-snooping-lag

object

MGMD Snooping Common Configurations

ptp

object

PTP interface configuration.

description

string

length between 1 and 256

Description of the interface.

enable

boolean

Enable the interface.

forbid-vlans

array of int32s

length ≤ 2147483647

forbid-vlans

isolated-vlans

array of int32s

length ≤ 2147483647

isolated-vlans

jumbo-mtu

boolean

Defaults to false

Enable Jumbo frame MTU,

mac-notify-traps

array of strings

length ≤ 2147483647

Show Details

AGED	On the enabled port a MAC is aged out.
LEARNED	On this port a MAC learn occurs.
MOVED	On the enabled port a MAC is moved.
REMOVED	On the enabled port a MAC is removed.

mac-notify-traps

macsec-policy

string

length between 1 and 128

MACsec policy to use on the interface.

mka-policy

string

length between 1 and 128

MKA policy to use on the interface.

mvrp

object

MVRP Interface grouping.

name

string

length ≤ 9999

Port channel interface name.

port-list

array of strings

length ≤ 2147483647

port-list

pvlan-port-mode

string

enum

Port modes of private VLAN. Port with PVLAN(Private VLAN) port mode set to secondary or promiscuous
cannot trunk all VLANs. This config is not allowed on routed port.

Show Details

ISL	Extends the PVLAN domain across multiple switches.
PROMISCUOUS	Configure the port to be a member of the primary VLAN.
SECONDARY	Set the port as a member of a secondary VLAN.

Allowed:

retain-port-profile-configs

boolean

Defaults to false

Controls whether profile configurations remain on the portchannel after
the profile is removed. When true, profile settings are preserved.
When false, the portchannel is deleted and the associated interfaces reset
to defaults. This leaf is automatically removed when a port profile is applied.

routing

boolean

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

sw-profile

string

length between 1 and 64

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

sw-profile-alias

string

length between 1 and 256

Alias reference for port profile for this portchannel

trusted

boolean

Defaults to false

Mark as a trusted interface.

trusted-vlans

array of strings

length ≤ 2147483647

trusted-vlans

vrf-forwarding

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 VRRP Configurations

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Operation

400Bad Request

401Unauthorized Access

403Forbidden

404Not Found

406Not Acceptable

408Request Timeout

412Precondition Failed

429Rate limit exceeded

500Internal Server Error