• Created by Unknown User (adrian_rosello), last modified on 04 Feb, 2014

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/ospf/ 
MethodGET 
ReturnOSPFServiceOSPFService 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.0.0.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.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/ospf/ 
MethodPOST 
Body ParameterOSPFServiceOSPFService 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.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/ospf/ 
MethodDELETE 
Return- 

ActivateOSPF

Enables OSPF service in the router.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/ospf/status/active 
MethodPUT 
Return- 

DeactivateOSPF

Disables the OSPF service in the router.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/ospf/status/inactive 
MethodPUT 
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.

 ValueDescription
URLhttp://hostname:8888/opennaas/router/{resourceName}/ospf/area 
MethodPOST 
Body ParameterOSPFAreaOSPF 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>
    <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>

 

 

  • No labels