This Code Implements The OpEN IP6MAP API [OPENAPI_IP6MAP]

Data Structures
struct	open_ipv6IntfAddr_s
struct	openapi_ip6_cfg_addr_list_s
struct	openapiECMPRoute6_s
struct	openapiEqualCostPath6_s
struct	openapiIpstkIpv6IfIcmpStats_t
struct	openapiIpv6AddrEntry_s
struct	openapiIpv6AddrPrefixEntry_s
struct	openapiIpv6IfStats_t
struct	openapiRoute6Entry_s
struct	openIpv6IntfAddrList_s
struct	openIpv6RouteEntry_s
struct	openNullOid_s

Macros
#define	OPEN_IP6_ND_DAD_ATTEMPTS_MAX   600
#define	OPEN_IP6_ND_REACHABLE_MAX   3600000UL
	IPv6 ICMP interface statistics.
#define	OPEN_IP6_NDNS_INTERVAL_MAX   4294967295U
#define	OPEN_IP6_NDNS_INTERVAL_MIN   1000
#define	OPEN_RTR6_ADDR_AUTOCONFIG_ENA   0x08
	auto config address
#define	OPEN_RTR6_ADDR_DHCP_ENA   0x10
	dhcp address More...
#define	OPEN_RTR6_ADDR_EUI64   0x02
	use eui64 interface ID
#define	OPEN_RTR6_ADDR_LINK_LOCAL_ENA   0x01
	link local addr even if no global addr
#define	OPEN_RTR6_MAX_INTF_ADDRS   4

Typedefs
typedef enum openIp6IntfAddrStates	OPEN_IPV6_INTFADDR_STATES
	Structure of IPv6 address enty.
typedef struct open_ipv6IntfAddr_s	open_ipv6IntfAddr_t
	Structure for max list of IPv6 interface address structure.
typedef struct openapi_ip6_cfg_addr_list_s	openapi_ip6_cfg_addr_list_t
	Address mode flags.
typedef struct openapiECMPRoute6_s	openapiECMPRoute6_t
	IPv6 Route entry.
typedef struct openapiEqualCostPath6_s	openapiEqualCostPath6_t
typedef struct openapiIpv6AddrEntry_s	openapiIpv6AddrEntry_t
	Structure for IPv6 prefix enty.
typedef struct openapiIpv6AddrPrefixEntry_s	openapiIpv6AddrPrefixEntry_t
	Structure for IPv6 interface address, along with its state.
typedef struct openapiRoute6Entry_s	openapiRoute6Entry_t
	Structure for list of IPv6 addresses configured on interface.
typedef struct openIpv6IntfAddrList_s	openIpv6IntfAddrList_t
	Structure for NULL OID.
typedef struct openIpv6RouteEntry_s	openIpv6RouteEntry_t
	Neighbor state definitions as per RFC 2465.
typedef struct openNullOid_s	openNullOid_t
	Structure for IPv6 Route entry.

Enumerations
enum	OPEN_IP6_NBR_STATE_t {   OPEN_IP6_NBR_STATE_REACHABLE = 1, OPEN_IP6_NBR_STATE_STALE, OPEN_IP6_NBR_STATE_DELAY, OPEN_IP6_NBR_STATE_PROBE,   OPEN_IP6_NBR_STATE_INCOMPLETE, OPEN_IP6_NBR_STATE_UNKNOWN, OPEN_IP6_NBR_STATE_UNREACHABLE, OPEN_IP6_NBR_STATE_PERMANENT }
enum	OPEN_IP6_NBR_TYPE_t { OPEN_IP6_NBR_TYPE_OTHER = 1, OPEN_IP6_NBR_TYPE_DYNAMIC, OPEN_IP6_NBR_TYPE_STATIC, OPEN_IP6_NBR_TYPE_LOCAL }
enum	openIp6IntfAddrStates {   OPEN_IPV6_INTFADDR_INACTIVE = 1, OPEN_IPV6_INTFADDR_TENTATIVE, OPEN_IPV6_INTFADDR_ACTIVE, OPEN_IPV6_INTFADDR_AUTOCONFIG,   OPEN_IPV6_INTFADDR_DHCP }

