OSPFv3

Open Shortest Path First version 3.

URLs Summary

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/rpc/clear-ipv6-ospf6	N	Y	N	N	N
/rest/v1/rpc/graceful-restart-prepare-ipv6-ospf	N	Y	N	N	N
/rest/v1/running/ospfv3-interfaces/{name}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}/areas/{area-id}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}/areas/{area-id}/area-ranges/{ip-prefix}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}/areas/{area-id}/nssa-area-ranges/{ip-prefix}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}/distribute-route/{protocol}/{direction}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}/graceful-restart-helper/{address}	Y	Y	Y	N	Y
/rest/v1/running/ospfv3/{vrf-name}/spf	Y	N	Y	N	N
/rest/v1/running/ospfv3/{vrf-name}/summary-address/{summary-prefix}	Y	Y	Y	N	Y
/rest/v1/rpc/show-ipv6-ospf6-database	N	Y	N	N	N
/rest/v1/rpc/show-ipv6-ospf6-interface	N	Y	N	N	N
/rest/v1/rpc/show-ipv6-ospf6-neighbor	N	Y	N	N	N
/rest/v1/rpc/show-ipv6-ospf6-route	N	Y	N	N	N

Examples

Create an interface for OSPFv3

POST HTTPS://{switch IP}/rest/v1/running/ospfv3-interfaces
{
    "name": "Ethernet1",
    "area-id": "0.0.0.10",
    "bfd-enable": "true",
    "metric": "50",
    "dead-interval": "50",
    "hello-interval": "50",
    "mtu-ignore": "true",
    "network-type": "broadcast",
    "priority": "50",
    "retransmission-interval": "50",
    "transmit-delay": "50",
    "passive": "true",
    "bfd-profile": "test"
}

Create OSPFv3 for a VRF

POST HTTPS://{switch IP}/rest/v1/running/ospfv3
{
    "vrf-name": "Vrf3",
    "enable": "true",
    "auto-cost-reference-bandwidth": 50,
    "spf":
    {
        "initial-delay": 5,
        "initial-holdtime": 3,
        "maximum-holdtime": 4
    }
}

Get all the OSPFv3 information for a VRF

GET HTTPS://{switch IP}/rest/v1/running/ospfv3/Vrf3

Create an area

POST HTTPS://{switch IP}/rest/v1/running/ospfv3/default/areas
{
    "area-id": "0.0.0.120",
    "stub": "true"
}

Create an area range

POST HTTPS://{switch IP}/rest/v1/running/ospfv3/default/areas/30/area-ranges
{
    "ip-prefix": "1:7::7:4/64",
    "cost": 70,
    "advertise": "true"
}

Create a nssa-area-range for an area with ID {area-id}

POST HTTPS://{switch IP}/rest/v1/running/ospfv3/default/areas/30/nssa-area-ranges
{
    "ip-prefix": "1:2::/64",
    "enable": "true"
}

Create a distributed route

POST HTTPS://{switch IP}/rest/v1/running/ospfv3/default/distribute-route
{
    "protocol": "bgp",
    "direction": "IMPORT",
    "metric": 28,
    "metric-type": "TYPE_2",
    "always": "true"
}

Create a graceful-restart-helper for VRF

POST HTTPS://{switch IP}/rest/v1/running/ospfv3/default/graceful-restart-helper
{
    "address": "1.2.3.7",
    "enable": "true"
}

Update SPF

PATCH HTTPS://{switch IP}/rest/v1/running/ospfv3/default/spf
{
    "initial-delay": 30,
    "initial-holdtime": 60,
    "maximum-holdtime": 80
}

Create a summary address for a VRF

POST HTTPS://{switch IP}/rest/v1/running/ospfv3/default/summary-address
{
    "summary-prefix": "0001:0009::0007:0004/64",
    "enable": "true",
    "tag": 127
}

Properties Descriptions

OSPFv3 global

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw enable?
  |     +--rw router-id?
  |     +--rw auto-cost-reference-bandwidth?
  |     +--rw graceful-restart?
  |     +--rw grace-period?
  |     +--rw log-adjacency-changes?
  |     +--rw maximum-paths?
  |     +--rw stub-router-administrative?
  |     +--rw write-multiplier?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default”vrf name	(sub-property of ospfv3) Name of the VRF instance.
