API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create VLAN interface configurations

Layer 3 VLAN interface (SVI) enabling IP routing for a VLAN segment.
Each entity is identified by VLAN ID. Configure IP addresses
(IPv4/IPv6), DHCP services, routing protocol parameters, VRRP, active
gateway, and access policies for inter-VLAN routing. Device Limits:
Gateway supports max 3 IPv6 addresses, 16 IPv4 helper addresses, and 3
IPv6 helper addresses per VLAN interface. Use these APIs to create,
modify, or delete a VLAN interface.

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

VLAN interface identifier.

Query Params
string

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

string

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

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

urpf
object

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

pppoe
object

IPv4 PPPoE configurations.

ip
object

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

ipv4
object

IPv4 configurations on VLAN interfaces.

ipv6
object

IPv6 configurations on VLAN interfaces.

boolean
Defaults to false

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

policy
object

Grouping for access-list configurations.

vsx
object

VSX configuration.

active-gateway
object

Active gateway config.

arp
object

Neighbor Discovery Manager parameters for ipv4.

nd
object

Neighbor Discovery Manager parameters for ipv6.

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-dense-vlan
object

PIM-DM protocol on Vlan interface.

pim-sparse-vlan
object

PIM-SM protocol.

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

dhcpv6-client-auth
object

DHCPv6 Client Authentication Configuration.

string
length between 1 and 256

Bandwidth Contract name

boolean
Defaults to false

Broadcast multicast optimization (BCMC) to prevent flooding. BCMC will drop unwanted broadcast and multicast
frames on a VLAN.

boolean

Drop all L2 traffic between users on this vlan except addresses in the allowed address list. Gateway and DNS addresses are auto learnt. Disabled by default

string
length between 1 and 256

Description of the interface.

boolean
Defaults to false

Disable layer3 functionality

boolean

Enable the interface.

int32
1 to 4094

VLAN interface identifier.

string
length between 1 and 144

Policy for inbound traffic.

boolean
Defaults to false

Enable VLAN flooding when a link goes down.

boolean
Defaults to true

Indicates whether the VLAN interface is considered valid on the device.
Setting it to false to override the inherited configuration will
delete the VLAN interface on the device.
The default value is true at the time of creating the interface.

boolean
Defaults to false

Jumbo VLAN allowing you to pass packets up to 9216 bytes in size.

mdns-sd
object

Grouping for multicast DNS Service Discovery interface
configurations.

int32
5 to 3600

Multimode Authentication lease time in minutes

boolean
Defaults to false

The interface to listen to the NTP multicast packets.

boolean
Defaults to false

Set operational state of the VLAN Interface to be always up.

qos
object

QoS interface vlan parameters.

int32
128 to 1460
Defaults to 1460

TCP Maximum Segment size in bytes

string
length ≤ 9999

Add the interface to the VRF instance uniquely identified by its name.

vrrp
object

IPv4 and IPv6 VRRP Configurations

Responses

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