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

/system/vlans/{VLAN.id}

patch
https://switch-ip/rest/v10.16/system/vlans/
Path Params
string
required

Reference Resource: VLAN
The ID of this VLAN. Non-internal VLANs must have an 'id' between 1 and 4094 to be effectively instantiated.

Body Params
string

Reference Resource: ACL
Ingress MAC ACL, potentially in flight, desired to be applied to this VLAN, as identified in the ACL. Ignored if configured on VLANs with type = 'internal'. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclmac_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclmac_in_cfg' value. Ignored if configured on VLANs with type = 'internal'. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Ingress IPv4 ACL, potentially in flight, desired to be applied to this VLAN, as identified in the ACL. Ignored if configured on VLANs with type = 'internal'. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv4_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv4_in_cfg' value. Ignored if configured on VLANs with type = 'internal'. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: ACL
Ingress IPv6 ACL, potentially in flight, desired to be applied to this VLAN, as identified in the ACL. Ignored if configured on VLANs with type = 'internal'. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'aclv6_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'aclv6_in_cfg' value. Ignored if configured on VLANs with type = 'internal'. An empty column value will indicate that the user does not want the system to process this configuration yet.

string
enum

Administratively configured state of this VLAN. This is user configurable only for static VLANs.

Allowed:
delete_macs_requested
object

Reference Resource: MAC
Key is reference to Dynamic MACs rows requested to be deleted on this VLAN. Eventually these MACs will be cleared from the system and delete_macs_requested will revert to an empty list. If the value is true, the MAC will be force deleted if the MAC was not learnt through data plane

string

User provided description of this VLAN.

boolean

Enables DHCPv4 Snooping feature on the VLAN. DHCPv4 Snooping is active on the Ports of the VLAN only if the feature is enabled on the VLAN and globally.

string

Reference Resource: DHCPv4_Snooping_Guard_Policy
DHCPv4 Guard Policy for VLAN.

boolean

Disables learning of DHCPv4 Snooping binding entries. Only policy based packet inspection is performed.

boolean

Allow binding entries to be learned on trusted port.

boolean

Enables DHCPv6 Snooping feature on the VLAN. DHCPv6 Snooping is active on the Ports of the VLAN only if the feature is enabled on the VLAN and globally.

string

Reference Resource: DHCPv6_Snooping_Guard_Policy
DHCPv6 Guard Policy for VLAN.

boolean

Disables learning of DHCPv6 Snooping binding entries. Only policy based packet inspection is performed.

boolean

Enables the IP Lockdown feature on the VLAN. When set, IPv4 traffic from clients on ports of this VLAN will be forwarded only when there is an associated IP binding entry.

boolean

Enables IPv6 destination guard feature on the VLAN. IPv6 destination guard is active on the Ports of the VLAN only if the both DHCPv6 snooping and ND snooping features are enabled on the VLAN and globally.

boolean

Enables the IP Lockdown feature on the VLAN. When set, IPv6 traffic from clients on ports of this VLAN will be forwarded only when there is an associated IP binding entry.

mgmd_enable
object

Enable or disable IGMP/MLD on the VLAN. By default, IGMP/MLD is disabled on the VLAN.

mgmd_igmp_block_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
List of Port in block mode for IGMP. Instruct the device to drop incoming multicast packets received on the specified ports.

mgmd_igmp_block_ports
mgmd_igmp_fastleave_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
Enables or disables IGMP Fast Leaves. List of Port with fastleave configured.

mgmd_igmp_fastleave_ports
mgmd_igmp_forcedfastleave_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
List of Port with forced fastleave configured. When enabled, this feature forces IGMP Fast Leaves to occur even when the port is cascaded.

mgmd_igmp_forcedfastleave_ports
mgmd_igmp_forward_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
List of Port in forward mode for IGMP. Instruct the device to forward incoming multicast packets received on the specified ports.

mgmd_igmp_forward_ports
mgmd_igmp_static_group_ports
object

Reference Resource: Port
Specifies the list of ports for which Static join is configured for specific IPv4 multicast group and source address.

mgmd_igmp_static_groups
array of strings
length ≤ 9223372036854776000

The list of IGMP static group IP addresses. The entries are stored in the Source_Group format.

mgmd_igmp_static_groups
integer
2 to 3

The IGMP protocol version to use. When IGMP snooping is disabled this field would be empty.

mgmd_mld_block_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
List of Port in block mode for MLD. Instruct the device to drop incoming multicast packets received on the specified ports.

mgmd_mld_block_ports
mgmd_mld_fastleave_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
Enables or disables MLD fast leaves. The list of Port with fastleave configured.

mgmd_mld_fastleave_ports
mgmd_mld_forcedfastleave_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
List of the Port with forced fastleave configured. When enabled, this feature forces MLD fast leaves to occur even when the port is cascaded.

mgmd_mld_forcedfastleave_ports
mgmd_mld_forward_ports
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
List of the Port in forward mode for MLD. Instruct the device to forward incoming multicast packets received on the specified ports.

mgmd_mld_forward_ports
mgmd_mld_static_group_ports
object

Reference Resource: Port
Specifies the list of ports for which Static join is configured for specific IPv6 multicast group and source address.

mgmd_mld_static_groups
array of strings
length ≤ 9223372036854776000

List of MLD static group IP addresses. The entries are stored in the Source_Group format.

mgmd_mld_static_groups
integer
1 to 2

The MLD protocol version to use. When IGMP snooping is disabled, this field would be empty.

mgmd_snooping_acl
object

Reference Resource: ACL
Ingress ACL to filter processing of MGMD reports and leave messages received from hosts. When this is not configured, all MGMD reports and leave messages will be processed.

string
required
length between 1 and 32

User configurable VLAN name.

nd_snoop_config
object
nd_snooping_prefix
array of strings
length ≤ 9223372036854776000

List of network prefix ranges allowed on the VLAN. An ND packet with a source IP not matching any of the prefixes configured here will be dropped. If this is empty, source IP prefix validation is not performed.

nd_snooping_prefix
string

Reference Resource: Policy
Ingress Classifier Policy, potentially in flight, desired to be applied to this VLAN, as identified in the Policy. Ignored if configured on VLANs with type = 'internal'. An empty column value indicates that no list is applied for this type and direction.

int64
-9007199254740991 to 9007199254740991

The version of the 'policy_in_cfg' column. This value is changed to a random value each time any management interface modifies the 'policy_in_cfg' value. Ignored if configured on VLANs with type = 'internal'. An empty column value will indicate that the user does not want the system to process this configuration yet.

string

Reference Resource: VLAN
Specifies the Primary VLAN associated with this secondary VLAN This is applicable to Secondary VLANs only. When pvlan_association is not set and pvlan_type is set, then considered as misconfiguration and brought down the VLAN.

string
enum

Specifies the VLAN's type in the context of Private VLAN. When not set, it will work as regular VLAN.

Allowed:
string

Reference Resource: RA_Guard_Policy
RA Guard policy associated with this VLAN. RR/RA packets received on this VLAN will be inspected and permitted per the policy specification.

string
string
enum

The value indicates whether the VLAN was statically configured, internal VLAN, default VLAN, was learned dynamically via a protocol like MVRP or learned via port-access authentication.

Allowed:
boolean

Marks VLAN as voice VLAN.

vsx_sync
array of strings
length ≤ 9223372036854776000

Controls which attributes should be synchronized between VSX peers. 'all_attributes_and_dependents': the entire VLAN should be synchronized.

vsx_sync
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Updated almost 4 years ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated almost 4 years ago