Configures, retrieves, and modifies Open Shortest Path First (OSPF) version 3.
| URI | Description |
|---|---|
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | Configures Open Shortest Path First (OSPF) version 3. |
| GET URIs | Description |
|---|---|
| <base_URI>/config/running/ipv6/router/ospf | Retrieves Open Shortest Path First (OSPF) version 3 details. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | Displays the name of the VRF. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id} | Displays OSPF router area address |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/normal | Displays the normal area for an area ID. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | Displays an NSSA area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/nssa-area-metric | Displays NSSAs advertised stub route metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate | Controls distribution of default information. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate/metric | Displays the OSPF metric . |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate/metric-type | Displays the OSPF metric type. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/no-redistribution | Do not send redistributed LSA into nssa area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/no-summary | Do not send summary LSA into nssa area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/translator-always | Sets NSSA translator role. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/translator-interval | NSSA translator stability interval (sec). Decimal value, range 10-60 seconds. Default is 40s. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub | Displays a stub area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub/no-summary | Do not send summary LSA into stub area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub/stub-area-metric | Display Stub area's advertised route metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication | Authentication of OSPF messages. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor} | Define a virtual link and its parameters. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/hello-interval | Displays the time between hello packets that the router sends on an interface. Decimal value, range 1-65535 seconds. Default is 10 seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/dead-interval | Decimal value, range 3-65535 seconds. Default is 40 seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/hello-jitter | Diaplsys the allowed jitter between hello packets. Decimal value, range 1%-50%. Default is 10%. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/retransmit-interval | Displays time between Link State Advertisement(LSA) retransmissions for adjacencies belonging to the interface. Decimal value, range 1-3600 seconds. Default is 5 seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/transmit-delay | Displays the estimated time required to send an LSA on the interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication | Displays the authentication details. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address} | Defines or undefines a type-3 address range (ABR only). |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address}/range-effect | Advertise this type-3 summarization |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address}/cost | Displays area range cost. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/auto-cost | Calculate OSPFv3 interface cost according to bandwidth. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/auto-cost/reference-bandwidth | Displays Reference-bandwidth in Mbits per second. Range 1 - 4294967. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/database-overflow-interval | Displays Poll Interval in Seconds. Range 0 - 86400 seconds. Default is 10. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate | Controls distribution of default information. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate/always | Always advertise default route. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate/metric | Displays OSPF metric. Range 0-65535. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate/metric-type | OSPF metric type for default route. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-metric | Displays Default metric. Range 0-65535. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-passive-interface | Set OSPF interface passive. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distance/{route-type} | Defines an administrative distance. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list | Prevent routes from being learnt by OSPFv3. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/route-map | Use route-map to control routes learned by OSPFv3. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/route-map/in | Inbound Filtering. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/prefix-list | Use prefix list to control routes learned by OSPFv3 |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/prefix-list/in | Inbound Filtering. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/external-lsdb-limit | External Link State Database Limit. Range 1-250000. Default is 250000. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart | Displays graceful restart status. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper | Displays the OSPFv3 graceful restart (GR) helper capability status. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper/disable | Disables the OSPFv3 GR helper capability. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper/strict-lsa-checking | Enables the OSPFv3 GR helper mode with strict link-state advertisement (LSA) checking. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/key-add-remove-interval | Display add/remove interval in seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/key-rollover-interval | Display new key rollover interval in seconds. Range 0-14400. Default is 300. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log | Enables logging OSPF activities. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/adjacency | Enables logging adjacency changes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/adjacency/dr-only | Enables logging adjacency changes for Designated Router interfaces only. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/all | Enables logging everything. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/bad-packet | Enables logging Bad packets. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/bad-packet/checksum | Enables logging bad checksum packets. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/database | Enables logging LSA activity. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/retransmit | Enables logging retransmit activity. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/metric-type | OSPF metric type for redistributed routes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute | Enables logging route redistribution. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected | Displays Connected routes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected/route-map | Displays Route map reference. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected/metric | Displays OSPF metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected/metric-type | Displays OSPF Metric type. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static | Displays Static routes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static/route-map | Displays Route map reference. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static/metric | Displays OSPF metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static/metric-type | Displays OSPF Metric type. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis | Displays ISIS routes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/route-map | Displays Route map reference. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/metric | Displays ISIS metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/metric-type | Displays ISIS Metric type. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp | Displays BGP Routes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp/route-map | Displays Route map reference. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp/metric | Displays OSPF metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp/metric-type | Displays OSPF Metric type. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf | Displays OSPF routes. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf/route-map | Displays Route map reference. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf/metric | Displays OSPF metric. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf/metric-type | Displays OSPF Metric type. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/summary-address/{summary-address-value} | Displays IP address summaries. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers | Adjusts routing timers. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers/lsa-group-pacing | Interval between group of LSA being refreshed or maxaged. Range 10-1800. Default is 240. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers/spf | Displays OSPF SPF timers. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers/spf/spf-hold-time | Displays hold time (0-65535 sec) between consecutive SPF calculations. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/nonstop-routing | Returns true if nonstop-routing capability is enabled. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/maximum-paths | Displays maximum paths. Range 1-64. Default is 8. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric | Stub Router Advertisement |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa | The maximum metric advertisement in Router LSAs. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/all-lsas | Replaces Metric in all External and Summary LSAs with default max metric value. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/external-lsa | Replaces Metric in External LSA with max metric value. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/external-lsa/external-lsa-value | Indicates the metric of all external type 5 and type 7 LSA's |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/summary-lsa | Replaces Metric in Summary LSA with max metric value. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/summary-lsa/summary-lsa-value | Displays the metric of all summary type 3 and type 4 LSAs. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/include-stub | Configure include-stub for max-metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup | Apply this on OSPF startup. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup/on-startup-time | Displays the time to advertise maximum metric. Range 5 - 86400 seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup/wait-for-bgp | Advertise maximum metric until BGP has converged (or 600 seconds) |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf | Open Shortest Path First (OSPF). Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/area | Displays OSPF areas. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/active | Displays Active information. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/passive | Displays Passive information. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/cost | Displays cost. Range 1-65535. Default is 1. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/instance | Displays Instance ID. Range 0-255. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/mtu-ignore | Disables OSPF MTU mismatch detection. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/network | Broadcast interface mode. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/priority | Displays Interface priority. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/suppress-linklsa | Suppress link LSA advertisements. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication | Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication/ipsec | Displays ipsec authentication for the interface. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication/ipsec/key-add-remove-interval | Displays Key add/remove interval in seconds. Range 0-14400. Default is 300. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/hello-interval | Displays hello interval. Range 1-65535 seconds. Default is 10 seconds. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/dead-interval | Displays Dead interval. Range 3-65535 seconds. Default is 40 seconds. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface{interface-type}/{interface-name}/ipv6/ospf/hello-jitter | Displays Hello Jitter. Range 1%-50%. Default is 10%. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/retransmit-interval | Displays Retransmit interval. Range 1-3600 seconds. Default is 5 seconds. Interface types are Ethernet, Ve, and Loopback. |
| <base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/transmit-delay | Displays Transmit Delay. Range 0-3600 seconds. Default is 1 second. Interface types are Ethernet, Ve, and Loopback. |
| POST URIs | Payload | Description |
|---|---|---|
| <base_URI>/config/running/ipv6/router | <ospf><vrf>{common-def:vrf-name}</vrf></ospf> | Configures OSPF instance for the VRF. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <area><area-id>{ospf:ospf-area-id}</area-id></area> | Sets the OSPF router area id |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id} | <nssa /> | Specifies an nssa area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | <default-information-originate /> | Controls distribution of default information |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id} | <virtual-link><virtual-link-neighbor>{inet:ipv4-address}</virtual-link-neighbor></virtual-link> | Define a virtual link and its parameters. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id} | <range><range-address>{common-def:ipv6-address-prefix}</range-address></range> | Defines or undefines a type-3 address range (ABR only). |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <default-information-originate /> | Controls distribution of default information. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <distance><route-type>{ospf:route-type-enum}</route-type><distance-value>{uint32}</distance-value></distance> | Defines an administrative distance |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log | <adjacency /> | Logging adjacency changes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log | <bad-packet /> | Logging Bad packets |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute | <connected /> | Connected routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute | <static /> | Static routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute | <isis /> | ISIS routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute | <bgp /> | BGP routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute | <ospf /> | OSPF routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <summary-address><summary-address-value>{common-def:ipv6-address-prefix}</summary-address-value></summary-address> | Configure IP address summaries |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric | <router-lsa /> | The maximum metric advertisement in Router LSAs |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa | <external-lsa /> | Replace Metric in External LSA with max metric value |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa | <summary-lsa /> | Replace Metric in Summary LSA with max metric value |
| <base_URI>/config/running | <spi><ah>{algorithm-type-ah}</ah><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running | <spi><no-encrypt>{enumeration}</no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key and configure ipsec authentication for the interface. |
| <base_URI>/config/running | <spi><key>{ipsec-authentication-hexkey-string}</key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running | <spi><esp>{algorithm-type-esp}</esp><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running | <spi><esp-no-encrypt>{enumeration}</esp-no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running | <spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running | <spi><esp-auth>{algorithm-type-ah}</esp-auth><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running | <spi><no-encrypt>{enumeration}</no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running | <spi><key>{ipsec-authentication-hexkey-string}</key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| <base_URI>/config/running | <spi><ah>{algorithm-type-ah}</ah><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running | <spi><no-encrypt>{enumeration}</no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running | <spi><key>{ipsec-authentication-hexkey-string}</key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running | <spi><esp>{algorithm-type-esp}</esp><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running | <spi><esp-no-encrypt>{enumeration}</esp-no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key. |
| <base_URI>/config/running | <spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running | <spi><esp-auth>{algorithm-type-ah}</esp-auth><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running | <spi><no-encrypt>{enumeration}</no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running | <spi><key>{ipsec-authentication-hexkey-string}</key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| <base_URI>/config/running | <spi><ah>{algorithm-type-ah}</ah><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running | <spi><no-encrypt>{enumeration}</no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running | <spi><key>{ipsec-authentication-hexkey-string}</key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running | <spi><esp>{algorithm-type-esp}</esp><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running | <spi><esp-no-encrypt>{enumeration}</esp-no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key. |
| <base_URI>/config/running | <spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running | <spi><esp-auth>{algorithm-type-ah}</esp-auth><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running | <spi><no-encrypt>{enumeration}</no-encrypt><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running | <spi><key>{ipsec-authentication-hexkey-string}</key><ipsec><disable>{enumeration}</disable></ipsec></spi> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| PUT URIs | Payload | Description |
|---|---|---|
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/normal | <normal>{enumeration}</normal> | Sets the OSPF router area id |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/nssa-area-metric | <nssa-area-metric>{uint32}</nssa-area-metric> | Specifies an nssa area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate/metric | <metric>{uint32}</metric> | Controls distribution of default information |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate/metric-type | <metric-type>{ospf:metric-type}</metric-type> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/no-redistribution | <no-redistribution>{enumeration}</no-redistribution> | Do not send redistributed LSA into nssa area |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/no-summary | <no-summary>{enumeration}</no-summary> | Do not send summary LSA into nssa area |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/translator-always | <translator-always>{enumeration}</translator-always> | Set nssa translator role |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/translator-interval | <translator-interval>{common-def:time-interval-sec}</translator-interval> | Nssa translator stability interval |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub/no-summary | <no-summary>{enumeration}</no-summary> | Do not send summary LSA into stub area |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub/stub-area-metric | <stub-area-metric>{uint32}</stub-area-metric> | Stub area's advertised route metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><ah>{algorithm-type-ah}</ah></spi> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><no-encrypt>{enumeration}</no-encrypt></spi> | Security Parameter Index without encrypting the key. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><key>{ipsec-authentication-hexkey-string}</key></spi> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><esp>{algorithm-type-esp}</esp></spi> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><esp-no-encrypt>{enumeration}</esp-no-encrypt></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key></spi> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><esp-auth>{algorithm-type-ah}</esp-auth></spi> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><no-encrypt>{enumeration}</no-encrypt></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <spi><key>{ipsec-authentication-hexkey-string}</key></spi> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/hello-interval | <hello-interval>{common-def:time-interval-sec}</hello-interval> | Configures the time between hello packets that the router sends on an interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/dead-interval | <dead-interval>{common-def:time-interval-sec}</dead-interval> | Configures the time a neighbor router waits for a hello packet from the current router before declaring the router down. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/hello-jitter | <hello-jitter>{uint32}</hello-jitter> | Sets the allowed jitter between hello packets. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/retransmit-interval | <retransmit-interval>{common-def:time-interval-sec}</retransmit-interval> | Time between Link State Advertisement (LSA) retransmissions for adjacencies belonging to the interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/transmit-delay | <transmit-delay>{common-def:time-interval-sec}</transmit-delay> | Estimated time required to send an LSA on the interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><ah>{algorithm-type-ah}</ah></spi> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><no-encrypt>{enumeration}</no-encrypt></spi> | Security Parameter Index without encrypting the key. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><key>{ipsec-authentication-hexkey-string}</key></spi> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><esp>{algorithm-type-esp}</esp></spi> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><esp-no-encrypt>{enumeration}</esp-no-encrypt></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key></spi> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><esp-auth>{algorithm-type-ah}</esp-auth></spi> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><no-encrypt>{enumeration}</no-encrypt></spi> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <spi><key>{ipsec-authentication-hexkey-string}</key></spi> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address}/range-effect | <range-effect>{enumeration}</range-effect> | Advertise this type-3 summarization |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address}/cost | <cost>{ospf:range-metric}</cost> | Configure area range cost |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/auto-cost/reference-bandwidth | <reference-bandwidth>{ospf:band-width}</reference-bandwidth> | Reference-bandwidth in Mbits per second |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/database-overflow-interval | <database-overflow-interval>{common-def:time-interval-sec}</database-overflow-interval> | Poll Interval in Seconds |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate/always | <always>{enumeration}</always> | Always advertise default route |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate/metric | <metric>{uint32}</metric> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate/metric-type | <metric-type>{ospf:metric-type}</metric-type> | OSPF metric type for default route |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-metric | <default-metric>{uint32}</default-metric> | Default metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-passive-interface | <default-passive-interface>{enumeration}</default-passive-interface> | Set OSPF interface passive |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/route-map | <route-map><distribute-list-route-map-name>{common-def:name-string63}</distribute-list-route-map-name><in>{enumeration}</in></route-map> | Use route-map to control routes learned by OSPFv3 |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/prefix-list | <prefix-list><distribute-list-prefix-list-name>{common-def:name-string63}</distribute-list-prefix-list-name><in>{enumeration}</in></prefix-list> | Use prefix list to control routes learned by OSPFv3 |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/external-lsdb-limit | <external-lsdb-limit>{uint32}</external-lsdb-limit> | External Link State Database Limit |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper/disable | <disable>{enumeration}</disable> | Disable graceful restart helper capability |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper/strict-lsa-checking | <strict-lsa-checking>{enumeration}</strict-lsa-checking> | Set strict LSA checking |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/key-add-remove-interval | <key-add-remove-interval>{common-def:time-interval-sec}</key-add-remove-interval> | Key add or remove interval in seconds |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/key-rollover-interval | <key-rollover-interval>{common-def:time-interval-sec}</key-rollover-interval> | New key rollover interval in seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/adjacency/dr-only | <dr-only>{enumeration}</dr-only> | Logging only Designated Router interfaces' adjacency changes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/all | <all>{enumeration}</all> | Logging everything |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/bad-packet/checksum | <checksum>{enumeration}</checksum> | Logging bad checksum packets |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/database | <database>{enumeration}</database> | Logging LSA activity |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/retransmit | <retransmit>{enumeration}</retransmit> | Logging retransmit activity |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/metric-type | <metric-type>{ospf:metric-type}</metric-type> | OSPFv3 metric type for redistributed routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected/route-map | <route-map>{common-def:name-string63}</route-map> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected/metric | <metric>{uint32}</metric> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected/metric-type | <metric-type>{ospf:metric-type}</metric-type> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static/route-map | <route-map>{common-def:name-string63}</route-map> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static/metric | <metric>{uint32}</metric> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static/metric-type | <metric-type>{ospf:metric-type}</metric-type> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/route-map | <route-map>{common-def:name-string63}</route-map> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/level-1 | <level-1>{enumeration}</level-1> | Redistribution of IS-IS Level-1 routes only |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/level-2 | <level-2>{enumeration}</level-2> | Redistribution of IS-IS Level-2 routes only |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/level-1-2 | <level-1-2>{enumeration}</level-1-2> | Redistribution of IS-IS Level-1 and Level-2 routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/metric | <metric>{uint32}</metric> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/metric-type | <metric-type>{ospf:metric-type}</metric-type> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp/route-map | <route-map>{common-def:name-string63}</route-map> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp/metric | <metric>{uint32}</metric> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp/metric-type | <metric-type>{ospf:metric-type}</metric-type> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf/route-map | <route-map>{common-def:name-string63}</route-map> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf/metric | <metric>{uint32}</metric> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf/metric-type | <metric-type>{ospf:metric-type}</metric-type> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers/lsa-group-pacing | <lsa-group-pacing>{common-def:time-interval-sec}</lsa-group-pacing> | Interval between group of LSA being refreshed or maxaged |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers/spf | <spf><spf-delay>{common-def:time-interval-sec}</spf-delay><spf-hold-time>{common-def:time-interval-sec}</spf-hold-time></spf> | OSPFv3 SPF timers |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/nonstop-routing | <nonstop-routing>{enumeration}</nonstop-routing> | Enable nonstop-routing capability |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/maximum-paths | <maximum-paths>{uint32}</maximum-paths> | Maximum path. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/all-lsas | <all-lsas>{enumeration}</all-lsas> | Replace Metric in all External and Summary LSAs with default max metric value |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/external-lsa/external-lsa-value | <external-lsa-value>{uint32}</external-lsa-value> | Indicates the metric of all external type 5 and type 7 LSA's |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/summary-lsa/summary-lsa-value | <summary-lsa-value>{uint32}</summary-lsa-value> | Metric of all summary type 3 and type 4 LSAs |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/include-stub | <include-stub>{enumeration}</include-stub> | Configure include-stub for max-metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup/on-startup-time | <on-startup-time>{uint32}</on-startup-time> | Amount of time to advertise maximum metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup/wait-for-bgp | <wait-for-bgp>{enumeration}</wait-for-bgp> | Advertise maximum metric until BGP has converged or 600 seconds |
| PATCH URIs | Payload | Description |
|---|---|---|
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id} | <area><normal>{enumeration}</normal></area> | Sets the OSPF router area id |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | <nssa><nssa-area-metric>{uint32}</nssa-area-metric></nssa> | Specifies an nssa area. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate | <default-information-originate><metric>{uint32}</metric></default-information-originate> | Controls distribution of default information |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa/default-information-originate | <default-information-originate><metric-type>{ospf:metric-type}</metric-type></default-information-originate> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | <nssa><no-redistribution>{enumeration}</no-redistribution></nssa> | Do not send redistributed LSA into nssa area |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | <nssa><no-summary>{enumeration}</no-summary></nssa> | Do not send summary LSA into nssa area |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | <nssa><translator-always>{enumeration}</translator-always></nssa> | Set nssa translator role |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/nssa | <nssa><translator-interval>{common-def:time-interval-sec}</translator-interval></nssa> | Nssa translator stability interval |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub | <stub><no-summary>{enumeration}</no-summary></stub> | Do not send summary LSA into stub area |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/stub | <stub><stub-area-metric>{uint32}</stub-area-metric></stub> | Stub area's advertised route metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><ah>{algorithm-type-ah}</ah></authentication> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><no-encrypt>{enumeration}</no-encrypt></authentication> | Security Parameter Index without encrypting the key. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><key>{ipsec-authentication-hexkey-string}</key></authentication> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><esp>{algorithm-type-esp}</esp></authentication> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><esp-no-encrypt>{enumeration}</esp-no-encrypt></authentication> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key></authentication> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><esp-auth>{algorithm-type-ah}</esp-auth></authentication> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><no-encrypt>{enumeration}</no-encrypt></authentication> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/authentication/virtual-link | <authentication><spi>{spi-value-type}</spi><key>{ipsec-authentication-hexkey-string}</key></authentication> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor} | <virtual-link><hello-interval>{common-def:time-interval-sec}</hello-interval></virtual-link> | Configures the time between hello packets that the router sends on an interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor} | <virtual-link><dead-interval>{common-def:time-interval-sec}</dead-interval></virtual-link> | Configures the time a neighbor router waits for a hello packet from the current router before declaring the router down. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor} | <virtual-link><hello-jitter>{uint32}</hello-jitter></virtual-link> | Sets the allowed jitter between hello packets. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor} | <virtual-link><retransmit-interval>{common-def:time-interval-sec}</retransmit-interval></virtual-link> | Time between Link State Advertisement (LSA) retransmissions for adjacencies belonging to the interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor} | <virtual-link><transmit-delay>{common-def:time-interval-sec}</transmit-delay></virtual-link> | Estimated time required to send an LSA on the interface. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><ah>{algorithm-type-ah}</ah></authentication> | Security Parameter Index specifying the authentication algorithm to use. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><no-encrypt>{enumeration}</no-encrypt></authentication> | Security Parameter Index without encrypting the key. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><key>{ipsec-authentication-hexkey-string}</key></authentication> | Security Parameter Index with Key used for ah. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><esp>{algorithm-type-esp}</esp></authentication> | Security Parameter Index specifying Encapsulating Security Payload (ESP) |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><esp-no-encrypt>{enumeration}</esp-no-encrypt></authentication> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key></authentication> | Security Parameter Index with Hexadecimal key string for ESP |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><esp-auth>{algorithm-type-ah}</esp-auth></authentication> | Security Parameter Index using Authentication Algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><no-encrypt>{enumeration}</no-encrypt></authentication> | Security Parameter Index without encrypting the key |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/virtual-link/{virtual-link-neighbor}/authentication/range | <authentication><spi>{spi-value-type}</spi><key>{ipsec-authentication-hexkey-string}</key></authentication> | Security Parameter Index with Hexadecimal key string for authentication algorithm |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address} | <range><range-effect>{enumeration}</range-effect></range> | Advertise this type-3 summarization |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/area/{area-id}/range/{range-address} | <range><cost>{ospf:range-metric}</cost></range> | Configure area range cost |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/auto-cost | <auto-cost><reference-bandwidth>{ospf:band-width}</reference-bandwidth></auto-cost> | Reference-bandwidth in Mbits per second |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><database-overflow-interval>{common-def:time-interval-sec}</database-overflow-interval></ospf> | Poll Interval in Seconds |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate | <default-information-originate><always>{enumeration}</always></default-information-originate> | Always advertise default route |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate | <default-information-originate><metric>{uint32}</metric></default-information-originate> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/default-information-originate | <default-information-originate><metric-type>{ospf:metric-type}</metric-type></default-information-originate> | OSPF metric type for default route |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><default-metric>{uint32}</default-metric></ospf> | Default metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><default-passive-interface>{enumeration}</default-passive-interface></ospf> | Set OSPF interface passive |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distance/{route-type} | <distance><distance-value>{uint32}</distance-value></distance> | Distance for the given type of routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/route-map | <route-map><distribute-list-route-map-name>{common-def:name-string63}</distribute-list-route-map-name><in>{enumeration}</in></route-map> | Use route-map to control routes learned by OSPFv3 |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/distribute-list/prefix-list | <prefix-list><distribute-list-prefix-list-name>{common-def:name-string63}</distribute-list-prefix-list-name><in>{enumeration}</in></prefix-list> | Use prefix list to control routes learned by OSPFv3 |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><external-lsdb-limit>{uint32}</external-lsdb-limit></ospf> | External Link State Database Limit |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper | <helper><disable>{enumeration}</disable></helper> | Disable graceful restart helper capability |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/graceful-restart/helper | <helper><strict-lsa-checking>{enumeration}</strict-lsa-checking></helper> | Set strict LSA checking |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><key-add-remove-interval>{common-def:time-interval-sec}</key-add-remove-interval></ospf> | Key add or remove interval in seconds |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><key-rollover-interval>{common-def:time-interval-sec}</key-rollover-interval></ospf> | New key rollover interval in seconds. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/adjacency | <adjacency><dr-only>{enumeration}</dr-only></adjacency> | Logging only Designated Router interfaces' adjacency changes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log | <log><all>{enumeration}</all></log> | Logging everything |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log/bad-packet | <bad-packet><checksum>{enumeration}</checksum></bad-packet> | Logging bad checksum packets |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log | <log><database>{enumeration}</database></log> | Logging LSA activity |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/log | <log><retransmit>{enumeration}</retransmit></log> | Logging retransmit activity |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><metric-type>{ospf:metric-type}</metric-type></ospf> | OSPFv3 metric type for redistributed routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected | <connected><route-map>{common-def:name-string63}</route-map></connected> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected | <connected><metric>{uint32}</metric></connected> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/connected | <connected><metric-type>{ospf:metric-type}</metric-type></connected> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static | <static><route-map>{common-def:name-string63}</route-map></static> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static | <static><metric>{uint32}</metric></static> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/static | <static><metric-type>{ospf:metric-type}</metric-type></static> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis | <isis><route-map>{common-def:name-string63}</route-map></isis> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/level-1 | <level-1>{enumeration}</level-1> | Redistribution of IS-IS Level-1 routes only |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/level-2 | <level-2>{enumeration}</level-2> | Redistribution of IS-IS Level-2 routes only |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis/level-1-2 | <level-1-2>{enumeration}</level-1-2> | Redistribution of IS-IS Level-1 and Level-2 routes |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis | <isis><metric>{uint32}</metric></isis> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/isis | <isis><metric-type>{ospf:metric-type}</metric-type></isis> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp | <bgp><route-map>{common-def:name-string63}</route-map></bgp> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp | <bgp><metric>{uint32}</metric></bgp> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/bgp | <bgp><metric-type>{ospf:metric-type}</metric-type></bgp> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf | <ospf><route-map>{common-def:name-string63}</route-map></ospf> | Route map reference |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf | <ospf><metric>{uint32}</metric></ospf> | OSPF metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/redistribute/ospf | <ospf><metric-type>{ospf:metric-type}</metric-type></ospf> | Type of the metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers | <timers><lsa-group-pacing>{common-def:time-interval-sec}</lsa-group-pacing></timers> | Interval between group of LSA being refreshed or maxaged |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/timers/spf | <spf><spf-delay>{common-def:time-interval-sec}</spf-delay><spf-hold-time>{common-def:time-interval-sec}</spf-hold-time></spf> | OSPFv3 SPF timers |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><nonstop-routing>{enumeration}</nonstop-routing></ospf> | Enable nonstop-routing capability |
| <base_URI>/config/running/ipv6/router/ospf/{vrf} | <ospf><maximum-paths>{uint32}</maximum-paths></ospf> | Maximum path. |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa | <router-lsa><all-lsas>{enumeration}</all-lsas></router-lsa> | Replace Metric in all External and Summary LSAs with default max metric value |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/external-lsa | <external-lsa><external-lsa-value>{uint32}</external-lsa-value></external-lsa> | Indicates the metric of all external type 5 and type 7 LSA's |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/summary-lsa | <summary-lsa><summary-lsa-value>{uint32}</summary-lsa-value></summary-lsa> | Metric of all summary type 3 and type 4 LSAs |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa | <router-lsa><include-stub>{enumeration}</include-stub></router-lsa> | Configure include-stub for max-metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup | <on-startup><on-startup-time>{uint32}</on-startup-time></on-startup> | Amount of time to advertise maximum metric |
| <base_URI>/config/running/ipv6/router/ospf/{vrf}/max-metric/router-lsa/on-startup | <on-startup><wait-for-bgp>{enumeration}</wait-for-bgp></on-startup> | Advertise maximum metric until BGP has converged or 600 seconds |
GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.
The following example uses the GET option to retrieve the configuration details.
http://host:80/rest/config/running/ipv6/router/ospf/default-vrf
None
<ospf xmlns="urn:brocade.com:mgmt:brocade-ospfv3" xmlns:y="http://brocade.com/ns/rest"
y:self="/rest/config/running/ipv6/router/ospf/default-vrf">
<vrf>default-vrf</vrf>
<area y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/0">
<area-id>0</area-id>
<normal>true</normal>
<stub y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/0/stub">
</stub>
<authentication y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/0/authentication">
</authentication>
</area>
<area y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/100">
<area-id>100</area-id>
<normal>true</normal>
<stub y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/100/stub">
</stub>
<authentication y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/100/authentication">
</authentication>
</area>
<area y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/200">
<area-id>200</area-id>
<nssa y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/200/nssa">
</nssa>
<stub y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/200/stub">
</stub>
<authentication y:self="/rest/config/running/ipv6/router/ospf/default-vrf/area/200/authentication">
</authentication>
</area>
<auto-cost y:self="/rest/config/running/ipv6/router/ospf/default-vrf/auto-cost">
</auto-cost>
<default-information-originate y:self="/rest/config/running/ipv6/router/ospf/default-vrf/default-information-originate">
</default-information-originate>
<distribute-list y:self="/rest/config/running/ipv6/router/ospf/default-vrf/distribute-list">
<route-map y:self="/rest/config/running/ipv6/router/ospf/default-vrf/distribute-list/route-map">
</route-map>
<prefix-list y:self="/rest/config/running/ipv6/router/ospf/default-vrf/distribute-list/prefix-list">
</prefix-list>
</distribute-list>
<external-lsdb-limit>50000</external-lsdb-limit>
<graceful-restart y:self="/rest/config/running/ipv6/router/ospf/default-vrf/graceful-restart">
<helper y:self="/rest/config/running/ipv6/router/ospf/default-vrf/graceful-restart/helper">
</helper>
</graceful-restart>
<log y:self="/rest/config/running/ipv6/router/ospf/default-vrf/log">
</log>
<redistribute y:self="/rest/config/running/ipv6/router/ospf/default-vrf/redistribute">
</redistribute>
<timers y:self="/rest/config/running/ipv6/router/ospf/default-vrf/timers">
<spf y:self="/rest/config/running/ipv6/router/ospf/default-vrf/timers/spf">
</spf>
</timers>
<nonstop-routing>true</nonstop-routing>
<max-metric y:self="/rest/config/running/ipv6/router/ospf/default-vrf/max-metric">
</max-metric>
</ospf>
The following example uses the POST option to configure OSPF instance for the VRF.
http://host:80/rest/config/running/config/running/ipv6/router
<ospf><vrf>vrf1</vrf></ospf>
None