Functions
OPEN_BOOL_t	openapiIp6IntfExists (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Determine if IPv6 interface exists. More...
OPEN_BOOL_t	openapiIp6MapIntfIsValid (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Determine if the interface is valid for participation in the IPv6 component. More...
open_error_t	openapiIp6MapIntfValidFirstGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
	Get the first valid interface for participation in IPv6 component. More...
open_error_t	openapiIp6MapIntfValidNextGet (openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum)
	Get the next valid interface for participation in IPv6 component. More...
OPEN_BOOL_t	openapiIp6MapNbrIntfIsValid (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Determine if the interface is valid to be configured with an IPv6 neighbor. More...
open_error_t	openapiIp6RtrCfgIntfAddressesGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *numAddr, openapi_ip6_cfg_addr_list_t *ipv6AddrList, OPEN_CONTROL_t *ipv6Mode, OPEN_CONTROL_t *autoConfigMode, OPEN_CONTROL_t *dhcpMode)
	Get the configured IPv6 addresses and modes on the interface. More...
open_error_t	openapiIp6RtrDadTransmitsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *val)
	Get the number of neighbor solicits configured to be sent for duplicate address detection (DAD) on an interface. More...
open_error_t	openapiIp6RtrDadTransmitsSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t val)
	Set the number of neighbor solicits to be sent for duplicate address detection (DAD) on an interface. More...
open_error_t	openapiIp6RtrIntfAddressesGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *numAddr, openIpv6IntfAddrList_t *ipv6AddrList)
	Get the IPv6 addresses of the interface. More...
open_error_t	openapiIp6RtrIntfAddressGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, open_inet_addr_t *inetAddr)
	Get the IPv6 address of the interface. More...
open_error_t	openapiIp6RtrIntfAutoStateModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the IPv6 AutoState mode of a given interface. More...
open_error_t	openapiIp6RtrIntfAutoStateModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Set the IPv6 AutoState mode of a given interface. More...
open_error_t	openapiIp6RtrIntfBandwidthGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get the interface bandwidth of a given interface. More...
open_error_t	openapiIp6RtrIntfICMPUnreachablesModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode)
	Get the configured mode for ICMPv6 unreachable messages. More...
open_error_t	openapiIp6RtrIntfICMPUnreachablesModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode)
	Set the configured mode for ICMPv6 unreachable messages. More...
open_error_t	openapiIp6RtrIntfIpv6EffectiveMtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get the IPv6 effective MTU of a given interface. More...
open_error_t	openapiIp6RtrIntfIpv6MtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get the IPv6 MTU of a given interface. More...
open_error_t	openapiIp6RtrIntfIpv6MtuSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Set the IPv6 MTU of a given interface. More...
open_error_t	openapiIp6RtrIntfMaxIpv6MtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get the maximum IPv6 MTU that may be set on an interface. More...
open_error_t	openapiIp6RtrIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the administrative state of a given interface. More...
open_error_t	openapiIp6RtrIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Set the administrative state of a given interface. More...
open_error_t	openapiIp6RtrIntfOperModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the operational state of a given interface. More...
open_error_t	openapiIp6RtrNdNsIntervalGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *val)
	Get the interval between IPv6 neighbor solicitation retransmissions on an interface. More...
open_error_t	openapiIp6RtrNdNsIntervalSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t val)
	Set the interval between IPv6 neighbor solicitation retransmissions on an interface. More...
open_error_t	openapiIp6RtrNdReachableTimeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *val)
	Get the amount of time that a remote IPv6 node is reachable. More...
open_error_t	openapiIp6RtrNdReachableTimeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t val)
	Set the amount of time that a remote IPv6 node is reachable. More...
