http://hostname:8888/opennaas/router/{resourceName}/vlanbridge?_wadl
<?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="bridgeDomain" type="bridgeDomain" /> <xs:element name="bridgeDomains" type="bridgeDomains" /> <xs:element name="interfaceVLANOptions" type="interfaceVLANOptions" /> </xs:schema> <xs:schema xmlns="opennaas.api" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="opennaas.api"> <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: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: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" /> </method> <resource path="vlanoptions"> <method name="GET"> <request> <param name="iface" style="query" type="xs:string" /> </request> <response> <representation mediaType="application/xml" element="prefix1:interfaceVLANOptions" /> </response> </method> <method name="PUT"> <request> <param name="iface" style="query" type="xs:string" /> <representation mediaType="application/xml" element="prefix1:interfaceVLANOptions" /> </request> <response status="204" /> </method> </resource> <resource path="{id}"> <param name="id" style="template" type="xs:string" /> <method name="DELETE"> <request /> <response status="204" /> </method> <method name="GET"> <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" /> </method> </resource> </resource> </resources> </application> |
Returns the names of all existing Bridge Domains
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge/ | |
Method | GET | |
Return | BridgeDomains | List of Strings representing the name of all existing Bridge Domains in the router. |
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> |
Returns the information of anl existing Bridge Domain
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge/{domain-id} | |
Method | GET | |
Path Parameter | domain-id | Name of the bridge domain we want to retrieve information |
Return | BridgeDomain | Bridge domain information, consisting of its name, description, vlan and the list of interfaces composing the bridge domain. |
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> |
Creates a bridge domain in the router, containing the list of interfaces to add and the vlanId to use.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge | |
Method | POST | |
Body Parameter | BridgeDomain | Bridge domain information, consisting of its name, description, vlan and the list of interfaces composing the bridge domain. |
Return | - |
Following messag would create vlan.3 domain, using the vlanid "3", with two interfaces attached to it.
<?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> |
Updates an existing bridge domain. User must provide all the information the vlan bridge would contain, not only the new information.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge/{bridge-id} | |
Method | PUT | |
Path Parameter | {bridge-id} | Id of the vlan bridge to modify. |
Body Parameter | BridgeDomain | Bridge domain information, consisting of its name, description, vlan and the list of interfaces composing the bridge domain. |
Return | - |
This message would be valid to remove the interface fe-0/1/3.5 created in the "createBridgeDomain" illustration.
<?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> |
Removes an existing bridge domain from the router.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge/{bridge-id} | |
Method | DELETE | |
Path Parameter | {bridge-id} | Id of the vlan bridge to remove. |
Return | - |
Retrieves the vlan options from a specific interface.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge/vlanoptions?iface={ifaceName} | |
Method | GET | |
Query Parameter | iface | Name of the information which information we want to retrieve. |
Return | InterfaceVLANOptions | Object containing a Map with all vlan options of the interface |
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> |
Set the vlan options of a speciifc interface.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/vlanbridge/vlanoptions?iface={ifaceName} | |
Method | POST | |
Query Parameter | iface | Name of the information which information we want to set. |
Body Parameter | InterfaceVLANOptions | Object containing a Map with all vlan options of the interface |
Return | - |
Following message would put vlan options to a specific interface. The vlan options consists of the native-vlan-id (102) and the 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> |