Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

WADL

URL

http://hostname:8888/opennaas/router/{name}/l3vlan?_wadl

Description
Code Block
themeEclipse
languagehtml/xml
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://wadl.dev.java.net/2009/02" xmlns:prefix1="opennaas.api" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <grammars>
      <xs:schema xmlns="opennaas.api" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="opennaas.api">
         <xs:import namespace="" />
         <xs:element name="bridgeDomains" type="bridgeDomains" />
      </xs:schema>
      <xs:schema xmlns="opennaas.api" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="opennaas.api">
         <xs:complexType name="bridgeDomains">
            <xs:sequence>
               <xs:element maxOccurs="unbounded" minOccurs="0" name="domainName" type="xs:string" />
            </xs:sequence>
         </xs:complexType>
      </xs:schema>
   </grammars>
   <resources base="http://localhost:8888/opennaas/router/myre/l3vlan/">
      <resource path="/">
         <method name="GET">
            <response>
               <representation mediaType="application/xml" element="prefix1:bridgeDomains" />
            </response>
         </method>
         <resource path="{domainName}/ip">
            <param name="domainName" style="template" type="xs:string" />
            <method name="DELETE">
               <request>
                  <param name="ipAddress" style="query" type="xs:string" />
               </request>
               <response status="204" />
            </method>
            <method name="PUT">
               <request>
                  <param name="ipAddress" style="query" type="xs:string" />
               </request>
               <response status="204" />
            </method>
         </resource>
      </resource>
   </resources>
</application>

 

Methods

AddIpAddressToBridgedDomain

Adds an IP to a specific VlanBridge.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/l3vlan/{domainName}/ip?ipAddress={ipAddress} 
MethodPUT 
Path ParameterdomainNameId of the domain where we want to set the ip
Query ParameteripAddressIP address to set in the bridge domain.
Return--

RemoveIpAddressfromBridgedDomain

Removes the specified ip from the desired VlanBridge.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/l3vlan 
MethodDELETE 
Path ParameterdomainNameId of the domain where we want to unset the ip
Query ParameteripAddressIP address to unset from the bridge domain.
Return--

GetL3Vlans

Get the list of all VLAN Bridges containing an ip. In order to get the list of all VLAN Bridges, use the VLAN Bridge Capability.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/l3vlan 
MethodGET 
ReturnBridgeDomainsObject containing a list of Strings, representing the name of the vlanbridges with ip (l3vlan)
Response Example

Following response indicate two VLAN Bridges with IPs.

Code Block
themeEclipse
languagehtml/xml
<?xml version="1.0" encoding="UTF-8"?>
<ns2:bridgeDomains xmlns:ns2="opennaas.api">
   <domainName>vlan.2</domainName>
   <domainName>vlan.3</domainName>
</ns2:bridgeDomains>