open_error_t	openapiIp6UnresolvedRateLimitGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Get the rate limit value set for the unresolved IPv6 data packets coming to CPU. More...
open_error_t	openapiIp6UnresolvedRateLimitSet (openapiClientHandle_t *client_handle, uint32_t val)
	Set the rate limit value for the unresolved IPv6 data packets coming to CPU. More...
open_error_t	openapiIp6VrNbrsDynRenewGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
	Get the dynamic renewal mode of IPv6 neighbors in a given VRF. More...
open_error_t	openapiIp6VrNbrsDynRenewSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
	Set the dynamic renewal mode of IPv6 neighbors in a given VRF. More...
open_error_t	openapiIp6VrNudBackoffMultipleGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
	Get the NUD backoff-multiple value set for calculation of timeouts for NS transmissions during NUD for a given VRF. More...
open_error_t	openapiIp6VrNudBackoffMultipleSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
	Set the NUD backoff-multiple value for calculation of timeouts for NS transmissions during NUD for a given VRF. More...
open_error_t	openapiIp6VrNudMaxMcastSolicitsGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
	Get the maximum multicast neighbor solicitations sent during NUD for a given VRF. More...
open_error_t	openapiIp6VrNudMaxMcastSolicitsSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
	Set the maximum multicast neighbor solicitations sent during NUD for a given VRF. More...
open_error_t	openapiIp6VrNudMaxUnicastSolicitsGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
	Get the maximum unicast neighbor solicitations sent during NUD for a given VRF. More...
open_error_t	openapiIp6VrNudMaxUnicastSolicitsSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
	Set the maximum unicast neighbor solicitations sent during NUD for a given VRF. More...
open_error_t	openapiIp6VrRtrAdminModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
	Get the IPv6 administrative mode of the router for given VRF. More...
open_error_t	openapiIp6VrRtrAdminModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
	Set the IPv6 administrative mode of the router for given VRF. More...
open_error_t	openapiIp6VrRtrDefaultTTLGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val)
	Get the default IPv6 router TTL value for a given VRF. More...
open_error_t	openapiIp6VrRtrDefaultTTLSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val)
	Set the default IPv6 router TTL value for a given VRF. More...
open_error_t	openapiIpv6AddrEntryGet (openapiClientHandle_t *client_handle, uint32_t matchType, openapiIpv6AddrEntry_t *ipv6AddrEntry)
	Get the IPv6 address details. More...
open_error_t	openapiIpv6AddrEntryGetNext (openapiClientHandle_t *client_handle, uint32_t matchType, openapiIpv6AddrEntry_t *ipv6AddrEntry)
	Get the IPv6 address details of the next entry. More...
open_error_t	openapiIpv6AddrPrefixEntryGet (openapiClientHandle_t *client_handle, uint32_t matchType, openapiIpv6AddrPrefixEntry_t *ipv6AddrPrefixEntry)
	Get the IPv6 address prefix details. More...
open_error_t	openapiIpv6IfIcmpStatsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, openapiIpstkIpv6IfIcmpStats_t *ipv6IfIcmpStats)
	Get IPv6 ICMP statistics for the given interface. More...
open_error_t	openapiIpv6IfStatsClear (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Clear IPv6 statistics for the given interface. More...
open_error_t	openapiIpv6IfStatsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, openapiIpv6IfStats_t *ipv6IfStats)
	Get IPv6 statistics for the given interface. More...
open_error_t	openapiIpv6NbrTblEntryGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_inet_addr_t *ipv6Addr, open_buffdesc *macAddr, uint32_t *intIfNum, OPEN_IP6_NBR_TYPE_t *ipv6Type, OPEN_IP6_NBR_STATE_t *nbrState, uint32_t *lastUpdate, OPEN_BOOL_t *isRouter, uint32_t *ipv6ScopeId)
	Get the IPv6 neighbor entries. More...
open_error_t	openapiIpv6NdpFlush (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t intIfNum, open_inet_addr_t *ipv6Addr)
	Flush the IPv6 neighbor entries. More...
