OSPFv3

33 min

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