Skip to end of metadata
Go to start of metadata

About this Resource

The Modify Default VLAN allows the user to modify the Default Untagged VLAN of Ethernet Ports. The new Default VLAN can either be selected from the configured VLANs or a new VLAN can be created.

If the new VLAN interface does not have an IP address configured, then the IP will be be migrated from the old VLAN.
If the Default VLAN being modified is used by another port (except the ASM port), then the IP address won't be migrated.
If the selected Port and the ASM Port are configured with the same Default VLAN, then modifying the Default VLAN on the selected Port will change the ASM Port's Default VLAN as well.

REST API Methods for this Resource

Resource Schema

Parameters

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ethernetPortYesNointPossible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the Ethernet Port's Row ID whose Default Untagged VLAN is to be modified. Ethernet Port's Row ID can be obtained by performing a lookup on ethernetport resource using GET ethernetport.
selectVlanOptionYesNoEnummodifyPossible values:
  • 0 - useExisting
  • 1 - create
Specifies the method for selecting the new Default VLAN. New Default VLAN can either be selected from the existing VLAN list or a new VLAN can be created.
defaultVlanIdYesNostringnone6 - Max Length Specifies the VLAN ID which is configured in the system, to be selected as the new Default Untagged VLAN. This field is inapplicable if selectVlanOption is set to 'create'.

VLAN ID should be specified in the format bridge_id:vlan_id, bridge_id is the Bridge Group ID and is always 1 for SBC Edge system. vlan_id is the VLAN ID configured.

vlan_idYesNostringnone6 - Max Length Specifies the VLAN ID to be created and configured as the new Default Untagged VLAN. This field is applicable only if selectVlanOption is set to 'create'.
vlan_descriptionYesNostringnone64 - Max Length Specifies a short description for the VLAN to be configured as the new Default Untagged VLAN. This field is applicable only if selectVlanOption is set to 'create'.
mstpInstanceYesNostringnone4 - Max Length Specifies the Multiple Spanning Tree Instance to be associated with the new Default Untagged VLAN. This field is applicable only if selectVlanOption is set to 'create'.

The MST Instance specified should be configured in the system, and should be specified in the format bridge_id:mst_id, bridge_id is the Bridge Group ID and is always set to 1 for SBC Edge system.