Routing Configuration And Status [OPENAPI_ROUTING_CONFIG]

Data Structures
struct	OPEN_ARP_ENTRY_INFO_t
struct	OPEN_ARP_STATIC_ALL_t
struct	open_arpCacheStats_s

Macros
#define	OPEN_DEFAULT_VRF_NAME   ""
	Default VRF name.
#define	OPEN_DOT1Q_MAX_VLAN_ID   4094
	Maximum VLAN ID value.
#define	OPEN_DOT1Q_MIN_VLAN_ID   1
	Minimum VLAN ID value.
#define	OPEN_FD_RTR_MAX_STATIC_ARP_ENTRIES   512
	FD_RTR_MAX_STATIC_ARP_ENTRIES. More...
#define	OPEN_INVALID_INTF   0
	Invalid internal interface number. More...
#define	OPEN_RTO_PREFERENCE_MAX   255
	VRF set failure reason codes.
#define	OPEN_RTO_PREFERENCE_MIN   1
#define	OPEN_VRF_MAX_NAME_LEN   15
	largest allowable VRF name
#define	OPEN_VRF_MIN_NAME_LEN   0
	smallest allowable VRF name

Typedefs
typedef struct open_arpCacheStats_s	open_arpCacheStats_t
	Defines for ARP entry types.
typedef enum OPEN_INTF_URPF_MODE_s	OPEN_INTF_URPF_MODE_t

Enumerations
enum	OPEN_ARP_TYPES_t {   OPEN_ARP_TYPE_LOCAL = 0x01, OPEN_ARP_TYPE_GATEWAY = 0x02, OPEN_ARP_TYPE_RESOLVED = 0x04, OPEN_ARP_TYPE_NET_DIR_BCAST = 0x08,   OPEN_ARP_TYPE_DISCARD_WHEN_SOURCE = 0x10, OPEN_ARP_TYPE_STATIC = 0x20, OPEN_ARP_TYPE_UNNUMBERED = 0x40, OPEN_ARP_TYPE_KERNEL = 0x80 }
enum	OPEN_INTF_IP6_ADDR_MODE_t { OPEN_IP6_ADDR_MODE_LINK_LOCAL = 0, OPEN_IP6_ADDR_MODE_AUTOCONFIG = 1, OPEN_IP6_ADDR_MODE_DHCP = 2 }
enum	OPEN_INTF_IP_ADDR_TYPE_t { OPEN_IP_ADDR_TYPE_STATIC_PRIMARY = 0, OPEN_IP_ADDR_TYPE_STATIC_SECONDARY = 1, OPEN_IP_ADDR_TYPE_DHCP = 2 }
	< Type of IP address. More...
enum	OPEN_INTF_URPF_MODE_s { OPEN_IPMAP_INTF_URPF_MODE_DISABLE = 0, OPEN_IPMAP_INTF_URPF_MODE_LOOSE = 1, OPEN_IPMAP_INTF_URPF_MODE_STRICT = 2 }
enum	OPEN_IP_ECMP_LB_MODE_t {   OPEN_IP_ECMP_LB_MIN = 0, OPEN_IP_ECMP_LB_HASH_IN_SIP, OPEN_IP_ECMP_LB_HASH_IN_DIP, OPEN_IP_ECMP_LB_HASH_IN_SIP_DIP,   OPEN_IP_ECMP_LB_HASH_IN_SIP_SPORT, OPEN_IP_ECMP_LB_HASH_IN_DIP_DPORT, OPEN_IP_ECMP_LB_HASH_IN_SIP_DIP_SPORT_DPORT, OPEN_IP_ECMP_LB_HASH_OUT_SIP,   OPEN_IP_ECMP_LB_HASH_OUT_DIP, OPEN_IP_ECMP_LB_HASH_OUT_SIP_DIP, OPEN_IP_ECMP_LB_HASH_OUT_SIP_SPORT, OPEN_IP_ECMP_LB_HASH_OUT_DIP_DPORT,   OPEN_IP_ECMP_LB_HASH_OUT_SIP_DIP_SPORT_DPORT, OPEN_IP_ECMP_LB_MAX }
enum	OPEN_VRF_SET_ERROR_t {   OPEN_VRF_SET_ERROR_INVALID = 0, OPEN_LOOPBACK_ERROR = 1, OPEN_UNNUMBERED_ERROR, OPEN_SYSLOG_ERROR,   OPEN_IPV6_ERROR }

Functions
open_error_t	openapiArpEntryAdd (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr, open_buffdesc *mac_addr)
	Add an ARP entry. More...
open_error_t	openapiArpEntryDel (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr)
	Delete an ARP entry. More...
open_error_t	openapiArpEntryNextGet (openapiClientHandle_t *client_handle, uint32_t *intf, open_inet_addr_t *ipAddr, open_buffdesc *mac_addr)
	Get the next ARP entry. More...
open_error_t	openapiIfBandwidthGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *bandwidth)
	Get the bandwidth of the specified interface. More...
open_error_t	openapiIfBandwidthSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t bandwidth)
	Set the bandwidth of the specified interface. More...
open_error_t	openapiIfBWGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *bandwidth)
	Get the bandwidth of the specified interface without making any modification to the SET bandwidth. More...
open_error_t	openapiIntfEffectiveIpMtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *ipMtu)
	Gets the IP MTU value being enforced on a given interface. More...
open_error_t	openapiIntfIPv4MtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *ipMtu)
	Gets the configured IPv4 MTU value on the given interface. More...
open_error_t	openapiIntfMaxIpMtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *maxIpMtu)
	Get the maximum IP MTU that may be set on a given interface. More...
open_error_t	openapiIPAddrToIntIf (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ipAddr, uint32_t *ifNum)
	Get the internal interface number of the given VRF and IPv4 address. More...
open_error_t	openapiIpArpCacheStatsGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_arpCacheStats_t *pStats)
	Retrieve various ARP cache statistics. More...
open_error_t	openapiIpEcmpIpsecSpiGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *spiMode)
	Determines the current IP ECMP IPSEC SPI Mode. More...
open_error_t	openapiIpEcmpIpsecSpiSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t spiMode)
	Sets the current IP ECMP IPSEC SPI Hashing mode. More...
open_error_t	openapiIpEcmpLbGet (openapiClientHandle_t *client_handle, OPEN_IP_ECMP_LB_MODE_t *lbMode)
	Determines the current IP ECMP global load balancing mode. More...
open_error_t	openapiIpEcmpLbSet (openapiClientHandle_t *client_handle, OPEN_IP_ECMP_LB_MODE_t lbMode)
	Sets the current IP ECMP global load balancing mode. More...
open_error_t	openapiIpHelperAddressAdd (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr, uint32_t udpPort)
	Adds IP Helper Address and UDP port number. More...
open_error_t	openapiIpHelperAddressDel (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr, uint32_t udpPort)
	Deletes IP Helper Address and UDP port number. More...
open_error_t	openapiIpHelperModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t ipHelperMode)
	Enables/Disables IP Helper mode. More...
open_error_t	openapiIpICMPEchoReplyModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t echoReplyMode)
	Enables/Disables IP ICMP Echo Reply mode. More...
open_error_t	openapiIpManagementInterfaceGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
	Get the configured IPv4 Management interface. More...
open_error_t	openapiIpManagementInterfaceParamsSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t dhcpEnabled, uint32_t ipAddr, uint32_t subnetMask)
	Set the IPv4 Management interface and enable dhcp or configure static IP on the management interface. More...
open_error_t	openapiIpManagementInterfaceSet (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Set the IPv4 Management interface. More...
open_error_t	openapiIpMapForwardingStatsGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Gets the packets forwarded by CPU. More...
open_error_t	openapiIpMapICMPUnreachablesModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the administrative mode of sending ICMP Unreachables. More...
open_error_t	openapiIpMapIfICMPRedirectsModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the interface mode of sending ICMP Redirects. More...
open_error_t	openapiIpMapIntfUrpfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_INTF_URPF_MODE_t *mode, OPEN_BOOL_t *allowDefault)
	Get the interface uRPF mode and allowDefault option. More...
open_error_t	openapiIpMapIntfUrpfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_INTF_URPF_MODE_t mode, OPEN_BOOL_t allowDefault)
	Set the interface uRPF mode and allowDefault option. More...
open_error_t	openapiIpMapIpEvtDampGetDampParams (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *flaps, uint32_t *penalty, uint32_t *isSuppressed, uint32_t *reuseTime, uint32_t *maxPenalty)
	Invokes the IPMAP API funciton to get the dampening operational values. More...
open_error_t	openapiIpMapIpPacketsReceivedGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Get the IP packets count received by IP-Stack. More...
open_error_t	openapiIpMapProtoNextGet (openapiClientHandle_t *client_handle, uint32_t *protoId)
	Get the next protocol ID by iterating through all registered protocols. More...
open_error_t	openapiIpMapResilientHashingModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *resHashMode)
	Gets the global resilient hashing mode for ECMP trunks. More...
open_error_t	openapiIpMapResilientHashingModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t resHashMode)
	Sets the global resilient hashing mode for ECMP trunks. More...
open_error_t	openapiIpMapRouteTypeToProtoId (openapiClientHandle_t *client_handle, uint32_t routeType, uint32_t *protoId)
	Get the protocol ID for a given route type. More...
open_error_t	openapiIpMapRtrICMPEchoReplyModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
	Get the administrative mode of sending ICMP Echo Replies. More...
open_error_t	openapiIpMapRtrICMPEchoReplyModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
	Set ignore mode for ICMP ECHO Requests. More...
open_error_t	openapiIpMapRtrICMPRatelimitGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *burstSize, uint32_t *interval)
	Get the ICMP Rate Limiting parameters like burst size and interval. More...
open_error_t	openapiIpMapRtrICMPRatelimitSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t burstSize, uint32_t interval)
	Set the ICMP Rate Limiting parameters like burst size and interval. More...
open_error_t	openapiIpMapRtrICMPRedirectsModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
	Get the administrative mode of sending ICMP Redirects. More...
open_error_t	openapiIpMapRtrICMPRedirectsModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
	Set the administrative mode of sending ICMP Redirects. More...
open_error_t	openapiIpMapRtrIntfVrfReset (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Unset the VRF participation on an interface. More...
open_error_t	openapiIpMapRtrIntfVrfSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vrfName, OPEN_VRF_SET_ERROR_t *vrfSetError)
	Set the VRF participation of an interface. More...
open_error_t	openapiIpMapStaticArpAdd (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_inet_addr_t ipAddress, uint32_t intIfNum, open_buffdesc *macAddrBuf)
	Add a static ARP entry of a given VRF instance. More...
open_error_t	openapiIpMapStaticArpDelete (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_inet_addr_t ipAddress, uint32_t intIfNum)
	Delete a static ARP entry of a given VRF instance. More...
open_error_t	openapiIpMapSystemUrpfModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *urpfEnabled)
	Get the System mode for uRPF. More...
open_error_t	openapiIpMapSystemUrpfModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t urpfEnabled)
	Set the System mode for uRPF. More...
open_error_t	openapiIpMapValidIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
	Get the first valid interface. More...
open_error_t	openapiIpMapValidIntfNextGet (openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum)
	Get the next valid interface. More...
open_error_t	openapiIpMcastsFwdModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Determine whether an interface is configured to forward multicast packets. More...
open_error_t	openapiIpNetDirectBcastsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *adminMode)
	Gets the admin mode for IP forwarding of net-directed broadcasts. More...
open_error_t	openapiIpNetPrototypeRoutesDelete (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t protoId)
	Delete all net-prototype route entries. More...
open_error_t	openapiIpRedirectsModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t redirectsMode)
	Enables/Disables generation of IP Redirects messages. More...
open_error_t	openapiIpRouteAdd (openapiClientHandle_t *client_handle, OPEN_AF_t af, open_inet_pfx_t *ipAddr, open_inet_addr_t *nextHop, uint32_t rtPref, uint32_t intf, OPEN_MPLS_LABELS_t *mpls)
	Add an IP Route for a given address family. More...
open_error_t	openapiIpRouteDel (openapiClientHandle_t *client_handle, OPEN_AF_t af, open_inet_pfx_t *ipAddr, open_inet_addr_t *nextHop, uint32_t intf, OPEN_MPLS_LABELS_t *mpls)
	Delete an IP Route for a given address family. More...
open_error_t	openapiIpRtrInternalVlanIdToIntIfNum (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *ifNum)
	Get the internal interface number associated with the port-based routing interface corresponding to this internal VLAN. More...
open_error_t	openapiIpRtrIntfAutoStateModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the mode of AutoState feature of an interface. More...
open_error_t	openapiIpRtrIntfAutoStateModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Enable or disable the mode of AutoState feature of an interface. More...
open_error_t	openapiIpRtrIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Gets the router interface mode. More...
open_error_t	openapiIpRtrIntfOperModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Determine whether a given IP interface is up for IPv4. More...
open_error_t	openapiIpUnnumberedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isUnnumbered, uint32_t *numberedIfc)
	Determine whether a given interface is unnumbered and if it is, determine the interface whose address the unnumbered interface borrows. More...
open_error_t	openapiIpUnnumberedSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t isUnnumbered, uint32_t numberedIfc)
	Set the unnumbered status of an interface. More...
open_error_t	openapiIpVlanRtrIntIfNumToVlanId (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId)
	Get the VLAN ID corresponding to the given internal interface number. More...
open_error_t	openapiIpVlanRtrVlanIdGetNext (openapiClientHandle_t *client_handle, uint32_t *vlanId)
	Get the next vlan after this vlan on which routing is enabled. More...
open_error_t	openapiRtrAdminModeSet (openapiClientHandle_t *client_handle, OPEN_AF_t af, OPEN_CONTROL_t routingMode)
	Enables/Disables IP Routing Admin mode. More...
