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

Update L2-VLAN

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/layer2-vlan/

List of L2 VLAN profiles

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

VLAN identifier

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

l2-vlanbody object

community-vlan
array of int32s
length ≤ 2147483647
community-vlan
int32
1 to 4094

Configure an isolated VLAN under the current primary VLAN.

int32
1 to 4094

Associating a secondary VLAN of private-vlan-type COMMUNITY or ISOLATED to a primary VLAN

string
enum

Type of private VLAN.For AOS-CX, it can be PRIMARY, ISOLATED, or COMMUNITY.
If the value is ISOLATED or COMMUNITY then private-vlan-association also
should be configured to indicate the primary VLAN to which the ISOLATED/COMMUNITY
VLAN is associated. For PVOS(AOS-S),only PRIMARY is valid. The isolated-vlan and
community-vlan parameters can be used to configure the secondary VLANs.
Private VLAN and QinQ are mutually exclusive.

Show Details
COMMUNITYCommunity VLAN in private VLAN. Hosts in a given community VLAN can communicate with each other through Layer 2 switching. There can be multiple community VLANs associated to a primary VLAN.
ISOLATEDIsolated VLAN in private VLAN. Hosts in isolated VLAN cannot communicate with each other through layer 2 switching.
PRIMARYPrimary VLAN in private VLAN. There can be multiple secondary VLANs associated with a primary VLAN. A primary VLAN and the associated secondary VLANs together are called a private VLAN domain. The hosts in secondary VLAN uses the primary VLAN to communicate with hosts outside the PVLAN domain. Secondary VLANs can be of type either ISOLATED or COMMUNITY.
Allowed:
string
length between 1 and 64

Description of the VLAN profile.;
Limit on description length for AP,GW:32 and for CX:64 characters.

boolean
Defaults to true

Set VLAN Administrative State

boolean
Defaults to false

is this vlan an l3 vlan, used only for GET calls

boolean
Defaults to false

To control DHCPv4 Option 82. This is related to DHCP-Relay module.

string
length between 1 and 144

Policy for inbound (Ingress) traffic.

string
length between 1 and 144

Policy for outbound (Egress) traffic.

protocols
array of strings
length ≤ 2147483647
Show Details
APPLETALKAppletalk Protocol Group
ARPAddress Resolution Protocol (ARP) Group
IPV4IP version 4 Protocol Group
IPV6IP version 6 Protocol Group
IPXIPX Protocol Group
NETBEUINetwork Basic Input/Output Stream (BIOS) Enhanced User Interface Protocol Group
SNASystem Network Architecture (SNA) Protocol Group
protocols
int64
0 to 255
Defaults to 255

Multicast datagram TTL threshold for the
VLAN.

boolean
Defaults to false

Set VLAN type to voice

string
length between 1 and 63

Wired authentication AAA profile

boolean
Defaults to false

Enable client IP tracking on this VLAN. This is applicable to AOS-CX Switch.

igmp
object

Grouping for common MGMD Configurations on the VLAN

mld
object

Grouping for common MGMD Configurations on the VLAN

dhcpv4-snooping
object

VLAN-specific DHCPv4-Snooping parameters

dhcpv6-snooping
object

VLAN-specific DHCPv6-Snooping parameters

nd-snooping
object

Configuration of ND-Snooping on VLAN.

dynamic-arp-inspection
object

Configuration of Dynamic ARP Inspection on VLAN.

destination-guard
object

IPv6 destination guard VLAN prameters.
Enabling IPv6 Destination Guard on a switch prevents ND Cache depletion
issues and it helps in minimizing Denial-Of-Service(DoS) attacks. When
IPv6 destination guard is enabled address resolution is performed only
for the destination addresses that are active on the link.

string
length between 1 and 144

Access-list Policy for inbound (Ingress) traffic.

string
length between 1 and 144

Access-list Policy for outbound (Egress) traffic.

string
length between 1 and 256

Description alias of the VLAN profile.;
Limit on description length for AP,GW:32 and for CX:64 characters.

string
length between 1 and 32

VLAN name

boolean

Set the current VLAN as QinQ svlan

int32
1 to 4094

VLAN identifier

string
length between 1 and 256

Alias to manage vlan voice enable/disable.
voice-enable-alias and voice-enable both cannot be set.

string
length ≤ 9999

Configure a VRF to be used for Distributed Firewall Policy for CX platforms.

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