• Created by Unknown User (adrian_rosello), last modified on 19 Mar, 2014

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

WADL

URL

http://hostname:8888/opennaas/router/{resourceName}/vlanbridge?_wadl

Description
      <application xmlns="http://wadl.dev.java.net/2009/02" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:prefix1="opennaas.api">
  <grammars>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="opennaas.api" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="opennaas.api">
<xs:import namespace=""/>
<xs:element name="bridgeDomain" type="bridgeDomain"/>
<xs:element name="bridgeDomains" type="bridgeDomains"/>
<xs:element name="interfaceVLANOptions" type="interfaceVLANOptions"/>
</xs:schema>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="opennaas.api" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="opennaas.api">
<xs:complexType name="bridgeDomain">
<xs:sequence>
<xs:element minOccurs="0" name="domainName" type="xs:string"/>
<xs:element name="vlanid" type="xs:int"/>
<xs:element minOccurs="0" name="interfacesNames">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="interfaceName" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" name="description" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="interfaceVLANOptions">
<xs:sequence>
<xs:element name="vlanOptions">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="entry">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="key" type="xs:string"/>
<xs:element minOccurs="0" name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<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/vlanbridge/">
      <resource path="/">
        <method name="GET">
          <response>
            <representation mediaType="application/xml" element="prefix1:bridgeDomains"/>
          </response>
        </method>
        <method name="POST">
          <request>
            <representation mediaType="application/xml" element="prefix1:bridgeDomain"/>
          </request>
          <response status="204">
          </response>
        </method>
        <resource path="vlanoptions/{iface}">
          <param name="iface" style="template" type="xs:string"/>
          <method name="GET">
            <request>
            </request>
            <response>
              <representation mediaType="application/xml" element="prefix1:interfaceVLANOptions"/>
            </response>
          </method>
          <method name="PUT">
            <request>
              <representation mediaType="application/xml" element="prefix1:interfaceVLANOptions"/>
            </request>
            <response status="204">
            </response>
          </method>
        </resource>
        <resource path="{id}">
          <param name="id" style="template" type="xs:string"/>
          <method name="DELETE">
            <request>
            </request>
            <response status="204">
            </response>
          </method>
          <method name="GET">
            <request>
            </request>
            <response>
              <representation mediaType="application/xml" element="prefix1:bridgeDomain"/>
            </response>
          </method>
          <method name="PUT">
            <request>
              <representation mediaType="application/xml" element="prefix1:bridgeDomain"/>
            </request>
            <response status="204">
            </response>
          </method>
        </resource>
      </resource>
    </resources>
  </application>

Methods

GetBridgeDomains

Returns the names of all existing Bridge Domains

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/vlanbridge/ 
MethodGET 
ReturnBridgeDomainsList of Strings representing the name of all existing Bridge Domains in the router.
Response Example

In following example the router contains two domains: vlan.2 and vlan.3

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

 

GetBridgeDomain

Returns the information of anl existing Bridge Domain

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/vlanbridge/{domain-id} 
MethodGET 
Path Parameterdomain-idName of the bridge domain we want to retrieve information
ReturnBridgeDomainBridge domain information, consisting of its name, description, vlan and the list of interfaces composing the bridge domain.
Response Example

Following response would represent the information bridge domain "vlan.2"

<?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

UpdateBridgeDomain

DeleteBridgeDomain

GetInterfaceVLANOptions

Retrieves the vlan options from a specific interface.

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

Following message contains the information from a custom interface. It has two configured options: native-vlan-id (102) and port-mode(trunk)

<?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
  • No labels