This document provides a brief description of the IP6Map OpEN APIs. It provides the following services:

Get the administrative mode of the router for given VRF.
Set the administrative mode of the router for given VRF.
Get the dynamic renewal mode of IPv6 neighbors in a given VRF.
Set the dynamic renewal mode of IPv6 neighbors in a given VRF.
Get the NUD backoff-multiple value set for calculation of timeouts for NS transmissions during NUD for a given VRF.
Set the NUD backoff-multiple value for calculation of timeouts for NS transmissions during NUD for a given VRF.
Get the maximum unicast neighbor solicitations sent during NUD for a given VRF.
Set the maximum unicast neighbor solicitations sent during NUD for a given VRF.
Get the maximum multicast neighbor solicitations sent during NUD for a given VRF.
Set the maximum multicast neighbor solicitations sent during NUD for a given VRF.
Get the rate limit value set for the unresolved IPv6 data packets coming to CPU.
Set the rate limit value for the unresolved IPv6 data packets coming to CPU.
Get the default IPv6 router TTL value for a given VRF.
Set the default IPv6 router TTL value for a given VRF.
Get the administrative state of a given interface.
Get the operational state of a given interface.
Set the administrative state of a given interface.
Get the IPv6 AutoState mode of a given interface.
Set the IPv6 AutoState mode of a given interface.
Determine if IPv6 interface exists.
Determine if the interface is valid for participation in the IPv6 component.
Determine if the interface is valid to be configured with an IPv6 neighbor.
Get the IPv6 MTU of a given interface.
Get the IPv6 effective MTU of a given interface.
Set the IPv6 MTU of a given interface.
Get the interface bandwidth of a given interface.
Get the first valid interface for participation in IPv6 component.
Get the next valid interface for participation in IPv6 component.

Example C Application ip6map_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

ip6map_example

ip6map_example.c is a sample application that demonstrates the use of OpEN's IP6Map APIs. ip6map_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

Usage: ./ip6map_example <test#> <arg1> <arg2> ...
Test 1: Get the administrative mode of the router for given VRF: ip6map_example 1 <vrfName>
Test 2: Set the administrative mode of the router for given VRF: ip6map_example 2 <vrfName> <mode>
Test 3: Get the dynamic renewal mode of IPv6 neighbors in a given VRF: ip6map_example 3 <vrfName>
Test 4: Set the dynamic renewal mode of IPv6 neighbors in a given VRF: ip6map_example 4 <vrfName> <mode>
Test 5: Get the NUD backoff-multiple value set for calculation of timeouts for NS transmissions during NUD for a given VRF: ip6map_example 5 <vrfName>
Test 6: Set the NUD backoff-multiple value for calculation of timeouts for NS transmissions during NUD for a given VRF: ip6map_example 6 <vrfName> <val>
Test 7: Get the maximum unicast neighbor solicitations sent during NUD for a given VRF: ip6map_example 7 <vrfName>
Test 8: Set the maximum unicast neighbor solicitations sent during NUD for a given VRF: ip6map_example 8 <vrfName> <val>
Test 9: Get the maximum multicast neighbor solicitations sent during NUD for a given VRF: ip6map_example 9 <vrfName>
Test 10: Set the maximum multicast neighbor solicitations sent during NUD for a given VRF: ip6map_example 10 <vrfName> <val>
Test 11: Get the rate limit value set for the unresolved IPv6 data packets coming to CPU: ip6map_example 11
Test 12: Set the rate limit value for the unresolved IPv6 data packets coming to CPU: ip6map_example 12 <val>
Test 13: Get the default IPv6 router TTL value for a given VRF: ip6map_example 13 <vrfName>
Test 14: Set the default IPv6 router TTL value for a given VRF: ip6map_example 14 <vrfName> <val>
Test 15: Get the administrative state of a given interface: ip6map_example 15 <ifNum>
Test 16: Get the operational state of a given interface: ip6map_example 16 <ifNum>
Test 17: Set the administrative state of a given interface: ip6map_example 17 <ifNum> <mode>
Test 18: Get the IPv6 AutoState mode of a given interface: ip6map_example 18 <ifNum>
Test 19: Set the IPv6 AutoState mode of a given interface: ip6map_example 19 <ifNum> <mode>
Test 20: Determine if IPv6 interface exists: ip6map_example 20 <ifNum>
Test 21: Determine if the interface is valid for participation in the IPv6 component: ip6map_example 21 <ifNum>
Test 22: Determine if the interface is valid to be configured with an IPv6 neighbor: ip6map_example 22 <ifNum>
Test 23: Get the IPv6 MTU of a given interface: ip6map_example 23 <ifNum>
Test 24: Get the IPv6 effective MTU of a given interface: ip6map_example 24 <ifNum>
Test 25: Set the IPv6 MTU of a given interface: ip6map_example 25 <ifNum> <val>
Test 26: Get the interface bandwidth of a given interface: ip6map_example 26 <ifNum>
Test 27: Get the first valid interface for participation in IPv6 component: ip6map_example 27
Test 28: Get the next valid interface for participation in IPv6 component: ip6map_example 28 <prevIfNum>
Test 29: Get the maximum IP MTU that may be set on an interface: ip6map_example 29 <ifNum>