open_error_t	openapiRtrArpSwitchClear (openapiClientHandle_t *client_handle)
	Clear the switch/management ARP entries. More...
open_error_t	openapiRtrGratArpSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t gratArpState)
	Enable or disable gratuitous ARP on an interface. More...
open_error_t	openapiRtrIntfIpAddrAdd (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t intf, OPEN_INTF_IP_ADDR_TYPE_t addrType, open_inet_pfx_t *ipAddr, OPEN_CONTROL_t extArg)
	Add an IP address on a given router interface for a given address family. More...
open_error_t	openapiRtrIntfIpAddrDel (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t intf, OPEN_INTF_IP_ADDR_TYPE_t addrType, open_inet_pfx_t *ipAddr, OPEN_CONTROL_t extArg)
	Delete an IP address on a given router interface for a given address family. More...
open_error_t	openapiRtrIntfIpDestUnreachableModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t unreachableMode)
	Enables/Disables generation of IP Destination Unreachable messages on a Router interface. More...
open_error_t	openapiRtrIntfIpHelperAddressAdd (openapiClientHandle_t *client_handle, uint32_t intf, open_inet_addr_t ipAddr, uint32_t udpPort)
	Adds IP Helper Address and UDP port number on an interface. More...
open_error_t	openapiRtrIntfIpHelperAddressDel (openapiClientHandle_t *client_handle, uint32_t intf, open_inet_addr_t ipAddr, uint32_t udpPort)
	Deletes IP Helper Address and UDP port number on an interface. More...
open_error_t	openapiRtrIntfIpHelperDiscardAdd (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t udpPort)
	Adds IP Helper Discard entry in an interface. More...
open_error_t	openapiRtrIntfIpHelperDiscardDel (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t udpPort)
	Deletes IP Helper Discard entry in an interface. More...
open_error_t	openapiRtrIntfIpNetDirBroadcastModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t ipNetBroadcastMode)
	Enables/Disables forwarding of Network-directed broadcast on a Router Interface. More...
open_error_t	openapiRtrIntfIpProxyArpModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *ipProxyArpMode)
	Determine whether proxy ARP is enabled on an interface. More...
open_error_t	openapiRtrIntfIpProxyArpModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t ipProxyArpMode)
	Enables/Disables IP Proxy ARP mode on a Router Interface. More...
open_error_t	openapiRtrIntfIpRedirectsModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t redirectsMode)
	Enables/Disables generation of IP Redirects messages on a Router interface. More...
open_error_t	openapiRtrIntfIpv6AddressModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_INTF_IP6_ADDR_MODE_t addrMode, OPEN_BOOL_t setFlag)
	Set or reset the IPv6 address mode on a given router interface. More...
open_error_t	openapiRtrIntfMTUSet (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t intf, uint32_t MTU)
	Configures Router Interface MTU. More...
open_error_t	openapiRtrIntfRtrAdminModeSet (openapiClientHandle_t *client_handle, uint32_t intf, OPEN_CONTROL_t routingMode)
	Enables/Disables IP Routing mode (both v4 and v6) on a Router interface. More...
open_error_t	openapiRtrIpArpAgeTimeSet (openapiClientHandle_t *client_handle, uint32_t timeout)
	Sets the ARP entry ageout time. More...
open_error_t	openapiRtrIpArpCacheClear (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_BOOL_t gateway)
	Clears the ARP cache of all dynamic/gateway entries. More...
open_error_t	openapiRtrIpArpCacheSizeSet (openapiClientHandle_t *client_handle, uint32_t cacheSize)
	Sets the maximum number of entries in the ARP cache. More...
open_error_t	openapiRtrIpArpDynamicRenewGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dynRenewMode)
	Returns the ARP dynamic entry renew mode. More...
open_error_t	openapiRtrIpArpDynamicRenewSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t dynRenewMode)
	Enable or disable the ARP dynamic entry renew mode. More...
open_error_t	openapiRtrIpArpEntryPurge (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_inet_addr_t ipAddr, uint32_t intIfNum)
	Purges a specific dynamic/gateway entry from the ARP cache. More...
open_error_t	openapiRtrIpArpRespTimeSet (openapiClientHandle_t *client_handle, uint32_t timeout)
	Sets the ARP request response timeout. More...
open_error_t	openapiRtrIpArpRetriesSet (openapiClientHandle_t *client_handle, uint32_t count)
	Sets the ARP request max retries count. More...
open_error_t	openapiRtrIpMapStaticArpGetAll (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_ARP_STATIC_ALL_t *openArpEntries)
	Get a list of all static ARP entries currently configured. More...
open_error_t	openapiRtrIpUnnumberedGratArpGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *isEnabled)
	Get the behavior of gratuitous ARP received on unnumbered interface. More...
open_error_t	openapiRtrIpUnnumberedGratArpSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t isEnabled)
	Set the behavior of gratuitous ARP received on unnumbered interface. More...
open_error_t	openapiRtrLocalProxyArpModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *localProxyArpMode)
	Determine whether local proxy ARP is enabled on an interface. More...
open_error_t	openapiRtrLocalProxyArpModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t localProxyArpMode)
	Enable or disable local proxy ARP on an interface. More...
open_error_t	openapiRtrRouteMaxEqualCostEntriesGet (openapiClientHandle_t *client_handle, uint32_t *maxhops)
	Get the routing max equal cost entries. More...
open_error_t	openapiRtrRouteMaxRouteEntriesGet (openapiClientHandle_t *client_handle, uint32_t *maxroutes)
	Get the routing max routes entries. More...
open_error_t	openapiRtrVlanIntfCreate (openapiClientHandle_t *client_handle, uint32_t vlanId)
	Create a VLAN Routing Interface. More...
open_error_t	openapiRtrVlanIntfDelete (openapiClientHandle_t *client_handle, uint32_t vlanId)
	Delete a VLAN Routing Interface. More...
open_error_t	openapiRtrVlanIntfIfNumGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *intf)
	Get the interface number for a VLAN Routing Interface. More...
open_error_t	openapiSourceInterfacesGet (openapiClientHandle_t *client_handle, uint32_t *ifNum)
	Get source IP interface from Syslog, SNMP Traps, SNTP, DNS Client, RADIUS, TACACS+ and sFlow apps. More...
open_error_t	openapiSourceInterfacesSet (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Set source IP interface for Syslog, SNMP Traps, SNTP, DNS Client, RADIUS, TACACS+ and sFlow apps. More...
open_error_t	openapiVlanIntfIdGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *ifNum)
	Get the interface ID for a given VLAN. More...
open_error_t	openapiVrAddrConflictDetectStatusClear (openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
	Clear the Address Conflict Detection Status of a given VRF instance. More...
open_error_t	openapiVrAddrConflictDetectStatusGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_BOOL_t *conflictDetectStatus)
	Get the Address Conflict Detection Status of a VRF instance. More...
open_error_t	openapiVrAddrConflictLastDetectMACGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_buffdesc *conflictMAC)
	Get the MAC Address of the last detected address conflict in a VRF instance. More...