open_error_t	openapiIpv6RouteCountGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *count, OPEN_BOOL_t bestRouteOnly)
	Get the number of routes in the routing table. More...
open_error_t	openapiIpv6RouteEntryGetNext (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, openapiRoute6Entry_t *ipv6Route, OPEN_BOOL_t bestRouteOnly)
	Get the next route entry for the specified route destination. More...
open_error_t	openapiIpv6TotalStatsClear (openapiClientHandle_t *client_handle)
	Clear IPv6 statistics on all interfaces. More...
open_error_t	openapiIpv6TotalStatsGet (openapiClientHandle_t *client_handle, openapiIpv6IfStats_t *ipv6IfStats, openapiIpstkIpv6IfIcmpStats_t *ipv6IfIcmpStats)
	Get total of each IPv6 statistic on all interfaces. More...
open_error_t	openapiSnmpIpv6StaticRouteGetNext (openapiClientHandle_t *client_handle, openIpv6RouteEntry_t *routeEntry)
	Get the next static IPv6 route from the routing table. More...

Detailed Description

Macro Definition Documentation

#define OPEN_RTR6_ADDR_DHCP_ENA   0x10

dhcp address

Interface IPv6 address states

Definition at line 193 of file openapi_ip6map.h.

Enumeration Type Documentation

enum OPEN_IP6_NBR_STATE_t

Enumerator
OPEN_IP6_NBR_STATE_REACHABLE	Reachable.
OPEN_IP6_NBR_STATE_STALE	Stale.
OPEN_IP6_NBR_STATE_DELAY	Delay.
OPEN_IP6_NBR_STATE_PROBE	Probe.
OPEN_IP6_NBR_STATE_INCOMPLETE	Incomplete.
OPEN_IP6_NBR_STATE_UNKNOWN	Unknown.
OPEN_IP6_NBR_STATE_UNREACHABLE	Unreachable.
OPEN_IP6_NBR_STATE_PERMANENT	Permanent.

Definition at line 272 of file openapi_ip6map.h.

enum OPEN_IP6_NBR_TYPE_t

Enumerator
OPEN_IP6_NBR_TYPE_OTHER	Other.
OPEN_IP6_NBR_TYPE_DYNAMIC	Dynamic.
OPEN_IP6_NBR_TYPE_STATIC	Static.
OPEN_IP6_NBR_TYPE_LOCAL	Local.

Definition at line 285 of file openapi_ip6map.h.

enum openIp6IntfAddrStates

Enumerator
OPEN_IPV6_INTFADDR_INACTIVE	inactive
OPEN_IPV6_INTFADDR_TENTATIVE	tentative
OPEN_IPV6_INTFADDR_ACTIVE	active
OPEN_IPV6_INTFADDR_AUTOCONFIG	autoconfig
OPEN_IPV6_INTFADDR_DHCP	dhcp

Definition at line 196 of file openapi_ip6map.h.

Function Documentation

OPEN_BOOL_t openapiIp6IntfExists	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Determine if IPv6 interface exists.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number

Returns

OPEN_TRUE If given IPv6 interface exists

OPEN_FALSE If given IPv6 interface does not exist

Return values

OPEN_E_UNAVAIL

Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

OPEN_BOOL_t openapiIp6MapIntfIsValid	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Determine if the interface is valid for participation in the IPv6 component.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number

Returns

OPEN_TRUE If given interface is valid for IPv6

OPEN_FALSE If given interface is not valid for IPv6

Return values

OPEN_E_UNAVAIL

Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6MapIntfValidFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ifNum
	)

Get the first valid interface for participation in IPv6 component.

Parameters

[in]	client_handle	Client handle from registration API
[out]	ifNum	Internal Interface Number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6MapIntfValidNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	prevIfNum,
		uint32_t *	ifNum
	)

Get the next valid interface for participation in IPv6 component.

Parameters

[in]	client_handle	Client handle from registration API
[in]	prevIfNum	Previous Internal Interface Number
[out]	ifNum	Internal Interface Number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

