Methods
ReadOSPFv3Configuration
This method returns the existing OSPFv3 configuration in a router, in terms of different OSPFAreas and the set of interfaces in each of them.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/ | |
| Method | GET | |
| Return | OSPFService | OSPFService containing the existing OSPFAreas and the interfaces of each area. |
Response Example
Following example would illustrate a router with one OSPFArea and 4 enabled interfaces in it.
<?xml version="1.0" encoding="UTF-8"?>
<ospfService>
<routerId>193.1.190.141</routerId>
<enabledState>ENABLED</enabledState>
<ospfArea>
<areaId>0.0.0.0</areaId>
<ospfProtocolEndpoints>
<ospfProtocolEndpoint>
<name>ge-2/0/0.13</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.1</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.2</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.3</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
</ospfProtocolEndpoints>
</ospfArea>
</ospfService>
ConfigureOSPFv3
Configures OSPFv3 in the router. By default, OSPFv3 is created but it's in a disable state. It can be enabled with the enableOSPFv3 after you configure all the desired information. Optionally the routerId can be specified when calling this method.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/ | |
| Method | POST | |
| Body Parameter | OSPFService | OSPFService containing, optionally, the routerId. |
| Return | - |
Body Example
Following example would configure OSPFv3 with the routerId 10.10.10.10
<?xml version="1.0" encoding="UTF-8"?> <ospfService> <routerId>10.10.10.10</routerId> </ospfService>
ClearOSPFv3Configuration
Removes the whole OSPFv3 configuration from the router.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/ | |
| Method | DELETE | |
| Return | - |
ActivateOSPFv3
Enables OSPFv3 service in the router.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/status/active | |
| Method | PUT | |
| Return | - |
DeactivateOSPFv3
Disables the OSPF service in the router.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/status/inactive | |
| Method | PUT | |
| Return | - |
ConfigureOSPFv3Area
Adds an OSPFv3 area to the router. Optionally it can includes a list of interfaces to add to this area, with their enabled state.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/area | |
| Method | POST | |
| Body Parameter | OSPFArea | OSPF Area containing its id, type (optional) and optionally the list of interfaces to be added, with their enabled state. |
| Return | - |
Body Example
Following example would create an OSPFv3 area with id 0.0.0.0 and 4 interfaces in it, all of them enabled.
<?xml version="1.0" encoding="UTF-8"?>
<ospfArea>
<areaId>0.0.0.0</areaId>
<ospfProtocolEndpoints>
<ospfProtocolEndpoint>
<name>ge-2/0/0.13</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.1</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.2</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
<ospfProtocolEndpoint>
<name>gr-1/1/0.3</name>
<enabledState>ENABLED</enabledState>
</ospfProtocolEndpoint>
</ospfProtocolEndpoints>
</ospfArea>
RemoveOSPFv3Area
Removes an existing OSPFArea from the router.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/area?areaId={areaId} | |
| Method | DELETE | |
| QueryParameter | areaId | Id of the area to be deleted. |
| Return | - |
EnableOSPFv3Interfaces
Enables a list existing OSPFv3 interfaces which are in disable state. It's independent from the area they belong to.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/interfaces/enable | |
| Method | PUT | |
| Return | - |
Body Example
Following request would enable interfaces fe-0/3/3.1 and ge-0/1/1.3.
<?xml version="1.0" encoding="UTF-8"?> <interfaces> <interface>fe-0/3/3.1</interface> <interface>ge-0/1/1.3</interface> </interfaces>
DisableOSPv3FInterfaces
Disables a list existing OSPFv3 interfaces which are in enabled state. It's independent from the area they belong to.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ospfv3/interfaces/disable | |
| Method | PUT | |
| Return | - |
Body Example
Following request would disable interface fe-0/3/3.1
<?xml version="1.0" encoding="UTF-8"?> <interfaces> <interface>fe-0/3/3.1</interface> </interfaces>