open_error_t	openapiVrAddrConflictLastDetectTimeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *conflictDetectTime)
	Get the time in seconds since the last address conflict was detected in a VRF instance. More...
open_error_t	openapiVrIpRouterPreferenceGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t origin, uint32_t *pref)
	Get the Router preference for the given protocol and VRF name. More...
open_error_t	openapiVrIpRouterPreferenceSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t origin, uint32_t pref)
	Set the Router preference for the given protocol and VRF name. More...

Detailed Description

Macro Definition Documentation

#define OPEN_FD_RTR_MAX_STATIC_ARP_ENTRIES   512

FD_RTR_MAX_STATIC_ARP_ENTRIES.

various ARP cache statistics (useful for 'show' functions, etc.)

Examples:

routing_example.c.

Definition at line 83 of file openapi_routing_config.h.

#define OPEN_INVALID_INTF   0

Invalid internal interface number.

Definition at line 82 of file openapi_routing_config.h.

Enumeration Type Documentation

enum OPEN_ARP_TYPES_t

Enumerator
OPEN_ARP_TYPE_LOCAL	IP address is one of switch's MAC addresses.
OPEN_ARP_TYPE_GATEWAY	Destination is a router.
OPEN_ARP_TYPE_RESOLVED	Resolved ARP entry, dest MAC address known.
OPEN_ARP_TYPE_NET_DIR_BCAST	Net directed broadcast addr.
OPEN_ARP_TYPE_DISCARD_WHEN_SOURCE	Discard when seen as source.
OPEN_ARP_TYPE_STATIC	Static ARP entry.
OPEN_ARP_TYPE_UNNUMBERED	Unnumbered intf ARP entry.
OPEN_ARP_TYPE_KERNEL	Kernel ARP entry.

Definition at line 96 of file openapi_routing_config.h.

enum OPEN_INTF_IP6_ADDR_MODE_t

Enumerator
OPEN_IP6_ADDR_MODE_LINK_LOCAL	IPv6 Link local address mode.
OPEN_IP6_ADDR_MODE_AUTOCONFIG	IPv6 Auto-config address mode.
OPEN_IP6_ADDR_MODE_DHCP	IPv6 DHCP address mode.

Definition at line 69 of file openapi_routing_config.h.

enum OPEN_INTF_IP_ADDR_TYPE_t

< Type of IP address.

Enumerator
OPEN_IP_ADDR_TYPE_STATIC_PRIMARY	Primary Static.
OPEN_IP_ADDR_TYPE_STATIC_SECONDARY	Primary Secondary.
OPEN_IP_ADDR_TYPE_DHCP	DHCP.

Definition at line 61 of file openapi_routing_config.h.

enum OPEN_INTF_URPF_MODE_s

Enumerator
OPEN_IPMAP_INTF_URPF_MODE_DISABLE	no uRPF
OPEN_IPMAP_INTF_URPF_MODE_LOOSE	Loose Mode uRPF.
OPEN_IPMAP_INTF_URPF_MODE_STRICT	Strict Mode uRPF.

Definition at line 152 of file openapi_routing_config.h.

Function Documentation

open_error_t openapiArpEntryAdd	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t	ipAddr,
		open_buffdesc *	mac_addr
	)

Add an ARP entry.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipAddr	IP address.
[in]	mac_addr	MAC address.
	-	Maximum value OPENAPI_L7_MAC_ADDR_LEN

Return values

OPEN_E_NONE	Entry added.
L7_ADDR_INUSE	Address is assigned to a local interface.
OPEN_E_PARAM	If an input parameter is invalid.
L7_TABLE_IS_FULL	Maximum static ARP entries already configured.
OPEN_E_FAIL	Any other failure.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiArpEntryDel	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t	ipAddr
	)

Delete an ARP entry.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipAddr	IP address.

Return values

OPEN_E_NONE	Entry deleted.
OPEN_E_NOT_FOUND	Could not find entry to delete.
OPEN_E_PARAM	If an input parameter is invalid.
OPEN_E_FAIL	Any other failure.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiArpEntryNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	intf,
		open_inet_addr_t *	ipAddr,
		open_buffdesc *	mac_addr
	)

Get the next ARP entry.

Parameters

[in]	client_handle	client handle from registration API
[in,out]	intf	Router Interface.
	-	Set this to 0 to get the first entry
[in,out]	ipAddr	IP address.
	-	Set this to 0 to get the first entry
[out]	mac_addr	MAC address.
	-	Maximum value OPENAPI_L7_MAC_ADDR_STRING_LEN

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	No more entries.
OPEN_E_PARAM	If an input parameter is invalid.

Note

The addr.ipv4 field of the ipAddr argument is returned by this function in network byte order. Values of this field passed as input must also be in network byte order as well. This violates the convention documented for open_inet_addr_t, which is to represent ipv4 addresses in the open_inet_addr type in host byte order.

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIfBandwidthGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	bandwidth
	)

Get the bandwidth of the specified interface.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIfBandwidthSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	bandwidth
	)

Set the bandwidth of the specified interface.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIfBWGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	bandwidth
	)

Get the bandwidth of the specified interface without making any modification to the SET bandwidth.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIntfEffectiveIpMtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	ipMtu
	)

Gets the IP MTU value being enforced on a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[out]	ipMtu	The effective IP MTU value

Return values

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

Note

If the IP MTU is not configured, it is derived from the link MTU.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIntfIPv4MtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	ipMtu
	)

Gets the configured IPv4 MTU value on the given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[out]	ipMtu	The ip mtu value

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIntfMaxIpMtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	maxIpMtu
	)

Get the maximum IP MTU that may be set on a given interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[out]	maxIpMtu	The maximum IP MTU value

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIPAddrToIntIf	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	ipAddr,
		uint32_t *	ifNum
	)

Get the internal interface number of the given VRF and IPv4 address.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	ipAddr	IP address of interest
[out]	ifNum	Internal interface number for the specified IP address

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpArpCacheStatsGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		open_arpCacheStats_t *	pStats
	)

Retrieve various ARP cache statistics.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	vrfName	VRF Name.
[out]	pStats	pointer to ARP cache statistics structure to be filled in.

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpEcmpIpsecSpiGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	spiMode
	)

Determines the current IP ECMP IPSEC SPI Mode.

Parameters

[in]	client_handle	Client handle from registration API
[out]	spiMode	Admin mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpEcmpIpsecSpiSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	spiMode
	)

Sets the current IP ECMP IPSEC SPI Hashing mode.

Parameters

[in]	client_handle	Client handle from registration API
[in]	spiMode	IPSEC SPI Mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpEcmpLbGet	(	openapiClientHandle_t *	client_handle,
		OPEN_IP_ECMP_LB_MODE_t *	lbMode
	)

Determines the current IP ECMP global load balancing mode.

Parameters

[in]	client_handle	Client handle from registration API
[out]	lbMode	Load balancing mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpEcmpLbSet	(	openapiClientHandle_t *	client_handle,
		OPEN_IP_ECMP_LB_MODE_t	lbMode
	)