enable	O	”true""false”	(sub-property of ospfv3) Enable OSPFv3
router-id	O	A.B.C.D	(sub-property of ospfv3) Router-id for the OSPF process.
auto-cost-reference-bandwidth	O	1..4294967	(sub-property of ospfv3) The reference bandwidth in terms of Mbits per second.
graceful-restart	O	”true""false”	(sub-property of ospfv3) Enable OSPFv3 graceful-restart. Default value: “false”
grace-period	O	1..1800	(sub-property of ospfv3) Time to wait before restarting the OSPFv3 session. Default value: 120
log-adjacency-changes	O	”DETAIL""BRIEF”	(sub-property of ospfv3) Enbale recording adjacency changes log.
maximum-paths	O	1..256	(sub-property of ospfv3) Control the maximum number of equal cost paths. Default value: 256
stub-router-administrative	O	”true""false”	(sub-property of ospfv3) Make a router a stub router for indefinite period of time.
write-multiplier	O	1..100	(sub-property of ospfv3) The amount of work done in the packet read and write threads. Default value: 20

OSPFv3 areas for VRF

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw areas
  |     |  +--rw area* [area-id]
  |     |     +--rw area-id
  |     |     +--rw filter-list-in?
  |     |     +--rw filter-list-out?
  |     |     +--rw nssa-no-summary?
  |     |     +--rw nssa?
  |     |     +--rw stub?
  |     |     +--rw stub-no-summary?
  |     |     +--rw default-information-originate?
  |     |     +--rw default-information-originate-metric?
  |     |     +--rw default-information-originate-metric-type?
  |     |     +--rw area-ranges
  |     |     |  +--rw area-range* [ip-prefix]
  |     |     |     +--rw ip-prefix
  |     |     |     +--rw enable?
  |     |     |     +--rw cost?
  |     |     |     +--rw advertise?
  |     |     +--rw nssa-area-ranges
  |     |        +--rw nssa-area-range* [ip-prefix]
  |     |           +--rw ip-prefix
  |     |           +--rw enable?
  |     |           +--rw not-advertise?
  |     |           +--rw cost?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default”vrf name	(sub-property of ospfv3) Name of the VRF instance.
areas	M		(sub-property of ospfv3) Path-only node, has no configurable value.
area-id	M	A.B.C.D	(sub-property of areas) 32-bit number identifying the OSPF area.
filter-list-in	O	string	(sub-property of areas) Filter networks getting in OSPFv3 areas.
filter-list-out	O	string	(sub-property of areas) Filter networks getting out OSPFv3 areas.
nssa-no-summary	O	”true""false”	(sub-property of areas) Do not inject inter-area routes into nssa. Default value: “false”
nssa	O	”true""false”	(sub-property of areas) Config the area as nssa area.
stub	O	”true""false”	(sub-property of areas) Config the area as stub area.
stub-no-summary	O	”true""false”	(sub-property of areas) Do not inject inter-area routes into stub. Default value: “false”
default-information-originate	O	”true""false”	(sub-property of areas) Originate Type 7 default into NSSA area.
default-information-originate-metric	O	0..16777214	(sub-property of areas) OSPF default metric.
default-information-originate-metric-type	O	”TYPE_1""TYPE_2”	(sub-property of areas) Metric type (1/2).
area-ranges	M		(sub-property of areas) Path-only node, has no configurable value.
ip-prefix	M	XX:XX:XX:XX :XX:XX:XX:XX/M	(sub-property of area-ranges) Designated IPv6 range.
enable	O	”true""false”	(sub-property of area-ranges) Summarize routes matching address/mask (border routers only).
cost	O	0..16777215	(sub-property of area-ranges) Set an explicit metric.
advertise	O	”true""false”	(sub-property of area-ranges) Summarize intra area paths from specified area into one Type-3 summary-LSA.
nssa-area-ranges	M		(sub-property of areas) Path-only node, has no configurable value.
ip-prefix	M	XX:XX:XX:XX :XX:XX:XX:XX/M	(sub-property of nssa-area-ranges) Designated IPv6 range.
enable	O	”true""false”	(sub-property of nssa-area-ranges) Summarize routes matching address/mask (border routers only).
not-advertise	O	”true""false”	(sub-property of nssa-area-ranges) Instead of summarizing intra area paths filter them.
cost	O	0..16777215	(sub-property of nssa-area-ranges) Set an explicit metric.

