/system/vlans/{id}

put

https://switch-ip/rest/v10.08/system/vlans/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

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

mgmd_igmp_version

integer

2 to 3

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

aclv4_in_cfg_version

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. An empty value mean no ingress IPv4 ACL has been configured for the VLAN. Ignored if configured on VLANs with type = 'internal'.

dhcpv4_snooping_guard_disable

boolean

Disables DHCP packet inspection for this VLAN. This would disable enforcement of any snoop policy configuration on this VLAN including the trusted/untrusted port configurations. It will also disable validation of DHCP packets for compliance with the snooping database information.

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

policy_in_cfg

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'.

dhcpv6_snooping_binding_disable

boolean

Disables learning of DHCPv6 Snooping binding entries.

voice

boolean

Marks VLAN as voice VLAN.

policy_in_cfg_version

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. An empty value means no ingress Policy has been configured for the VLAN. Ignored if configured on VLANs with type = 'internal'.

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

dhcpv6_snooping_guard_policy

string

Reference Resource: DHCPv6_Snooping_Guard_Policy
DHCPv6 Guard Policy for VLAN.

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

dhcpv4_snooping_guard_policy

string

Reference Resource: DHCPv4_Snooping_Guard_Policy
DHCPv4 Guard Policy for VLAN.

dhcpv6_snooping_enable

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.

dhcpv4_snooping_binding_disable

boolean

Disables learning of DHCPv4 Snooping binding entries.

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

ipv6_destination_guard_policy

string

Reference Resource: IPv6_Destination_Guard_Policy
IPv6 Destination Guard Policy for VLAN. When destination guard is enabled on any VLAN, both ingress and egress traffic will be guarded.

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

aclmac_in_cfg_version

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. An empty value mean no ingress MAC ACL has been configured for the VLAN. Ignored if configured on VLANs with type = 'internal'.

aclv6_in_cfg

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'.

description

string

User provided description of this 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_enable

object

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

type

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:

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.

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

admin

string

enum

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

Allowed:

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

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

dhcpv6_snooping_guard_disable

boolean

nd_snoop_config

object

aclmac_in_cfg

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'.

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

aclv4_in_cfg

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'.

aclv6_in_cfg_version

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. An empty value mean no ingress IPv6 ACL has been configured for the VLAN. Ignored if configured on VLANs with type = 'internal'.

dhcpv4_snooping_enable

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.

mgmd_mld_version

integer

1 to 2

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

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

static_macs

string

name

string

required

length between 1 and 32

User configurable VLAN name.

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

Responses

200

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