router/ospf

Resource URIs

URI Description
<base_URI>/config/running/router/ospf Open Shortest Path First (OSPF).
GET URIs Description
<base_URI>/config/running/router/ospf Retrieves OSPF configuration details.
<base_URI>/config/running/router/ospf/{vrf-name} Retrieves OSPF configuration details for a particular VRF.
<base_URI>/config/running/router/ospf/{vrf-name}/database-overflow-interval Retrieves database overflow interval.
<base_URI>/config/running/router/ospf/{vrf-name}/default-information-originate Retrieves default route information
<base_URI>/config/running/router/ospf/{vrf-name}/default-passive-interface Marks all OSPF interfaces passive by default.
<base_URI>/config/running/router/ospf/{vrf-name}/default-metric Specifies the OSPF routing protocol metric value.
<base_URI>/config/running/router/ospf/{vrf-name}/external-lsdb-limit Retrieves External Link State Database limit.
<base_URI>/config/running/router/ospf/{vrf-name}/log Enables logging for OSPFv3 activities.
<base_URI>/config/running/router/ospf/{vrf-name}/metric-type Displays Metric type (Type 1 or Type 2).
<base_URI>/config/running/router/ospf/{vrf-name}/neighbor/{neighbor-addr} Displays non-broadcast neighbor IP Address in the format A.B.C.D.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute Enables route redistribution.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/connected Redistributes directly connected routes.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/connected/route-map Redistributes directly connected routes and specifies a route map to be consulted before a route is added to the routing table.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/static Redistributes static routes.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/static/route-map Redistributes static routes and specifies a route map to be consulted before a route is added to the routing table.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/bgp Redistributes BGP routes.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/bgp/route-map Redistributes BGP routes and specifies a route map to be consulted before a route is added to the routing table.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/ospf Redistributes OSPF routes.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/isis Redistributes IS-IS routes.
<base_URI>/config/running/router/ospf/{vrf-name}/redistribute/isis/route-map Redistribute IS-IS routes and specifies a route map to be consulted before a route is added to the routing table.
<base_URI>/config/running/router/ospf/{vrf-name}/area/{area-id} Displays the OSPF Router Area ID.
<base_URI>/config/running/router/ospf/{vrf-name}/auto-cost Calculates OSPF interface cost according to bandwidth.
<base_URI>/config/running/router/ospf/{vrf-name}/distance/{route-type} Configures an administrative distance value for OSPF routes.
<base_URI>/config/running/router/ospf/{vrf-name}/distribute-list Prevents routes from being learnt by OSPF.
<base_URI>/config/running/router/ospf/{vrf-name}/distribute-list/route-map Creates a route-map distribution list.
<base_URI>/config/running/router/ospf/{vrf-name}/distribute-list/route-map/in Creates a distribution list for an inbound route map.
<base_URI>/config/running/router/ospf/{vrf-name}/max-metric Retrieves Stub Router Advertisement.
<base_URI>/config/running/router/ospf/{vrf-name}/max-metric/router-lsa Retrieves the maximum metric advertisement in the Router.
<base_URI>/config/running/router/ospf/{vrf-name}/summary-address/{sum-address},{sum-address-mask} Retrieves IP address summaries information.
<base_URI>/config/running/router/ospf/{vrf-name}/timers Retrieves routing timers information.
<base_URI>/config/running/router/ospf/{vrf-name}/maximum-paths Changes the maximum number of OSPF shared paths.
<base_URI>/config/running/router/ospf/{vrf-name} /graceful-restart/ Retrieves graceful restart information.
<base_URI>/config/running/router/ospf/{vrf-name}/graceful-restart/helper-disable Disables graceful restart helper capability.
<base_URI>/config/running/router/ospf/{vrf-name}/nonstop-routing Enables nonstop-routing (NSR).
POST URIs Payload Description
<base_URI>/config/running/router/ospf/(vrf-name)/database-overflow-interval <database-overflow-interval>(unit32)</database-overflow-interval> Configures database overflow interval.
<base_URI>/config/running/router/ospf/(vrf-name)/default-passive-interface <default-passive-interface>(enumeration)</default-passive-interface> Configures default passive interface.
<base_URI>/config/running/router/ospf/(vrf-name)/default-metric <default-metric>(unit32)</default-metric> Configures default matric value.
<base_URI>/config/running/router/ospf/(vrf-name)/neighbor <neighbor><neighbor-addr>(ip-address)</neighbor-addr></neighbor> Configures neighbor.
PATCH URIs Payload Description
<base_URI>/config/running/router/ospf/(vrf-name)/default-information-originate <default-information-originate><metric>(unit32)</metric><metric-type>(string)</metric-type> <route-map>(string)</route-map></default-information- originate> Originates default-information.
<base_URI>/config/running/router/ospf/(vrf-name)/database-overflow-interval <database-overflow-interval>(unit32)</database-overflow-interval> Configures the time interval at which the device checks to see if the overflow condition has been eliminated.
<base_URI>/config/running/router/ospf/default- vrf/default-passive-interface <default-passive-interface>(enumeration)</default-passive-interface> Marks all OSPF interfaces passive by default.
<base_URI>/config/running/router/ospf/(vrf-name)/external-lsdb-limit <external-lsdb-limit>(unit32)</external-lsdb-limit> Configures the maximum size of the external LSDB.
<base_URI>/config/running/router/ospf/default- vrf/neighbor/ <neighbor><neighbor-addr>(ip-address)</neighbor-addr></neighbor> Configures the IPv4 address of the neighbor.
<base_URI>/config/running/router/ospf/default- vrf/redistribute <redistribute><connected></connected></redistribute> Redistributes directly connected routes.
<base_URI>/config/running/router/ospf/default- vrf/redistribute <redistribute><static></static></redistribute> Enables Static routes.
<base_URI>/config/running/router/ospf/(vrf-name)/redistribute <redistribute><bgp></bgp></redistribute> Enables BGP routes.
<base_URI>/config/running/router/ospf/(vrf-name)/redistribute <redistribute><isis><level-1></level-1></isis></redistribute> Enables ISIS routes
<base_URI>/config/running/router/ospf/(vrf-name)/area <area><area-id>(unit32)</area-id></area> Configures the area address.
<base_URI>/config/running/router/ospf/(vrf-name)/area <area><area-id>(unit32)</area-id><nssa><nssa-value>(unit32)</nssa-value></nssa></area> Configures an NSSA area.
<base_URI>/config/running/router/ospf/(vrf-name)/auto-cost <auto-cost ><reference-bandwidth><ref-bandwidth>(unit32)</ref-bandwidth></reference-bandwidth></auto-cost> Configures the reference bandwidth in Mbps.
<base_URI>/config/running/router/ospf/(vrf-name)/auto-cost <auto-cost ><reference-bandwidth><use-active-ports></use-active-ports></reference-bandwidth></auto-cost> When set, any dynamic change in bandwidth immediately affects the cost of OSPF routes. This parameter enables cost calculation for currently active ports only.
<base_URI>/config/running/router/ospf/(vrf-name)/distance <distance><route-type>(enumeration)</route-type><dist-value>(unit32)</dist-value></distance> Sets the route-type and distance value.
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart <graceful-restart><graceful-restart-enable>(enumeration)</graceful-restart-enable></graceful-restart> Enables the OSPF Graceful Restart (GR) capability.
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart <graceful-restart><helper-disable>(enumeration)</helper-disable></graceful-restart> Disables the GR helper capability.
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart <graceful-restart><restart-time>(unit32)</restart-time></graceful-restart> Specifies the maximum restart wait time, in seconds, advertised to neighbors.
<base_URI>/config/running/router/ospf/(vrf-name) <ospf><nonstop-routing>(enumeration)</nonstop-routing></ospf> Enables nonstop-routing (NSR).
PUT URIs Payload Description
<base_URI>/config/running/router/ospf/(vrf-name)/default-information-originate <default-information-originate><metric>(unit32)</metric><metric-type>(string)</metric-type> <route-map>(string)</route-map></default-information- originate> Originates default-information.
<base_URI>/config/running/router/ospf/default- vrf/database-overflow-interval <database-overflow-interval>(unit32)</database-overflow-interval> Configures the time interval at which the device checks to see if the overflow condition has been eliminated.
<base_URI>/config/running/router/ospf/default- vrf/default-passive-interface <default-passive-interface>(enumeration)</default-passive-interface> Marks all OSPF interfaces passive by default.
<base_URI>/config/running/router/ospf/(vrf-name)/default-metric <default-metric>(unit32)</default-metric> Configures default metric value.
<base_URI>/config/running/router/ospf/(vrf-name)/external- lsdb-limit <external-lsdb-limit>(unit32)</external-lsdb-limit> Configures the maximum size of the external LSDB.
<base_URI>/config/running/router/ospf/(vrf-name)/log <log><all>(enumeration)</all></log> Configures logging.
<base_URI>/config/running/router/ospf/(vrf-name)/log <log><database>(enumeration)</database></log> Configures database logging.
<base_URI>/config/running/router/ospf/(vrf-name)/log <log><retransmit>(enumeration)</retransmit></log> Configures retransmission logging.
<base_URI>/config/running/router/ospf/(vrf-name)/log <log><adjacency></adjacency></log> Configures adjacency logging.
<base_URI>/config/running/router/ospf/default- vrf/neighbor <neighbor><neighbor-addr>(ip-address)</neighbor-addr></neighbor> Configures the IPv4 address of the neighbor.
<base_URI>/config/running/router/ospf/default- vrf/redistribute <redistribute><connected></connected></redistribute> Redistributes directly connected routes.
<base_URI>/config/running/router/ospf/(vrf-name)/redistribute <redistribute><static></static></redistribute> Enables Static routes.
<base_URI>/config/running/router/ospf/(vrf-name)/redistribute <redistribute><bgp></bgp></redistribute> Enables BGP routes.
<base_URI>/config/running/router/ospf/default- vrf/redistribute <redistribute><isis><level-1></level-1></isis></redistribute> Enables ISIS routes
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart/graceful-restart-enable <graceful-restart-enable>(enumeration)</graceful-restart-enable> Enables the OSPF Graceful Restart (GR) capability.
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart/helper-disable <helper-disable>(enumeration)</helper-disable> Disables the GR helper capability.
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart/restart-time <restart-time>(unit32)</restart-time> Specifies the maximum restart wait time, in seconds, advertised to neighbors.
DELETE URIs
<base_URI>/config/running/router/ospf/(vrf-name)/default-information-originate
<base_URI>/config/running/router/ospf/(vrf-name)/database-overflow-interval
<base_URI>/config/running/router/ospf/(vrf-name)/default-passive-interface
<base_URI>/config/running/router/ospf/(vrf-name)/default-metric
<base_URI>/config/running/router/ospf/(vrf-name)/external-lsdb-limit
<base_URI>/config/running/router/ospf/(vrf-name)/log
<base_URI>/config/running/router/ospf/(vrf-name)/neighbor
<base_URI>/config/running/router/ospf/(vrf-name)/redistribute
<base_URI>/config/running/router/ospf/(vrf-name)/area/
<base_URI>/config/running/router/ospf/(vrf-name)/distance
<base_URI>/config/running/router/ospf/(vrf-name)/auto-cost
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart/graceful-restart-enable
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart/helper-disable
<base_URI>/config/running/router/ospf/(vrf-name)/graceful-restart/restart-time
<base_URI>/config/running/router/ospf/(vrf-name)/nonstop-routing