Sets the current IP ECMP global load balancing mode.

Parameters

[in]	client_handle	Client handle from registration API
[in]	lbMode	Load balancing mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpHelperAddressAdd	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t	ipAddr,
		uint32_t	udpPort
	)

Adds IP Helper Address and UDP port number.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipAddr	Server IP address.
[in]	udpPort	UDP port from <1 - 65535>

Return values

OPEN_E_NONE	add successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_EXISTS	server address already configured.
OPEN_E_FULL	maximum entries already configured.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpHelperAddressDel	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t	ipAddr,
		uint32_t	udpPort
	)

Deletes IP Helper Address and UDP port number.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipAddr	Server IP address.
[in]	udpPort	UDP port from <1 - 65535>

Return values

OPEN_E_NONE	delete successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpHelperModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	ipHelperMode
	)

Enables/Disables IP Helper mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipHelperMode	IP helper mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpICMPEchoReplyModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	echoReplyMode
	)

Enables/Disables IP ICMP Echo Reply mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	echoReplyMode	IP ICMP Echo Reply mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpManagementInterfaceGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ifNum
	)

Get the configured IPv4 Management interface.

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 API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpManagementInterfaceParamsSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	dhcpEnabled,
		uint32_t	ipAddr,
		uint32_t	subnetMask
	)

Set the IPv4 Management interface and enable dhcp or configure static IP on the management interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[in]	dhcpEnabled	OPEN_TRUE or OPEN_FALSE
[in]	ipAddr	IP address
[in]	subnetMask	SubnetMask

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpManagementInterfaceSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Set the IPv4 Management interface.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapForwardingStatsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

Gets the packets forwarded by CPU.

Parameters

[in]	client_handle	Client handle from registration API
[out]	val	Number of packets forwarded by CPU

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Get the administrative mode of sending ICMP Unreachables.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Get the interface mode of sending ICMP Redirects.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapIntfUrpfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_INTF_URPF_MODE_t *	mode,
		OPEN_BOOL_t *	allowDefault
	)

Get the interface uRPF mode and allowDefault option.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number of interface for which to get the urpf mode
[out]	mode	Strict or loose or disabled as defined by OPEN_INTF_URPF_MODE_t
[out]	allowDefault	Should take default route into consideration or not

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapIntfUrpfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_INTF_URPF_MODE_t	mode,
		OPEN_BOOL_t	allowDefault
	)

Set the interface uRPF mode and allowDefault option.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number of interface for which to set the urpf mode
[in]	mode	Strict or loose or disabled as defined by OPEN_INTF_URPF_MODE_t
[in]	allowDefault	Should take default route into consideration or not

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapIpEvtDampGetDampParams	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	flaps,
		uint32_t *	penalty,
		uint32_t *	isSuppressed,
		uint32_t *	reuseTime,
		uint32_t *	maxPenalty
	)

Invokes the IPMAP API funciton to get the dampening operational values.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	flaps	Number of flaps after last reset
[out]	penalty	Maximum penalty of an interface
[out]	isSuppressed	Is interface suppressed or not
[out]	reuseTime	Reuse time of a suppressed interface
[out]	maxPenalty	Maximum penalty of an interface

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapIpPacketsReceivedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	val
	)

Get the IP packets count received by IP-Stack.

Parameters

[in]	client_handle	Client handle from registration API
[out]	val	The number of IP packets received by IP-Stack

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapProtoNextGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	protoId
	)

Get the next protocol ID by iterating through all registered protocols.

Parameters

[in]	client_handle	Client handle from registration API
[in,out]	protoId	Protocol ID. Set to 0 on input to get the first value. Set to previous value on input to get the next value.

Return values

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

Note

These are not returned in numeric order.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapResilientHashingModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	resHashMode
	)

Gets the global resilient hashing mode for ECMP trunks.

Parameters

[in]	client_handle	Client handle from registration API
[out]	resHashMode	Admin mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapResilientHashingModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	resHashMode
	)

Sets the global resilient hashing mode for ECMP trunks.

Parameters

[in]	client_handle	Client handle from registration API
[in]	resHashMode	Admin mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapRouteTypeToProtoId	(	openapiClientHandle_t *	client_handle,
		uint32_t	routeType,
		uint32_t *	protoId
	)

Get the protocol ID for a given route type.

Parameters

[in]	client_handle	Client handle from registration API
[in]	routeType	Route type
[out]	protoId	protocol ID for protocol that uses route type

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Get the administrative mode of sending ICMP Echo Replies.

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 API Version: 1.25

Examples:

routing_example.c.

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

Set ignore mode for ICMP ECHO Requests.

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 API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapRtrICMPRatelimitGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	burstSize,
		uint32_t *	interval
	)

Get the ICMP Rate Limiting parameters like burst size and interval.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	burstSize	Number of ICMP messages the IPMAP is allowed per interval
[out]	interval	The time interval between tokens being placed in the bucket

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapRtrICMPRatelimitSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	burstSize,
		uint32_t	interval
	)

Set the ICMP Rate Limiting parameters like burst size and interval.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	burstSize	Number of ICMP messages the IPMAP is allowed per interval
[in]	interval	The time interval between tokens being placed in the bucket

Return values

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

Note

To disable ICMP rate limiting, set the interval to zero.

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Get the administrative mode of sending ICMP Redirects.

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 API Version: 1.25

Examples:

routing_example.c.

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

Set the administrative mode of sending ICMP Redirects.

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 API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapRtrIntfVrfReset	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Unset the VRF participation on an interface.

Parameters

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

Return values

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

Note

This function removes the participation of an interface from its current VRF and restores it to default router. If the interface is already part of the default router, nothing is done.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapRtrIntfVrfSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	vrfName,
		OPEN_VRF_SET_ERROR_t *	vrfSetError
	)

Set the VRF participation of an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	vrfName	VRF name
[out]	vrfSetError	VRF Error message

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Invalid argument.
OPEN_E_ERROR	Subnet conflict between interface IP address and IP address in the virtual router.
OPEN_E_FULL	Unable to add connected route as RTO is FULL.
OPEN_E_INTERNAL	Earlier operation on the interface is in progress. Try again later.
OPEN_E_FAIL	On failures due to errors mentioned in vrfSetError.
OPEN_E_NOT_FOUND	On any other failure.

Note

Assumes vrfName is OPEN_VRF_MAX_NAME_LEN+1 long.

OPEN_VRF_SET_ERROR_t has the following error-codes and corresponding meaning: OPEN_LOOPBACK_ERROR Loopback interface is used by unnumbered interface and so cannot be part of non-default VRF. OPEN_UNNUMBERED_ERROR Unnumbered interface cannot be part of a non-default VRF. OPEN_SYSLOG_ERROR This routing interface is being used as a syslog source interface, cannot be part of non-default VRF. OPEN_IPV6_ERROR This routing interface has IPv6 address config, cannot be part of non-default VRF.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapStaticArpAdd	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		open_inet_addr_t	ipAddress,
		uint32_t	intIfNum,
		open_buffdesc *	macAddrBuf
	)

