Versions Compared

Old Version 11

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/tasks/modifydefaultvlan

Modifies the Default Untagged VLAN of a port on the SBC.

URL:

https://192.168.0.111/rest/tasks/modifydefaultvlan

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[modifydefaultvlan - REST API Methods|Resource - modifydefaultvlan]

Page Tree
root@parent

Parameters

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

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_idYesNostringnone6 - Max LengthSpecifies 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 LengthSpecifies 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 LengthSpecifies 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'.
Info

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.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource