Methods
Remember to execute the queue in order to apply this methods to the physical device.
GetAggregatedInterfaces
This method returns all the names of the aggregated interfaces present in the device.
| Value | Description | |
|---|---|---|
| URL | http://localhost:8888/opennaas/router/{resourceName}/linkaggregation/ | |
| Method | GET | |
| Return | Aggregated interfaces names list | All the aggregated interfaces names in a list |
Return body example
Following example shows aggregated interfaces names list returned with 3 elements.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:interfaces xmlns:ns2="opennaas.api"> <interface>ae0</interface> <interface>ae1</interface> <interface>ae2</interface> </ns2:interfaces>
GetAggregatedInterface
This method returns information of the given interface name.
| Value | Description | |
|---|---|---|
| URL | http://localhost:8888/opennaas/router/{resourceName}/linkaggregation/{interfaceName} | |
| Method | GET | |
| Return | AggregatedInterface | Aggregated Interface information for the given interface name: id, interfaces names list and aggregation options. |
Response body example
Following example shows aggregated interface information for the interface with name ae1.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:aggregatedInterface xmlns:ns2="opennaas.api">
<id>ae1</id>
<interfaces>
<interface>ge-0/0/0</interface>
<interface>ge-0/0/1</interface>
<interface>ge-0/0/2</interface>
</interfaces>
<aggregationOptions>
<entry>
<key>link-speed</key>
<value>1g</value>
</entry>
<entry>
<key>minimum-links</key>
<value>1</value>
</entry>
</aggregationOptions>
</ns2:aggregatedInterface>
CreateAggregatedInterface
This method creates a new aggregated interface.
| Value | Description | |
|---|---|---|
| URL | http://localhost:8888/opennaas/router/{resourceName}/linkaggregation | |
| Method | POST | |
| Body Parameter | AggregatedInterface | Aggregated Interface information for the new interface: id, interfaces names list and aggregation options. |
| Return | - |
Body Example
Following example would create an aggregated interface ae1, with 3 interfaces (ge-0/0/0, ge-0/0/1 and ge-0/0/2) and a few aggregation option (link-speed: 1g and minimum-links: 1).
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:aggregatedInterface xmlns:ns2="opennaas.api">
<id>ae1</id>
<interfaces>
<interface>ge-0/0/0</interface>
<interface>ge-0/0/1</interface>
<interface>ge-0/0/2</interface>
</interfaces>
<aggregationOptions>
<entry>
<key>link-speed</key>
<value>1g</value>
</entry>
<entry>
<key>minimum-links</key>
<value>1</value>
</entry>
</aggregationOptions>
</ns2:aggregatedInterface>
RemoveAggregatedInterface
This method removes an existing aggregated interface.
| Value | Description | |
|---|---|---|
| URL | http://localhost:8888/opennaas/router/{resourceName}/linkaggregation/{interfaceName} | |
| Method | DELETE | |
| Return | - |