OPEN_BOOL_t openapiIp6MapNbrIntfIsValid	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Determine if the interface is valid to be configured with an IPv6 neighbor.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number

Returns

OPEN_TRUE If given interface is valid for IPv6 neighbor

OPEN_FALSE If given interface is not valid for IPv6 neighbor

Return values

OPEN_E_UNAVAIL

Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrCfgIntfAddressesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	numAddr,
		openapi_ip6_cfg_addr_list_t *	ipv6AddrList,
		OPEN_CONTROL_t *	ipv6Mode,
		OPEN_CONTROL_t *	autoConfigMode,
		OPEN_CONTROL_t *	dhcpMode
	)

Get the configured IPv6 addresses and modes on the interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in,out]	numAddr	Number of IPv6 addresses to be fetched or configured on interface.
[out]	ipv6AddrList	List of IPv6 addresses configured on interface.
[out]	ipv6Mode	IPv6(link local) mode on interface.
[out]	autoConfigMode	Auto config mode on interface.
[out]	dhcpMode	DHCP mode on interface.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrDadTransmitsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	val
	)

Get the number of neighbor solicits configured to be sent for duplicate address detection (DAD) on an interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	val	Number of neighbor solicits to be sent for DAD.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrDadTransmitsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	val
	)

Set the number of neighbor solicits to be sent for duplicate address detection (DAD) on an interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	val	Number of neighbor solicits to be sent for DAD.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfAddressesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	numAddr,
		openIpv6IntfAddrList_t *	ipv6AddrList
	)

Get the IPv6 addresses of the interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in,out]	numAddr	Number of addresses to be fetched or actual available on interface.
[out]	ipv6AddrList	List of IPv6 address on interface.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfAddressGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		open_inet_addr_t *	inetAddr
	)

Get the IPv6 address of the interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	inetAddr	Address on the interface.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfAutoStateModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Get the IPv6 AutoState mode of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfAutoStateModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Set the IPv6 AutoState mode of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfBandwidthGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get the interface bandwidth of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	The bandwidth value in bytes

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfICMPUnreachablesModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	mode
	)

Get the configured mode for ICMPv6 unreachable messages.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	mode	Enable or Disable ICMPv6 unreachable messages.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfICMPUnreachablesModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	mode
	)

Set the configured mode for ICMPv6 unreachable messages.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	mode	Enable or Disable ICMPv6 unreachable messages.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfIpv6EffectiveMtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get the IPv6 effective MTU of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	The IPv6 effective MTU value in bytes

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

Note

Link MTU is returned if IPv6 MTU is not configured.

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfIpv6MtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get the IPv6 MTU of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	The IPv6 MTU value in bytes

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfIpv6MtuSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Set the IPv6 MTU of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	val	The IPv6 MTU value in bytes

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfMaxIpv6MtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get the maximum IPv6 MTU that may be set on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	The IPv6 maximum MTU value in bytes

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

Note

On port based routing interfaces, the IP MTU may be set as large as the link MTU. On VLAN routing interfaces, the IP MTU may be set as large as the largest jumbo frame will allow.

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Get the administrative state of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Set the administrative state of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrIntfOperModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Get the operational state of a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrNdNsIntervalGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	val
	)

Get the interval between IPv6 neighbor solicitation retransmissions on an interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	val	Interval between IPv6 neighbor solicitation retransmissions in milliseconds.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrNdNsIntervalSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	val
	)

Set the interval between IPv6 neighbor solicitation retransmissions on an interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	val	Interval between IPv6 neighbor solicitation retransmissions in milliseconds.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrNdReachableTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	val
	)

Get the amount of time that a remote IPv6 node is reachable.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[out]	val	Reachable time in milliseconds.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6RtrNdReachableTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	val
	)

Set the amount of time that a remote IPv6 node is reachable.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal interface number.
[in]	val	Reachable time in milliseconds.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIp6UnresolvedRateLimitGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