OSPFv3 distance for VRF

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw all-distance?
  |     +--rw inter-area-distance?
  |     +--rw intra-area-distance?
  |     +--rw external-distance?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default”vrf name	(sub-property of ospfv3) Name of the VRF instance.
all-distance	O	0..255	(sub-property of ospfv3) Preference for intra-area, inter-area, and external routes.
inter-area-distance	O	0..255	(sub-property of ospfv3) Preference for inter-area routes.
intra-area-distance	O	0..255	(sub-property of ospfv3) Preference for intra-area routes.
external-distance	O	0..255	(sub-property of ospfv3) Preference for AS external and NSSA routes.

OSPFv3 timer for VRF

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw lsa-min-arrival?
  |     +--rw spf
  |     |  +--rw initial-delay
  |     |  +--rw initial-holdtime
  |     |  +--rw maximum-holdtime
  |     +--rw aggregation-timer?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default”vrf name	(sub-property of ospfv3) Name of the VRF instance.
lsa-min-arrival	O	0..600000	(sub-property of ospfv3) Minimum delay in receiving new version of an LSA.
spf	M		(sub-property of ospfv3) Path-only node, has no configurable value.
initial-delay	M	0..600000	(sub-property of spf) Specifies the minimum amount of time to delay SPF calculation.
initial-holdtime	M	0..600000	(sub-property of spf) Separated consecutive SPF calculations.
maximum-holdtime	M	0..600000	(sub-property of spf) Maximum of holdtime.
aggregation-timer	O	5..1800	(sub-property of ospfv3) Summarisation starts only after this delay timer expiry. Default value: 5

OSPFv3 graceful restart helper for VRF

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw graceful-restart-helper* [address]
  |     |  +--rw address
  |     |  +--rw enable?
  |     +--rw graceful-restart-helper-enable?
  |     +--rw lsa-check-disable?
  |     +--rw planned-only?
  |     +--rw supported-grace-time-interval?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default”vrf name	(sub-property of ospfv3) Name of the VRF instance.
graceful-restart-helper	M		(sub-property of ospfv3) Path-only node, has no configurable value.
address	M	A.B.C.D	(sub-property of graceful-restart-helper) Router id to enable graceful-restart helper
enable	O	”true""false”	(sub-property of graceful-restart-helper) Enable graceful-restart helper
graceful-restart-helper-enable	O	”true""false”	(sub-property of ospfv3) Enable graceful-restart helper
lsa-check-disable	O	”true""false”	(sub-property of ospfv3) Disabel strict LSA checking.
planned-only	O	”true""false”	(sub-property of ospfv3) Only implement planned restart.
supported-grace-time-interval	O	10..1800	(sub-property of ospfv3) Supported grace time as graceful-restart helper.

OSPFv3 summary address for VRF

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw summary-address* [summary-prefix]
  |     |  +--rw summary-prefix
  |     |  +--rw enable?
  |     |  +--rw tag?
  |     |  +--rw no-advertise?
  |     |  +--rw metric?
  |     |  +--rw metric-type?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default”vrf name	(sub-property of ospfv3) Name of the VRF instance.
summary-address	M		(sub-property of ospfv3) Path-only node, has no configurable value.
summary-prefix	M	XX:XX:XX:XX :XX:XX:XX:XX/M	(sub-property of summary-address) IP address to distribute summary.
enable	O	”true""false”	(sub-property of summary-address) Enable summary address.
tag	O	1..4294967295	(sub-property of summary-address) Tag for summary route
no-advertise	O	”true""false”	(sub-property of summary-address) Don’t advertise the summary address to others
metric	O	0..16777214	(sub-property of summary-address) OSPF default metric.
metric-type	O	”TYPE_1""TYPE_2”	(sub-property of summary-address) Metric type (1/2).

OSPFv3 distribute route for VRF

Tree Diagrams

  +--rw ospfv3
  |  +--rw ospfv3-instance* [vrf-name]
  |     +--rw vrf-name
  |     +--rw distribute-route* [protocol direction]
  |        +--rw protocol
  |        +--rw direction
  |        +--rw route-map?
  |        +--rw access-list?
  |        +--rw always?
  |        +--rw metric?
  |        +--rw metric-type?

Table of Properties