Parameters

vrf
Specifies the VRF name.
database-overflow-interval
Specifies the time interval at which the device checks to see if the overflow condition has been eliminated. The value can range from 0 through 86400 seconds. The default value is 0.
route-map
Specifies the name of a route map.
default-metric
Specifies the OSPF routing protocol metric value. The value can range from 1 through 65535.
external-lsdb-limit
Specifies the maximum size of the external LSDB. The maximum allowed value is 14913080.
neighbor-addr
Specifies the IPv4 address of the neighbor.
area-id
Specifies the area address in dotted decimal format (A.B.C.D) or in decimal format.
nssa
Specifies an NSSA area.
default-information-originate
Originates default-information.
ref-bandwidth
Specifies the reference bandwidth in Mbps. The value can range from 1 through 4294967.
use-active-ports
When set, any dynamic change in bandwidth immediately affects the cost of OSPF routes. This parameter enables cost calculation for currently active ports only.
route-type
Sets the route-type. Supported configurations are:
external-lsa-val
Specifies the metric value. The value can range from 1 through 16777214 (0x00001 -0x00FFFFFE). The default value is 16711680 (0x00FF0000).
summary-lsa-val
Specifies the summary metric value. The value can range from 1 through 16777214 (0x00001 - 0x00FFFFFE). The default value is 16711680 (0x00FF0000).
ptp
Advertises maximum metric in Router LSA for PTP links.
stub
Advertises maximum metric in Router LSA for stub links.
transit
Advertises maximum metric in Router LSA for transit links.
sum-address
Specifies the IP address for the summary route representing all the redistributed routes in dotted decimal format.
sum-address-mask
Specifies the IP mask for the summary route representing all the redistributed routes in dotted decimal format.
lsa-group-pacing
Specifies the interval at which OSPF LSAs are collected into a group and refreshed, check-summed, or aged out by the OSPF process. The values can range from 10 through 1800 seconds. The default value is 240 seconds.
init-delay
Specifies the initial SPF calculation delay. The values can range from 0 through 60000 milliseconds. The default value is 0 milliseconds.
hold-time
Specifies the minimum hold time between two consecutive SPF calculations. The values can range from 0 through 60000 milliseconds. The default value is 5000 milliseconds.
max-hold-time
Specifies the maximum wait time between two consecutive SPF calculations. The values can range from 0 through 60000 milliseconds. The default value is 10000 milliseconds.
graceful-restart-enable
Enables the OSPF Graceful Restart (GR) capability.
helper-disable
Disables the GR helper capability.
restart-time
Specifies the maximum restart wait time, in seconds, advertised to neighbors. The value can range from 10 through 1800 seconds. The default value is 120 seconds.
external-lsa-val-onstartup
Configures the external LSA value on startup.
summary-lsa-val-onstartup
Configures the summary LSA value on startup.
nonstop-routing
Enables nonstop-routing (NSR).

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/router/ospf/vrf/(vrf-name)