Get the rate limit value set for the unresolved IPv6 data packets coming to CPU.

Parameters

[in]	client_handle	Client handle from registration API
[out]	val	The rate-limt value in pps(packet-per-second)

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6UnresolvedRateLimitSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	val
	)

Set the rate limit value for the unresolved IPv6 data packets coming to CPU.

Parameters

[in]	client_handle	Client handle from registration API
[in]	val	The rate-limt value in pps(packet-per-second)

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNbrsDynRenewGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_CONTROL_t *	mode
	)

Get the dynamic renewal mode of IPv6 neighbors in a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNbrsDynRenewSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_CONTROL_t	mode
	)

Set the dynamic renewal mode of IPv6 neighbors in a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNudBackoffMultipleGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	val
	)

Get the NUD backoff-multiple value set for calculation of timeouts for NS transmissions during NUD for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	val	The backoff multiple value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNudBackoffMultipleSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	val
	)

Set the NUD backoff-multiple value for calculation of timeouts for NS transmissions during NUD for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	val	The backoff multiple value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNudMaxMcastSolicitsGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	val
	)

Get the maximum multicast neighbor solicitations sent during NUD for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	val	The maximum multicast solicits value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNudMaxMcastSolicitsSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	val
	)

Set the maximum multicast neighbor solicitations sent during NUD for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	val	The maximum multicast solicits value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNudMaxUnicastSolicitsGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	val
	)

Get the maximum unicast neighbor solicitations sent during NUD for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	val	The maximum unicast solicits value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrNudMaxUnicastSolicitsSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	val
	)

Set the maximum unicast neighbor solicitations sent during NUD for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	val	The maximum unicast solicits value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrRtrAdminModeGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_CONTROL_t *	mode
	)

Get the IPv6 administrative mode of the router for given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

Note

This routine returns the user-configured state of the router.

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrRtrAdminModeSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_CONTROL_t	mode
	)

Set the IPv6 administrative mode of the router for given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	mode	OPEN_ENABLE or OPEN_DISABLE

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrRtrDefaultTTLGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	val
	)

Get the default IPv6 router TTL value for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	val	The TTL value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

Note

If 0 is returned for 'val' then it means TTL is not configured.

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIp6VrRtrDefaultTTLSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	val
	)

Set the default IPv6 router TTL value for a given VRF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	val	The TTL value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature is not supported

Note

This value is sent in router advertisements

OpEN API Version: 1.25

Examples:

ip6map_example.c.

open_error_t openapiIpv6AddrEntryGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	matchType,
		openapiIpv6AddrEntry_t *	ipv6AddrEntry
	)

Get the IPv6 address details.

Parameters

[in]	client_handle	client handle from registration API.
[in]	matchType	Match type. (1 - EXACT and 2 - NEXT).
[in,out]	ipv6AddrEntry	IPv6 address entry.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6AddrEntryGetNext	(	openapiClientHandle_t *	client_handle,
		uint32_t	matchType,
		openapiIpv6AddrEntry_t *	ipv6AddrEntry
	)

Get the IPv6 address details of the next entry.

Parameters

[in]	client_handle	client handle from registration API.
[in]	matchType	Match type. (1 - EXACT and 2 - NEXT).
[in,out]	ipv6AddrEntry	IPv6 address entry.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6AddrPrefixEntryGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	matchType,
		openapiIpv6AddrPrefixEntry_t *	ipv6AddrPrefixEntry
	)

Get the IPv6 address prefix details.

Parameters

[in]	client_handle	client handle from registration API.
[in]	matchType	Match type. (1 - EXACT and 2 - NEXT).
[in,out]	ipv6AddrPrefixEntry	IPv6 address entry.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6IfIcmpStatsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		openapiIpstkIpv6IfIcmpStats_t *	ipv6IfIcmpStats
	)

Get IPv6 ICMP statistics for the given interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal Interface number.
[out]	ipv6IfIcmpStats	IPv6 ICMP Interface Stats.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6IfStatsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Clear IPv6 statistics for the given interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal Interface number.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6IfStatsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		openapiIpv6IfStats_t *	ipv6IfStats
	)

Get IPv6 statistics for the given interface.

Parameters

[in]	client_handle	client handle from registration API.
[in]	intIfNum	Internal Interface number.
[out]	ipv6IfStats	IPv6 Interface Stats.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6NbrTblEntryGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		open_inet_addr_t *	ipv6Addr,
		open_buffdesc *	macAddr,
		uint32_t *	intIfNum,
		OPEN_IP6_NBR_TYPE_t *	ipv6Type,
		OPEN_IP6_NBR_STATE_t *	nbrState,
		uint32_t *	lastUpdate,
		OPEN_BOOL_t *	isRouter,
		uint32_t *	ipv6ScopeId
	)

Get the IPv6 neighbor entries.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vrfName	VRF name.
[in,out]	ipv6Addr	IPv6 address of the neighbor.
[out]	macAddr	Mac address of the neighbor.
[in,out]	intIfNum	Internal interface number.
[out]	ipv6Type	Type of neighbor.
[out]	nbrState	State of neighbor.
[out]	lastUpdate	Time since last update to the neighbor state.
[out]	isRouter	True is neighbor is router or else False.
[out]	ipv6ScopeId	IPv6 Scope id of the neighbor address incase of link local.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Interface should be passed to get neighbor for specific interface, it can be left 0 otherwise. Pass the returned ip6Addr and ip6ScopeId to get the next entry.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6NdpFlush	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	intIfNum,
		open_inet_addr_t *	ipv6Addr
	)

Flush the IPv6 neighbor entries.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vrfName	VRF name.
[in]	intIfNum	Internal interface number
[in]	ipv6Addr	Address on the neighbor entry.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Flushes the entire all the neighbors on the interface if ipv6Addr is NULL pointer. Flushes the entire table if intIfNum is 0 and ipv6Addr is a NULL pointer.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6RouteCountGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	count,
		OPEN_BOOL_t	bestRouteOnly
	)

Get the number of routes in the routing table.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vrfName	VRF Name.
[out]	count	Route count.
[in]	bestRouteOnly	Get best route only. OPEN_TRUE or OPEN_FALSE.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6RouteEntryGetNext	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		openapiRoute6Entry_t *	ipv6Route,
		OPEN_BOOL_t	bestRouteOnly
	)

Get the next route entry for the specified route destination.

Parameters

[in]	client_handle	client handle from registration API.
[in]	vrfName	VRF Name.
[in,out]	ipv6Route	IPv6 route entry.
[in]	bestRouteOnly	Get best route only. OPEN_TRUE or OPEN_FALSE.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

To get first entry ip6Addr, ip6PrefixLen, protocol and pref in ipv6Route pointer should be set with 0.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6TotalStatsClear

(

openapiClientHandle_t *

client_handle

)

Clear IPv6 statistics on all interfaces.

Parameters

[in]

client_handle

client handle from registration API.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiIpv6TotalStatsGet	(	openapiClientHandle_t *	client_handle,
		openapiIpv6IfStats_t *	ipv6IfStats,
		openapiIpstkIpv6IfIcmpStats_t *	ipv6IfIcmpStats
	)

Get total of each IPv6 statistic on all interfaces.

Parameters

[in]	client_handle	client handle from registration API.
[out]	ipv6IfStats	IPv6 Interface Stats.
[out]	ipv6IfIcmpStats	IPv6 ICMP Interface Stats.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.

open_error_t openapiSnmpIpv6StaticRouteGetNext	(	openapiClientHandle_t *	client_handle,
		openIpv6RouteEntry_t *	routeEntry
	)

Get the next static IPv6 route from the routing table.

Parameters

[in]	client_handle	client handle from registration API.
[in,out]	routeEntry	Next route entry.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

ip6map_example.c.