Name	Required	Type/Range	Description
ospfv3	M		Path-only node, has no configurable value. Top-level configuration for the OSPFv3 router.
vrf-name	M	”default” vrf name	(sub-property of ospfv3) Name of the VRF instance.
distribute-route	M		(sub-property of ospfv3) Path-only node, has no configurable value.
protocol	M	”kernel""connected""local" "static""ripng""ospf" "isis""bgp""eigrp" "nhrp""table""vnc" "vnc-direct""babel""sharp" "openfabric""default-route”	(sub-property of distribute-route) Protocol to import.
direction	M	”IMPORT”	(sub-property of distribute-route) Export or import router.
route-map	O	string	(sub-property of distribute-route) Route map reference.
access-list	O	string	(sub-property of distribute-route) Access-list filter name.
always	O	”true""false”	(sub-property of distribute-route) Always advertise default route.
metric	O	0..16777214	(sub-property of distribute-route) OSPF default metric.
metric-type	O	”TYPE_1""TYPE_2”	(sub-property of distribute-route) Metric type (1/2).

OSPFv3 interfaces

Tree Diagrams

  +--rw ospfv3-interfaces
     +--rw ospfv3-interface* [name]
        +--rw name
        +--rw vrf-name?
        +--rw advertise-prefix-list?
        +--rw area-id?
        +--rw bfd-enable?
        +--rw ifmtu?
        +--rw instance-id?
        +--rw metric?
        +--rw dead-interval?
        +--rw hello-interval?
        +--rw mtu-ignore?
        +--rw network-type?
        +--rw priority?
        +--rw retransmission-interval?
        +--rw transmit-delay?
        +--rw passive?
        +--rw bfd-profile?

Table of Properties

Name	Required	Type/Range	Description
ospfv3-interfaces	M		Path-only node, has no configurable value.
name	M	Ethernet name Lag1..9999 Vlan1..4094 Ethernet sub-interface name Link-aggregation sub-interface name	(sub-property of ospfv3-interfaces) Name of interface.
vrf-name	O	”default”vrf name	(sub-property of ospfv3-interfaces) Name of VRF.
advertise-prefix-list	O	string	(sub-property of ospfv3-interfaces) Filter the routes that are advertised through OSPF6.
area-id	O	A.B.C.D	(sub-property of ospfv3-interfaces) Area ID for this network.
bfd-enable	O	”true""false”	(sub-property of ospfv3-interfaces) Enable bfd.
ifmtu	O	1..65535	(sub-property of ospfv3-interfaces) Set the Interface Maximum Transmission Unit (MTU) for an OSPF6 interface.
instance-id	O	0..255	(sub-property of ospfv3-interfaces) Assigns a specific instance ID to an OSPF6 interface.
metric	O	1..65535	(sub-property of ospfv3-interfaces) Cost value set to router-LSA’s metric field
dead-interval	O	1..65535	(sub-property of ospfv3-interfaces) Interval time after which a neighbor is declared down.
hello-interval	O	1..65535	(sub-property of ospfv3-interfaces) Set number of seconds for HelloInterval timer value.
mtu-ignore	O	”true""false”	(sub-property of ospfv3-interfaces) Enable mtu ignore.
network-type	O	”broadcast""non-broadcast" "point-to-multipoint" "point-to-point”	(sub-property of ospfv3-interfaces) Set network type.
priority	O	0..255	(sub-property of ospfv3-interfaces) Set RouterPriority integer value.
retransmission-interval	O	1..65535	(sub-property of ospfv3-interfaces) Set number of seconds for RxmtInterval timer value.
transmit-delay	O	1..65535	(sub-property of ospfv3-interfaces) Set number of seconds for InfTransDelay value.
passive	O	”true""false”	(sub-property of ospfv3-interfaces) Do not speak OSPFv3 on the interface.
bfd-profile	O	string	(sub-property of ospfv3-interfaces) Specify a BFD profile.

Show IPv6 ospf6 neighbor

Tree Diagrams

    +---x show-ipv6-ospf6-neighbor
    |  +---w input
    |  |  +---w vrf?
    |  |  +---w (options)?
    |  |     +--:(drchoice)
    |  |     |  +---w drchoice?
    |  |     +--:(detail)
    |  |     |  +---w detail?
    |  |     +--:(neighbor-id)
    |  |        +---w neighbor-id?
    |  +--ro output
    |     +--ro data?

Table of Properties