Add a static ARP entry of a given VRF instance.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	vrfName	VRF Name.
[in]	ipAddress	IP Address of the entry to be added
[in]	intIfNum	Internal interface number of the entry. OPEN_INVALID_INTF(0) if interface is not configured.
[in]	macAddrBuf	MAC Address

Return values

OPEN_E_NONE	On success. Entry added.
OPEN_E_PARAM	Invalid argument.
OPEN_E_FULL	Maximum static ARP entries already configured.
OPEN_E_EXISTS	Address is assigned to a local interface.
OPEN_E_INTERNAL	If there is not yet a router interface in the same subnet as the target. Config is applied in this case.
OPEN_E_UNAVAIL	Address can neither be network directed broadcast nor subnet address
OPEN_E_FAIL	Any other failure.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapStaticArpDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		open_inet_addr_t	ipAddress,
		uint32_t	intIfNum
	)

Delete a static ARP entry of a given VRF instance.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	vrfName	VRF Name.
[in]	ipAddress	IP Address of the entry to be deleted
[in]	intIfNum	Internal interface number of the entry. OPEN_INVALID_INTF(0) if interface is not configured.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_NOT_FOUND	If entry is not found.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapSystemUrpfModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	urpfEnabled
	)

Get the System mode for uRPF.

Parameters

[in]	client_handle	Client handle from registration API
[out]	urpfEnabled	OPEN_ENABLE or OPEN_DISABLE

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpMapSystemUrpfModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	urpfEnabled
	)

Set the System mode for uRPF.

Parameters

[in]	client_handle	Client handle from registration API
[in]	urpfEnabled	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.25

Examples:

routing_example.c.

open_error_t openapiIpMapValidIntfFirstGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ifNum
	)

Get the first valid interface.

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 API Version: 1.25

Examples:

routing_example.c.

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

Get the next valid interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	prevIfNum	Internal interface number
[out]	ifNum	Internal interface number of next valid interface

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Determine whether an interface is configured to forward multicast packets.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[out]	mode	Forwarding admin mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpNetDirectBcastsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	adminMode
	)

Gets the admin mode for IP forwarding of net-directed broadcasts.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[out]	adminMode	Forwarding admin mode

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpNetPrototypeRoutesDelete	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	protoId
	)

Delete all net-prototype route entries.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	protoId	Protocol Id

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpRedirectsModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	redirectsMode
	)

Enables/Disables generation of IP Redirects messages.

Parameters

[in]	client_handle	client handle from registration API
[in]	redirectsMode	Redirects mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	other internal error.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpRouteAdd	(	openapiClientHandle_t *	client_handle,
		OPEN_AF_t	af,
		open_inet_pfx_t *	ipAddr,
		open_inet_addr_t *	nextHop,
		uint32_t	rtPref,
		uint32_t	intf,
		OPEN_MPLS_LABELS_t *	mpls
	)

Add an IP Route for a given address family.

Parameters

[in]	client_handle	client handle from registration API
[in]	af	Address Family (IPv4 or IPv6)
[in]	ipAddr	IP address and prefix length.
[in]	nextHop	Next Hop
[in]	rtPref	Route preference
[in]	intf	Router Interface
[in]	mpls	List of MPLS labels associated with this route

Return values

OPEN_E_NONE	add successful
OPEN_E_PARAM	if an input parameter is invalid
OPEN_E_UNAVAIL	invalid router interface
OPEN_E_FULL	maximum number of IP Addresses already assigned
OPEN_E_EXISTS	address already assigned
OPEN_E_FAIL	for any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpRouteDel	(	openapiClientHandle_t *	client_handle,
		OPEN_AF_t	af,
		open_inet_pfx_t *	ipAddr,
		open_inet_addr_t *	nextHop,
		uint32_t	intf,
		OPEN_MPLS_LABELS_t *	mpls
	)

Delete an IP Route for a given address family.

Parameters

[in]	client_handle	client handle from registration API
[in]	af	Address Family (IPv4 or IPv6)
[in]	ipAddr	IP address and prefix length.
[in]	nextHop	Next Hop
[in]	intf	Router Interface

Return values

OPEN_E_NONE	delete successful
OPEN_E_PARAM	if an input parameter is invalid
OPEN_E_UNAVAIL	invalid router interface
OPEN_E_NOT_FOUND	address not found
OPEN_E_FAIL	for any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiIpRtrInternalVlanIdToIntIfNum	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	ifNum
	)

Get the internal interface number associated with the port-based routing interface corresponding to this internal VLAN.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vlanId	Id of the VLAN
[out]	ifNum	Internal interface number of port-based routing interface

Return values

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

Note

Cannot be used to find the intIfNum for a VLAN ID used for a VLAN routing interface.

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Get the mode of AutoState feature of an interface.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Enable or disable the mode of AutoState feature of an interface.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Gets the router interface mode.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

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

Determine whether a given IP interface is up for IPv4.

Parameters

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

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpUnnumberedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	isUnnumbered,
		uint32_t *	numberedIfc
	)

Determine whether a given interface is unnumbered and if it is, determine the interface whose address the unnumbered interface borrows.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Internal interface number
[out]	isUnnumbered	OPEN_TRUE or OPEN_FALSE
[out]	numberedIfc	Internal interface number of the numbered interface

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpUnnumberedSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	isUnnumbered,
		uint32_t	numberedIfc
	)

Set the unnumbered status of an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[in]	isUnnumbered	OPEN_TRUE or OPEN_FALSE
[in]	numberedIfc	Internal interface number of the numbered interface whose IP address the unnumbered interface is to borrow

Return values

OPEN_E_EXISTS	If the interface has IP address is already configured
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Fails if an address is already configured on the interface.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpVlanRtrIntIfNumToVlanId	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	vlanId
	)

Get the VLAN ID corresponding to the given internal interface number.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number
[out]	vlanId	VLAN ID

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiIpVlanRtrVlanIdGetNext	(	openapiClientHandle_t *	client_handle,
		uint32_t *	vlanId
	)

Get the next vlan after this vlan on which routing is enabled.

Parameters

[in]	client_handle	Client handle from registration API
[in,out]	vlanId	The id of the VLAN

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_AF_t	af,
		OPEN_CONTROL_t	routingMode
	)

Enables/Disables IP Routing Admin mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	af	Address Family (IPv4 or IPv6)
[in]	routingMode	Routing mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_FAIL	set failed.
OPEN_E_PARAM	Error in parameter passed.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrArpSwitchClear

(

openapiClientHandle_t *

client_handle

)

Clear the switch/management ARP entries.

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

Examples:

routing_example.c.

open_error_t openapiRtrGratArpSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	gratArpState
	)

Enable or disable gratuitous ARP on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	intIfNum	Internal interface number
[in]	gratArpState	Grat ARP mode (OPEN_ENABLE/OPEN_DISABLE)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpAddrAdd	(	openapiClientHandle_t *	client_handle,
		OPEN_AF_t	af,
		uint32_t	intf,
		OPEN_INTF_IP_ADDR_TYPE_t	addrType,
		open_inet_pfx_t *	ipAddr,
		OPEN_CONTROL_t	extArg
	)

