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" standalone="yes"?>
<ospfService>
  <routerId>193.1.190.141</routerId>
  <enabledState>ENABLED</enabledState>
  <ospfArea>
    <areaId>0</areaId>
    <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>
  </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>