Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
Data Structures | Macros | Typedefs | Enumerations | Functions
openapi_ip6map.h File Reference
#include "openapi_common.h"
#include "openapi_routing.h"
#include "openapi_mpls.h"
#include "openapi_routing_config.h"

Go to the source code of this file.

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...