Methods
ReadOSPFConfiguration
This method returns the existing OSPF 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}/ospf/ | |
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>
ConfigureOSPF
Configures OSPF in the router in the state provided by the user. Optionally the routerId can be specified.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/ospf/ | |
Method | POST | |
Body Parameter | OSPFService | OSPFService containing the desired initial state of the OSPF service and optionally the routerId. |
Return | - |
Body Example
Following examble would configure OSPF in an ENABLED state, with the routerId 193.1.190.141
<?xml version="1.0" encoding="UTF-8"?> <ospfService> <routerId>193.1.190.141</routerId> <enabledState>ENABLED</enabledState> </ospfService>
ClearOSPFConfiguration
Removes the whole OSPF configuration from the router.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/ospf/ | |
Method | DELETE | |
Return | - |
ActivateOSPF
Enables OSPF service in the router.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/ospf/status/active | |
Method | PUT | |
Return | - |
DeactivateOSPF
Disables the OSPF service in the router.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/ospf/status/inactive | |
Method | PUT | |
Return | - |
ConfigureOSPFArea
Adds an OSPF 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}/ospf/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 OSPF 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>
RemoveOSPFArea
Removes an existing OSPFArea from the router.
Value | Description | |
---|---|---|
URL | http://hostname:8888/opennaas/router/{resourceName}/ospf/area?areaId={areaId} | |
Method | POST | |
QueryParameter | areaId | Id of the area to be deleted. |
Return | - |