Name	Required	Type/Range	Description
show-ipv6-ospf6-neighbor	M		Path-only node, has no configurable value. Show OSPFv3 neighbors information.
vrf	O	”default” vrf name	(sub-property of input) Name of VRF instance.
drchoice	O	empty	(sub-property of input) Mutually exclusive with: - detail - neighbor-id Display DR choices.
detail	O	empty	(sub-property of input) Mutually exclusive with: - drchoice - neighbor-id Display more details.
neighbor-id	O	A.B.C.D	(sub-property of input) Mutually exclusive with: - drchoice - detail Display information of specific neighbor-id.
data	RO	<anydata>	(sub-property of output)

Show IPv6 ospf6 route

Tree Diagrams

    +---x show-ipv6-ospf6-route
    |  +--ro output
    |     +--ro data?

Table of Properties

Name	Required	Type/Range	Description
show-ipv6-ospf6-route	M		Path-only node, has no configurable value. Show OSPFv3 route information.
data	RO	<anydata>	(sub-property of output)

Show IPv6 ospf6 database

Tree Diagrams

    +---x show-ipv6-ospf6-database
    |  +--ro output
    |     +--ro data?

Table of Properties

Name	Required	Type/Range	Description
show-ipv6-ospf6-database	M		Path-only node, has no configurable value. Show OSPFv3 database information.
data	RO	<anydata>	(sub-property of output)

Show IPv6 ospf6 interface

Tree Diagrams

    +---x show-ipv6-ospf6-interface
    |  +---w input
    |  |  +---w (options)?
    |  |     +--:(traffic)
    |  |     |  +---w traffic?
    |  |     +--:(interface)
    |  |        +---w interface?
    |  |        +---w prefix?
    |  |        +---w (prefix-extensions)?
    |  |           +--:(detail)
    |  |           |  +---w detail?
    |  |           +--:(match)
    |  |              +---w match?
    |  +--ro output
    |     +--ro data?

Table of Properties

Name	Required	Type/Range	Description
show-ipv6-ospf6-interface	M		Path-only node, has no configurable value. Show OSPFv3 interface information.
traffic	O	Ethernet name Lag1..9999 Vlan1..4094 Ethernet sub-interface name Link-aggregation sub-interface name	(sub-property of input) Mutually exclusive with: - interface - prefix Protocol Packet counters.
interface	O	Ethernet name Lag1..9999 Vlan1..4094 Ethernet sub-interface name Link-aggregation sub-interface name	(sub-property of input) Mutually exclusive with: - traffic Display information of specific interface.
prefix	O	”XX:XX:XX:XX:XX:XX:XX:XX/M" "XX:XX:XX:XX:XX:XX:XX:XX" "detail""all”	(sub-property of input) Mutually exclusive with: - traffic Display connected prefixes to advertise
detail	O	empty	(sub-property of input) Mutually exclusive with: - match Display details of the prefixes.
match	O	empty	(sub-property of input) Mutually exclusive with: - detail Display the route matches the prefix
data	RO	<anydata>	(sub-property of output)

Clear IPv6 OSPF6

Tree Diagrams

    +---x clear-ipv6-ospf6
    |  +---w input
    |     +---w (options)?
    |        +--:(interface)
    |        |  +---w interface?
    |        |  +---w vrf?
    |        +--:(process)
    |           +---w process?
    |           +---w vrf-for-process?

Table of Properties

Name	Required	Type/Range	Description
clear-ipv6-ospf6	M		Path-only node, has no configurable value. Clear OSPFv3 data structures.
interface	O	Ethernet name Lag1..9999 Vlan1..4094 Ethernet sub-interface name Link-aggregation sub-interface name	(sub-property of input) Mutually exclusive with: - process - vrf-for-process Clear information of specific interface.
vrf	O	”default” vrf name	(sub-property of input) Mutually exclusive with: - process - vrf-for-process Name of VRF instance.
process	O	empty	(sub-property of input) Mutually exclusive with: - interface - vrf Reset OSPFv3 Process.
vrf-for-process	O	”default” vrf name	(sub-property of input) Mutually exclusive with: - interface - vrf Name of VRF instance.

Graceful restart prepare ipv6 ospf

Tree Diagrams

    +---x graceful-restart-prepare-ipv6-ospf

Table of Properties

Name	Required	Type/Range	Description
graceful-restart-prepare-ipv6-ospf	M		Path-only node, has no configurable value. Initiate a graceful restart for all OSPFv3 instances.