Add an IP address on a given router interface for a given address family.

Parameters

[in]	client_handle	client handle from registration API
[in]	af	Address Family (IPv4 or IPv6)
[in]	intf	A routing interface ID
[in]	addrType	Address Type
[in]	ipAddr	IP address and prefix length. This argument is not applicable when addrType of DHCP is used.
[in]	extArg	If used for Address Family IPv4: Enable the DHCP client to specify the unique client Id Option 61. If used for Address Family IPv6: Enable use of eui-64 Interface Identifier.

Return values

OPEN_E_NONE	add successful
OPEN_E_PARAM	if an input parameter is invalid
OPEN_E_UNAVAIL	invalid router interface
OPEN_E_FULL	maximum number of IP Addresses already assigned
OPEN_E_EXISTS	address already assigned
OPEN_E_FAIL	for any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpAddrDel	(	openapiClientHandle_t *	client_handle,
		OPEN_AF_t	af,
		uint32_t	intf,
		OPEN_INTF_IP_ADDR_TYPE_t	addrType,
		open_inet_pfx_t *	ipAddr,
		OPEN_CONTROL_t	extArg
	)

Delete an IP address on a given router interface for a given address family.

Parameters

[in]	client_handle	client handle from registration API
[in]	af	Address Family (IPv4 or IPv6)
[in]	intf	A routing interface ID
[in]	addrType	Address Type
[in]	ipAddr	IP address and prefix length. This argument is not applicable when addrType of DHCP is used. Passing NULL with Address Type as OPEN_IP_ADDR_TYPE_STATIC_PRIMARY of OPEN_IP_ADDR_TYPE_STATIC_SECONDARY will delete all configured addresses on the interface.
[in]	extArg	If used for Address Family IPv4: Enable the DHCP client to specify the unique client Id Option 61. If used for Address Family IPv6: Enable use of eui-64 Interface Identifier.

Return values

OPEN_E_NONE	delete successful
OPEN_E_PARAM	if an input parameter is invalid
OPEN_E_FAIL	for any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpDestUnreachableModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		OPEN_CONTROL_t	unreachableMode
	)

Enables/Disables generation of IP Destination Unreachable messages on a Router interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	unreachableMode	Unreachable mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpHelperAddressAdd	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		open_inet_addr_t	ipAddr,
		uint32_t	udpPort
	)

Adds IP Helper Address and UDP port number on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	ipAddr	Server IP address.
[in]	udpPort	UDP port from <1 - 65535>

Return values

OPEN_E_NONE	add successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpHelperAddressDel	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		open_inet_addr_t	ipAddr,
		uint32_t	udpPort
	)

Deletes IP Helper Address and UDP port number on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	ipAddr	Server IP address. Use 0 to delete all global entries
[in]	udpPort	UDP port from <1 - 65535>

Return values

OPEN_E_NONE	delete successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpHelperDiscardAdd	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		uint32_t	udpPort
	)

Adds IP Helper Discard entry in an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	udpPort	UDP port from <1 - 65535>

Return values

OPEN_E_NONE	add successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpHelperDiscardDel	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		uint32_t	udpPort
	)

Deletes IP Helper Discard entry in an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	udpPort	UDP port from <1 - 65535>

Return values

OPEN_E_NONE	delete successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpNetDirBroadcastModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		OPEN_CONTROL_t	ipNetBroadcastMode
	)

Enables/Disables forwarding of Network-directed broadcast on a Router Interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	ipNetBroadcastMode	IP Network-directed broadcast mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpProxyArpModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	ipProxyArpMode
	)

Determine whether proxy ARP is enabled on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	intIfNum	Internal interface number
[out]	ipProxyArpMode	IP Proxy ARP mode (OPEN_ENABLE/OPEN_DISABLE)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpProxyArpModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		OPEN_CONTROL_t	ipProxyArpMode
	)

Enables/Disables IP Proxy ARP mode on a Router Interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	ipProxyArpMode	IP Proxy ARP mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure
OPEN_E_UNAVAIL	If not supported.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpRedirectsModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		OPEN_CONTROL_t	redirectsMode
	)

Enables/Disables generation of IP Redirects messages on a Router interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	redirectsMode	Redirects mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfIpv6AddressModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		OPEN_INTF_IP6_ADDR_MODE_t	addrMode,
		OPEN_BOOL_t	setFlag
	)

Set or reset the IPv6 address mode on a given router interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	A routing interface ID
[in]	addrMode	Address mode
[in]	setFlag	Set flag (OPEN_TRUE for set or OPEN_FALSE for reset)

Return values

OPEN_E_NONE	On successful set or reset of the address mode
OPEN_E_PARAM	If an input parameter is invalid
OPEN_E_UNAVAIL	Feature not supported
OPEN_E_FAIL	For any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIntfMTUSet	(	openapiClientHandle_t *	client_handle,
		OPEN_AF_t	af,
		uint32_t	intf,
		uint32_t	MTU
	)

Configures Router Interface MTU.

Parameters

[in]	client_handle	client handle from registration API
[in]	af	Address Family (IPv4 or IPv6)
[in]	intf	Router Interface
[in]	MTU	MTU

Return values

OPEN_E_NONE	set successful.
OPEN_E_UNAVAIL	interface not valid for routing.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIntfRtrAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intf,
		OPEN_CONTROL_t	routingMode
	)

Enables/Disables IP Routing mode (both v4 and v6) on a Router interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intf	Router Interface
[in]	routingMode	Routing mode

Return values

OPEN_E_NONE	set successful.
OPEN_E_PARAM	error in parameter passed.
OPEN_E_FAIL	any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrIpArpAgeTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	timeout
	)

Sets the ARP entry ageout time.

Parameters

[in]	client_handle	Client handle from registration API
[in]	timeout	ARP entry ageout time (in seconds)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpCacheClear	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_BOOL_t	gateway
	)

Clears the ARP cache of all dynamic/gateway entries.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF Name in Bufdescriptor format
[in]	gateway	flag to clear gateway entries as well

Return values

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

Note

All dynamic entries currently in the ARP cache are cleared. The gateway entries are conditionally cleared based on the value of the gateway parm. No local/static entries are affected.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpCacheSizeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	cacheSize
	)

Sets the maximum number of entries in the ARP cache.

Parameters

[in]	client_handle	Client handle from registration API
[in]	cacheSize	ARP cache entries max

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpDynamicRenewGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	dynRenewMode
	)

Returns the ARP dynamic entry renew mode.

Parameters

[in]	client_handle	Client handle from registration API
[out]	dynRenewMode	ARP dynamic entry renew mode (OPEN_ENABLE/OPEN_DISABLE)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpDynamicRenewSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	dynRenewMode
	)

Enable or disable the ARP dynamic entry renew mode.

Parameters