IP6Map CLI/API Cross Reference

CLI Command	OpEN API Reference
(Privileged exec Mode)# show ipv6 vrf <vrf-name>	openapiIp6VrRtrAdminModeGet
(localhost)(config-vrf-test)# iipv6 unicast-routing	openapiIp6VrRtrAdminModeSet
(Privileged exec Mode)# show ipv6 brief	openapiIp6VrNbrsDynRenewGet
(localhost)(config-vrf-test)# iipv6 neighbors dynamicrenew	openapiIp6VrNbrsDynRenewSet
(localhost)(config-vrf-test)# ipv6 nud backoff-multiple <1-5>	openapiIp6VrNudBackoffMultipleSet
(Privileged exec Mode)# show running-config	openapiIp6VrNudMaxUnicastSolicitsGet
(localhost)(config-vrf-test)# ipv6 nud max-unicast-solicits <3-10>	openapiIp6VrNudMaxUnicastSolicitsSet
(Privileged exec Mode)# show ipv6 brief	openapiIp6VrNudMaxMcastSolicitsGet
(localhost)(config-vrf-test)# ipv6 nud max-multicast-solicits <3-10>	openapiIp6VrNudMaxMcastSolicitsSet
(Privileged exec Mode)# show ipv6 brief	openapiIp6UnresolvedRateLimitGet
(localhost)(Config)# ipv6 unresolved-traffic rate-limit <rate-in-pps>	openapiIp6UnresolvedRateLimitSet
(localhost)(Config)# ipv6 neighbor <ipv6_address>	openapiIp6MapNbrIntfIsValid
(Privileged exec Mode)# show ipv6 brief	openapiIp6VrRtrDefaultTTLGet
(localhost)(config)# ipv6 hop-limit <hops>	openapiIp6VrRtrDefaultTTLSet
(localhost)(config-vrf-test)# ipv6 hop-limit <hops>	openapiIp6VrRtrDefaultTTLSet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrIntfModeGet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrIntfOperModeGet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrIntfAutoStateModeGet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6IntfExists
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6MapIntfValidFirstGet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6MapIntfValidNextGet
(Privileged exec Mode)# show running-config	openapiIp6RtrIntfIpv6MtuGet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrIntfIpv6EffectiveMtuGet
(localhost)(Interface vlan 10)#ipv6 mtu <bytes>	openapiIp6RtrIntfMaxIpv6MtuGet
(localhost)(Interface vlan 10)#ipv6 nd mtu	openapiIp6RtrIntfMaxIpv6MtuGet
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrIntfBandwidthGet