Versions Compared

Key

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

...

Code Block
themeEclipse
languagehtml/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:bridgeDomain xmlns:ns2="opennaas.api">
  <domainName>vlan.2</domainName>
  <vlanid>2</vlanid>
  <interfacesNames>
    <interfaceName>fe-0/2/1.3</interfaceName>
    <interfaceName>fe-0/2/1.2</interfaceName>
  </interfacesNames>
  <description>Sample bridge domain</description>
</ns2:bridgeDomain>    

CreateBridgeDomain

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/vlanbridge 
MethodPOST 
Body ParameterBridgeDomainBridge domain information, consisting of its name, description, vlan and the list of interfaces composing the bridge domain.
Return- 
Body Example
Code Block
themeConfluence
languagehtml/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:bridgeDomain xmlns:ns2="opennaas.api">
  <domainName>vlan.3</domainName>
  <vlanid>3</vlanid>
  <interfacesNames>
    <interfaceName>fe-0/1/2.1</interfaceName>
    <interfaceName>fe-0/1/3.5</interfaceName>
  </interfacesNames>
  <description>Another sample bridge domain</description>
</ns2:bridgeDomain>

 

UpdateBridgeDomain

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/vlanbridge/{bridge-id} 
MethodPUT 
   
Path Parameter{bridge-id}Id of the vlan bridge to modify.
Body ParameterBridgeDomainBridge domain information, consisting of its name, description, vlan and the list of interfaces composing the bridge domain.
Return- 
Body Example
Code Block
themeConfluence
languagehtml/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:bridgeDomain xmlns:ns2="opennaas.api">
  <domainName>vlan.3</domainName>
  <vlanid>3</vlanid>
  <interfacesNames>
    <interfaceName>fe-0/1/2.1</interfaceName>
  </interfacesNames>
  <description>Another sample bridge domain</description>
</ns2:bridgeDomain>

DeleteBridgeDomain

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/vlanbridge/{bridge-id} 
MethodDELETE 
Path Parameter{bridge-id}Id of the vlan bridge to remove.
Return- 

GetInterfaceVLANOptions

Retrieves the vlan options from a specific interface.

...

Code Block
themeEclipse
languagehtml/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:interfaceVLANOptions xmlns:ns2="opennaas.api">
  <vlanOptions>
    <entry>
      <key>native-vlan-id</key>
      <value>102</value>
    </entry>
    <entry>
      <key>port-mode</key>
      <value>trunk</value>
    </entry>
  </vlanOptions>
</ns2:interfaceVLANOptions>

 

SetInterfaceVLANOptions

Response Example
 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/vlanbridge/vlanoptions?iface={ifaceName} 
MethodGET 
Query ParameterifaceName of the information which information we want to set.
Body ParameterInterfaceVLANOptionsObject containing a Map with all vlan options of the interface
Return- 
Body Example