[in]	client_handle	Client handle from registration API
[in]	dynRenewMode	ARP dynamic entry renew mode (OPEN_ENABLE/OPEN_DISABLE)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpEntryPurge	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		open_inet_addr_t	ipAddr,
		uint32_t	intIfNum
	)

Purges a specific dynamic/gateway entry from the ARP cache.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF Name
[in]	ipAddr	IP address of the ARP entry to purge
[in]	intIfNum	Internal interface number of the entry OPEN_INVALID_INTF(0) if interface not configured

Return values

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

Note

Does not support deleting local/static ARP entries, as there are other APIs for handling those.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpRespTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	timeout
	)

Sets the ARP request response timeout.

Parameters

[in]	client_handle	Client handle from registration API
[in]	timeout	ARP request response timeout (in seconds)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpArpRetriesSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	count
	)

Sets the ARP request max retries count.

Parameters

[in]	client_handle	Client handle from registration API
[in]	count	ARP request max retries count

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpMapStaticArpGetAll	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_ARP_STATIC_ALL_t *	openArpEntries
	)

Get a list of all static ARP entries currently configured.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	vrfName	VRF Name.
[out]	openArpEntries	A data-structure containing an array of max ARP entries. On return, the array is filled with the static ARP entries. The first entry with an IP address of 0 indicates the end of the list.

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpUnnumberedGratArpGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t *	isEnabled
	)

Get the behavior of gratuitous ARP received on unnumbered interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	intIfNum	Internal interface number
[out]	isEnabled	Grat ARP mode flag (OPEN_TRUE or OPEN_FALSE) OPEN_TRUE: install interface route to unnumebred peer on receiving grat ARP OPEN_FALSE: don't install any interface route

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrIpUnnumberedGratArpSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_BOOL_t	isEnabled
	)

Set the behavior of gratuitous ARP received on unnumbered interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	intIfNum	Internal interface number
[in]	isEnabled	Grat ARP mode flag (OPEN_TRUE or OPEN_FALSE) OPEN_TRUE: install interface route to unnumebred peer on receiving grat ARP OPEN_FALSE: don't install any interface route

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrLocalProxyArpModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t *	localProxyArpMode
	)

Determine whether local proxy ARP is enabled on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	intIfNum	Internal interface number
[out]	localProxyArpMode	Local Proxy ARP mode (OPEN_ENABLE/OPEN_DISABLE)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrLocalProxyArpModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		OPEN_CONTROL_t	localProxyArpMode
	)

Enable or disable local proxy ARP on an interface.

Parameters

[in]	client_handle	Client handle from registration API
[in]	intIfNum	Internal interface number
[in]	localProxyArpMode	Local Proxy ARP mode (OPEN_ENABLE/OPEN_DISABLE)

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrRouteMaxEqualCostEntriesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxhops
	)

Get the routing max equal cost entries.

Parameters

[in]	client_handle	Client handle from registration API
[out]	maxhops	maxhops value

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrRouteMaxRouteEntriesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxroutes
	)

Get the routing max routes entries.

Parameters

[in]	client_handle	Client handle from registration API
[out]	maxroutes	max routes value

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiRtrVlanIntfCreate	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId
	)

Create a VLAN Routing Interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN ID

Return values

OPEN_E_NONE	create successful
OPEN_E_PARAM	if an input parameter is invalid
OPEN_E_EXISTS	VLAN ID already in use for port based routing
OPEN_E_FULL	maximum number of Routing VLANs already configured
OPEN_E_NOT_FOUND	dependency not met
OPEN_E_FAIL	for any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrVlanIntfDelete	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId
	)

Delete a VLAN Routing Interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN ID

Return values

OPEN_E_NONE	delete successful
OPEN_E_PARAM	if an input parameter is invalid
OPEN_E_NOT_FOUND	VLAN routing interface does not exist
OPEN_E_FAIL	for any other failure

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.1

Examples:

routing_example.c.

open_error_t openapiRtrVlanIntfIfNumGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	intf
	)

Get the interface number for a VLAN Routing Interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	vlanId	VLAN ID
[out]	intf	Interface number if call successful

Return values

OPEN_E_NONE	success, intf contains the interface number
OPEN_E_PARAM	an input parameter is invalid
OPEN_E_NOT_FOUND	interface number could not be found for VLAN.
OPEN_E_FAIL	a failure occurred

OpEN API Version: 1.17

Examples:

routing_example.c.

open_error_t openapiSourceInterfacesGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ifNum
	)

Get source IP interface from Syslog, SNMP Traps, SNTP, DNS Client, RADIUS, TACACS+ and sFlow apps.

Parameters

[in]	client_handle	Client handle from registration API
[out]	ifNum	Internal interface number of the source interface

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure. Source interfaces are different.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Can't receive one of source interfaces
OPEN_E_NOT_FOUND	Feature unsupported

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiSourceInterfacesSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Set source IP interface for Syslog, SNMP Traps, SNTP, DNS Client, RADIUS, TACACS+ and sFlow apps.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal interface number for setting as source interface

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVlanIntfIdGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	vlanId,
		uint32_t *	ifNum
	)

Get the interface ID for a given VLAN.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vlanId	VLAN ID
[out]	ifNum	Interface ID (not internal interface number)

Return values

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

Note

The interface ID is an internally assigned integer in the range [1, L7_MAX_NUM_VLAN_INTF].

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVrAddrConflictDetectStatusClear	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName
	)

Clear the Address Conflict Detection Status of a given VRF instance.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVrAddrConflictDetectStatusGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		OPEN_BOOL_t *	conflictDetectStatus
	)

Get the Address Conflict Detection Status of a VRF instance.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	conflictDetectStatus	OPEN_TRUE or OPEN_FALSE

Return values

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

Note

Status would be returned as OPEN_TRUE if there was at least one conflict detected since last reset of the status. Else status is returned as OPEN_FALSE.

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVrAddrConflictLastDetectMACGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		open_buffdesc *	conflictMAC
	)

Get the MAC Address of the last detected address conflict in a VRF instance.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	conflictMAC	MAC of last detected conflicting host

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVrAddrConflictLastDetectTimeGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t *	conflictDetectTime
	)

Get the time in seconds since the last address conflict was detected in a VRF instance.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[out]	conflictDetectTime	Time since the last detected conflict

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVrIpRouterPreferenceGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	origin,
		uint32_t *	pref
	)

Get the Router preference for the given protocol and VRF name.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	origin	Router protocol type
[out]	pref	Preference associated with the protocol

Return values

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

OpEN API Version: 1.25

Examples:

routing_example.c.

open_error_t openapiVrIpRouterPreferenceSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	vrfName,
		uint32_t	origin,
		uint32_t	pref
	)

Set the Router preference for the given protocol and VRF name.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name
[in]	origin	Router protocol type (one of L7_RTO_PROTOCOL_INDICES_t)
[in]	pref	Preference associated with the protocol

Return values

OPEN_E_UNAVAIL	Preference value is in use by another protocol
OPEN_E_ERROR	Invalid preference change
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

routing_example.c.