Parameters
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| ethernetPort | Yes | No | int | Possible values:
| 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. | |
| selectVlanOption | Yes | No | Enum | modify | Possible values:
| 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. |
| defaultVlanId | Yes | No | string | none | 6 - 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 Portfolio system. vlan_id is the VLAN ID configured. |
| vlan_id | Yes | No | string | none | 6 - 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_description | Yes | No | string | none | 64 - 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'. |
| mstpInstance | Yes | No | string | none | 4 - 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 the SBC Edge Portfolio system. |
Helpful Tip
The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource
Overview
Content Tools