interface/{interface-type}/{interface-name}/ipv6/ospf

Configures, modifies, or retrieves the Open Shortest Path First (OSPF) version 3.

Resource URIs

URI Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/active Configures PBR (IPv6).

Valid interface types: Ethernet, Ve, Loopback.

GET URIs Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/area Displays the OSPF router area id.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/active Sets a specific OSPFv3 interface to active.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/passive Sets a specific OSPFv3 interface to passive.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/cost Displays cost for a specific OSPFv3 interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/instance Displays the number of OSPFv3 instances running on an interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/mtu-ignore Displays whether maximum transmission unit (MTU) match checking is enabled or disabled.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/network Displays network type.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/priority Displays priority for designated router (DR) election and backup designated routers (BDRs) on the interface you are connected to.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/suppress-linklsa Displays whether link LSA advertisements are suppressed.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication Displays authentication for the interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication/ipsec Displays IPSEC authentication for the interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication/ipsec/key-add-remove-interval Displays key add or remove interval in seconds.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/hello-interval Sets the length of time between the transmission of hello packets that an interface sends to neighbor routers.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/dead-interval Displays the time period for which a neighbor router waits for a hello packet from the device before declaring the router down.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/hello-jitter Displays the allowed jitter between HELLO packets.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/retransmit-interval Displays the retransmit interval.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/transmit-delay Displays transmit delay for link-update packets.

Valid interface types: Ethernet, Ve, Loopback.

PUT URIs Payload Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/active <active>{enumeration}</active> Sets a specific OSPFv3 interface to active.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/passive <passive>{enumeration}</passive> Sets a specific OSPFv3 interface to passive.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/cost <cost>{uint32}</cost> Configures cost for a specific OSPFv3 interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/instance <instance>{uint32}</instance> Specifies the number of OSPFv3 instances running on an interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/mtu-ignore <mtu-ignore>{enumeration}</mtu-ignore> Enables or disables maximum transmission unit (MTU) match checking.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/network <network>{enumeration}</network> Configures network type.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/priority <priority>{uint32}</priority> Configures priority for designated router (DR) election and backup designated routers (BDRs) on the interface you are connected to.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/suppress-linklsa <suppress-linklsa>{enumeration}</suppress-linklsa> Suppresses link LSA advertisements.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/authentication/ipsec/key-add-remove-interval <key-add-remove-interval>{common-def:time-interval-sec}</key-add-remove-interval> Key add or remove interval in seconds.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/hello-interval <hello-interval>{common-def:time-interval-sec}</hello-interval> Sets the length of time between the transmission of hello packets that an interface sends to neighbor routers.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/dead-interval <dead-interval>{common-def:time-interval-sec}</dead-interval> Specifies the time period for which a neighbor router waits for a hello packet from the device before declaring the router down.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/hello-jitter <hello-jitter>{uint32}</hello-jitter> Sets the allowed jitter between HELLO packets.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/retransmit-interval <retransmit-interval>{common-def:time-interval-sec}</retransmit-interval> Configures the retransmit interval. The retransmit interval is the time between Link-State Advertisement (LSA) retransmissions to adjacent routers for a given interface.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{interface-name}/ipv6/ospf/transmit-delay <transmit-delay>{common-def:time-interval-sec}</transmit-delay> Configures transmit delay for link-update packets. The transmit delay is the estimated time required for OSPFv3 to send linkstate update packets on the interface to which you are connected.

Valid interface types: Ethernet, Ve, Loopback.

PATCH URIs Payload Description
<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><ah>{algorithm-type-ah}</ah><disable>{enumeration}</disable></authentication> Security Parameter Index specifying the authentication algorithm to use.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><no-encrypt>{enumeration}</no-encrypt><disable>{enumeration}</disable></authentication> Security Parameter Index without encrypting the key.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><key>{ipsec-authentication-hexkey-string}</key><disable>{enumeration}</disable></authentication> Security Parameter Index with Key used for ah.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><esp>{algorithm-type-esp}</esp><disable>{enumeration}</disable></authentication> Security Parameter Index specifying Encapsulating Security Payload (ESP).

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><esp-no-encrypt>{enumeration}</esp-no-encrypt><disable>{enumeration}</disable></authentication> Security Parameter Index without encrypting the key.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><esp-key>{ipsec-authentication-hexkey-string}</esp-key><disable>{enumeration}</disable></authentication> Security Parameter Index with Hexadecimal key string for ESP.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><esp-auth>{algorithm-type-ah}</esp-auth><disable>{enumeration}</disable></authentication> Security Parameter Index using Authentication Algorithm.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><no-encrypt>{enumeration}</no-encrypt><disable>{enumeration}</disable></authentication> Security Parameter Index without encrypting the key.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <authentication><spi>{spi-value-type}</spi><key>{ipsec-authentication-hexkey-string}</key><disable>{enumeration}</disable></authentication> Security Parameter Index with Hexadecimal key string for authentication algorithm.

Valid interface types: Ethernet, Ve, Loopback.

<base_URI>/config/running/interface/{interface-type}/{name}/ipv6/ospf/authentication/ipsec <ipsec><key-add-remove-interval>{common-def:time-interval-sec}</key-add-remove-interval></ipsec> Key add or remove interval in seconds.

Valid interface types: Ethernet, Ve, Loopback.

Usage Guidelines

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

Examples

URI

The following is an example of the PUT operation to configure a specific OSPFv3 interface to active.

http://host:80/rest/config/running/interface/Ethernet/%221/1%22/ipv6/ospf/active 

<active>true</active>

None

9036681-01 Rev AA