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

Set IPv6 router advertise Minimum advertisement interval.
Get IPv6 router advertise Minimum advertisement interval.
Set IPv6 router advertise Maximum advertisement interval.
Get IPv6 router advertise Maximum advertisement interval.
Set IPv6 router advertise lifetime.
Get IPv6 router advertise lifetime.
Set IPv6 router advertise link mtu.
Get IPv6 router advertise link mtu.
Set IPv6 router preference.
Get IPv6 router preference.
Set IPv6 router advertise managed flag.
Get IPv6 router advertise managed flag.
Set IPv6 router advertise other-config flag.
Get IPv6 router advertise other-config flag.
Set IPv6 hop limit advertised on the given interface to unspecified(0).
Get whether IPv6 hop limit is advertised on the given interface to unspecified(0)
Set IPv6 router advertise suppression.
Get IPv6 router advertise suppression
Set IPv6 router as per prefix attributes.
Get IPv6 router as per prefix attributes.

Example C Application ip6radv_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.

ip6radv_example

ip6radv_example.c is a sample application that demonstrates the use of OpEN's IP6RADV APIs. ip6radv_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: ./ip6radv_example <test#> <arg1> <arg2> ...
Test 1: Set IPv6 router advertise Minimum advertisement interval: ip6radv_example 1 <ifNum> <val>
Test 2: Get IPv6 router advertise Minimum advertisement interval: ip6radv_example 2 <ifNum>
Test 3: Set IPv6 router advertise Maximum advertisement interval: ip6radv_example 3 <ifNum> <val>
Test 4: Get IPv6 router advertise Maximum advertisement interval: ip6radv_example 4 <ifNum>
Test 5: Set IPv6 router advertise lifetime: ip6radv_example 5 <ifNum> <val>
Test 6: Get IPv6 router advertise lifetime: ip6radv_example 6 <ifNum>
Test 7: Set IPv6 router advertise link mtu: ip6radv_example 7 <ifNum> <val>
Test 8: Get IPv6 router advertise link mtu: ip6radv_example 8 <ifNum>
Test 9: Set IPv6 router preference: ip6radv_example 9 <ifNum> <val>
Test 10: Get IPv6 router preference: ip6radv_example 10 <ifNum>
Test 11: Set IPv6 router advertise managed flag: ip6radv_example 11 <ifNum> <flag>
Test 12: Get IPv6 router advertise managed flag: ip6radv_example 12 <ifNum>
Test 13: Set IPv6 router advertise other-config flag: ip6radv_example 13 <ifNum> <flag>
Test 14: Get IPv6 router advertise other-config flag: ip6radv_example 14 <ifNum>
Test 15: Set IPv6 hop limit advertised on the interface to unspecified(0): ip6radv_example 15 <ifNum> <flag>
Test 16: Get whether IPv6 hop limit advertised on the interface to unspecified(0): ip6radv_example 16 <ifNum>
Test 17: Set IPv6 router advertise suppression: ip6radv_example 17 <ifNum> <flag>
Test 18: Get IPv6 router advertise suppression: ip6radv_example 18 <ifNum>
Test 19: Set IPv6 router as per prefix attributes: ip6radv_example 19 <ifNum> <prefix> <plen> <prefLife> <validLife> <lifeDecrFlags> <onLink> <autonomous>
Test 20: Get IPv6 router as per prefix attributes: ip6radv_example 20 <ifNum> <prefix> <plen>

IP6RADV CLI/API Cross Reference

CLI Command	OpEN API Reference
(localhost)(Interface vlan 10)# ipv6 nd ra-interval <max> <min>	openapiIp6RtrRadvMinAdvIntSet()
(Privileged exec Mode)# show running-config	openapiIp6RtrRadvMinAdvIntGet()
(localhost)(Interface vlan 10)# ipv6 nd ra-interval <max> <min>	openapiIp6RtrRadvMaxAdvIntSet()
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrRadvMaxAdvIntGet()
(localhost)(Interface vlan 10)# ipv6 nd ra-lifetime	openapiIp6RtrRadvAdvLifetimeSet()
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrRadvAdvLifetimeGet()
(localhost)(Interface vlan 10)# ipv6 nd mtu	openapiIp6RtrRadvAdvMtuSet()
(Privileged exec Mode)# show ipv6 interface [<interface>]	openapiIp6RtrRadvAdvMtuGet()

(localhost)(Interface vlan 10)#
ipv6 nd router-preference {low|medium|high} | openapiIp6RtrRadvRtrPrefSet() (Privileged exec Mode)#
show ipv6 interface [<interface>] | openapiIp6RtrRadvRtrPrefGet() (localhost)(Interface vlan 10)#
ipv6 nd managed-config-flag | openapiIp6RtrRadvManagedFlagSet() (Privileged exec Mode)#
show ipv6 interface [<interface>] | openapiIp6RtrRadvManagedFlagGet() (localhost)(Interface vlan 10)#
ipv6 nd other-config-flag | openapiIp6RtrRadvOtherCfgFlagSet() (Privileged exec Mode)#
show ipv6 interface [<interface>] | openapiIp6RtrRadvOtherCfgFlagGet() (localhost)(Interface vlan 10)#
ipv6 nd ra hop-limit unspecified | openapiIp6RtrRadvHopLimitUnspec() (Privileged exec Mode)#
show ipv6 interface [<interface>] | openapiIp6RtrRadvHopLimitUnspecGet() (Privileged exec Mode)#
show ipv6 interface [<interface>] | openapiIp6RtrRadvPrefixGet() (localhost)(Interface vlan 10)#
ipv6 nd prefix | openapiIp6RtrRadvPrefixSet() (localhost)(Interface vlan 10)#
ipv6 nd suppress-ra | openapiIp6RtrRadvSuppressSet() (Privileged exec Mode)#
show ipv6 interface [<interface>] | openapiIp6RtrRadvSuppressGet()