None

<ospf xmlns="urn:brocade.com:mgmt:brocade-ospf" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/ospf/default-vrf">
  <vrf>default-vrf</vrf>
  <database-overflow-interval>111</database-overflow-interval>
  <default-information-originate y:self="/rest/config/running/router/ospf/default-vrf/default-information-originate">
  </default-information-originate>
  <default-passive-interface>true</default-passive-interface>
  <default-metric>555</default-metric>
  <ldp-sync y:self="/rest/config/running/router/ospf/default-vrf/ldp-sync">
  </ldp-sync>
  <external-lsdb-limit>444</external-lsdb-limit>
  <log y:self="/rest/config/running/router/ospf/default-vrf/log">
    <all>true</all>
  </log>
  <neighbor y:self="/rest/config/running/router/ospf/default-vrf/neighbor/1.1.1.1">
    <neighbor-addr>1.1.1.1</neighbor-addr>
  </neighbor>
  <redistribute y:self="/rest/config/running/router/ospf/default-vrf/redistribute">
    <connected y:self="/rest/config/running/router/ospf/default-vrf/redistribute/connected">
    </connected>
    <static y:self="/rest/config/running/router/ospf/default-vrf/redistribute/static">
    </static>
    <bgp y:self="/rest/config/running/router/ospf/default-vrf/redistribute/bgp">
    </bgp>
    <ospf y:self="/rest/config/running/router/ospf/default-vrf/redistribute/ospf">
    </ospf>
    <isis y:self="/rest/config/running/router/ospf/default-vrf/redistribute/isis">
    </isis>
  </redistribute>
  <rfc1583-compatibility y:self="/rest/config/running/router/ospf/default-vrf/rfc1583-compatibility">
    <rfc1583-compatibility-flag>true</rfc1583-compatibility-flag>
  </rfc1583-compatibility>
  <area y:self="/rest/config/running/router/ospf/default-vrf/area/0">
    <area-id>0</area-id>
    <normal>true</normal>
    <nssa y:self="/rest/config/running/router/ospf/default-vrf/area/0/nssa">
    </nssa>
    <stub y:self="/rest/config/running/router/ospf/default-vrf/area/0/stub">
    </stub>
    <prefix-list y:self="/rest/config/running/router/ospf/default-vrf/area/0/prefix-list">
    </prefix-list>
  </area>
  <area y:self="/rest/config/running/router/ospf/default-vrf/area/1">
    <area-id>1</area-id>
    <normal>true</normal>
    <nssa y:self="/rest/config/running/router/ospf/default-vrf/area/1/nssa">
    </nssa>
    <stub y:self="/rest/config/running/router/ospf/default-vrf/area/1/stub">
    </stub>
    <prefix-list y:self="/rest/config/running/router/ospf/default-vrf/area/1/prefix-list">
      <prefix-list>abcd</prefix-list>
      <in>true</in>
      <prefix-list>abcd</prefix-list>
      <out>true</out>
    </prefix-list>
  </area>
  <area y:self="/rest/config/running/router/ospf/default-vrf/area/2">
    <area-id>2</area-id>
    <nssa y:self="/rest/config/running/router/ospf/default-vrf/area/2/nssa">
    </nssa>
    <stub y:self="/rest/config/running/router/ospf/default-vrf/area/2/stub">
      <stub-value>11</stub-value>
    </stub>
    <prefix-list y:self="/rest/config/running/router/ospf/default-vrf/area/2/prefix-list">
    </prefix-list>
  </area>
  <area y:self="/rest/config/running/router/ospf/default-vrf/area/3">
    <area-id>3</area-id>
    <nssa y:self="/rest/config/running/router/ospf/default-vrf/area/3/nssa">
      <nssa-value>22</nssa-value>
    </nssa>
    <stub y:self="/rest/config/running/router/ospf/default-vrf/area/3/stub">
    </stub>
    <prefix-list y:self="/rest/config/running/router/ospf/default-vrf/area/3/prefix-list">
    </prefix-list>
  </area>
  <auto-cost y:self="/rest/config/running/router/ospf/default-vrf/auto-cost">
    <reference-bandwidth y:self="/rest/config/running/router/ospf/default-vrf/auto-cost/reference-bandwidth">
      <ref-bandwidth>1000</ref-bandwidth>
      <use-active-ports>true</use-active-ports>
    </reference-bandwidth>
  </auto-cost>
  <distance y:self="/rest/config/running/router/ospf/default-vrf/distance/external">
    <route-type>external</route-type>
    <dist-value>50</dist-value>
  </distance>
  <distance y:self="/rest/config/running/router/ospf/default-vrf/distance/inter-area">
    <route-type>inter-area</route-type>
    <dist-value>61</dist-value>
  </distance>
  <distance y:self="/rest/config/running/router/ospf/default-vrf/distance/intra-area">
    <route-type>intra-area</route-type>
    <dist-value>72</dist-value>
  </distance>
  <distribute-list y:self="/rest/config/running/router/ospf/default-vrf/distribute-list">
    <route-map y:self="/rest/config/running/router/ospf/default-vrf/distribute-list/route-map">
      <route-map>afgh</route-map>
      <in>true</in>
    </route-map>
  </distribute-list>
  <max-metric y:self="/rest/config/running/router/ospf/default-vrf/max-metric">
    <router-lsa y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa">
      <external-lsa y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/external-lsa">
        <external-lsa-val>16777214</external-lsa-val>
      </external-lsa>
      <summary-lsa y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/summary-lsa">
      </summary-lsa>
      <link y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/link">
        <ptp>true</ptp>
        <stub>true</stub>
        <transit>true</transit>
      </link>
      <on-startup y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/on-startup">
        <time>400</time>
        <external-lsa y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/on-startup/external-lsa">
        </external-lsa>
        <summary-lsa y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/on-startup/summary-lsa">
        </summary-lsa>
        <link y:self="/rest/config/running/router/ospf/default-vrf/max-metric/router-lsa/on-startup/link">
          <transit>true</transit>
        </link>
      </on-startup>
    </router-lsa>
  </max-metric>
  <summary-address y:self="/rest/config/running/router/ospf/default-vrf/summary-address/12.0.0.0%2C255.0.0.0">
    <sum-address>12.0.0.0</sum-address>
    <sum-address-mask>255.0.0.0</sum-address-mask>
  </summary-address>
  <timers y:self="/rest/config/running/router/ospf/default-vrf/timers">
    <lsa-group-pacing>300</lsa-group-pacing>
    <throttle y:self="/rest/config/running/router/ospf/default-vrf/timers/throttle">
      <spf y:self="/rest/config/running/router/ospf/default-vrf/timers/throttle/spf">
        <init-delay>1000</init-delay>
        <hold-time>2000</hold-time>
        <max-hold-time>5000</max-hold-time>
      </spf>
    </throttle>
  </timers>
  <graceful-restart y:self="/rest/config/running/router/ospf/default-vrf/graceful-restart">
    <graceful-restart-enable>true</graceful-restart-enable>
  </graceful-restart>
  <maximum-paths>9</maximum-paths>
</ospf>

URI

The following is an example of the POST operation to add a prefix-list to router OSPF area configuration.

http://host:80/rest/config/running/router/ospf/(vrf-name)/area/1/prefix-list

<prefix-list>prefixlist1</prefix-list>

None

URI

The following is an example of the DELETE operation to remove the prefix-list configuration.

http://host:80/rest/config/running/router/ospf/(vrf-name)/area/1/prefix-list

None

None