Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
Routing Configuration And Status [OPENAPI_ROUTING_CONFIG]

Macros

#define OPEN_DEFAULT_VRF_NAME   ""
 Default VRF name.
 
#define OPEN_VRF_MAX_NAME_LEN   64
 largest allowable VRF name
 
#define OPEN_VRF_MIN_NAME_LEN   0
 smallest allowable VRF name
 

Enumerations

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

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 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 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 openapiRtrAdminModeSet (openapiClientHandle_t *client_handle, OPEN_AF_t af, OPEN_CONTROL_t routingMode)
 Enables/Disables IP Routing Admin mode. 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 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 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 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...
 

Detailed Description

Enumeration Type Documentation

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.

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_handleclient handle from registration API
[in]ipAddrIP address.
[in]mac_addrMAC address.
-Maximum value OPENAPI_L7_MAC_ADDR_LEN
Return values
OPEN_E_NONEEntry added.
L7_ADDR_INUSEAddress is assigned to a local interface.
OPEN_E_PARAMIf an input parameter is invalid.
L7_TABLE_IS_FULLMaximum static ARP entries already configured.
OPEN_E_FAILAny 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_handleclient handle from registration API
[in]ipAddrIP address.
Return values
OPEN_E_NONEEntry deleted.
OPEN_E_NOT_FOUNDCould not find entry to delete.
OPEN_E_PARAMIf an input parameter is invalid.
OPEN_E_FAILAny 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_handleclient handle from registration API
[in,out]intfRouter Interface.
-Set this to 0 to get the first entry
[in,out]ipAddrIP address.
-Set this to 0 to get the first entry
[out]mac_addrMAC address.
-Maximum value OPENAPI_L7_MAC_ADDR_STRING_LEN
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILNo more entries.
OPEN_E_PARAMIf 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 openapiIpHelperAddressAdd ( openapiClientHandle_t client_handle,
open_inet_addr_t  ipAddr,
uint32_t  udpPort 
)

Adds IP Helper Address and UDP port number.

Parameters
[in]client_handleclient handle from registration API
[in]ipAddrServer IP address.
[in]udpPortUDP port from <1 - 65535>
Return values
OPEN_E_NONEadd successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_EXISTSserver address already configured.
OPEN_E_FULLmaximum entries already configured.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]ipAddrServer IP address.
[in]udpPortUDP port from <1 - 65535>
Return values
OPEN_E_NONEdelete successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]ipHelperModeIP helper mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]echoReplyModeIP ICMP Echo Reply mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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 openapiIpRedirectsModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  redirectsMode 
)

Enables/Disables generation of IP Redirects messages.

Parameters
[in]client_handleclient handle from registration API
[in]redirectsModeRedirects mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILother 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_handleclient handle from registration API
[in]afAddress Family (IPv4 or IPv6)
[in]ipAddrIP address and prefix length.
[in]nextHopNext Hop
[in]rtPrefRoute preference
[in]intfRouter Interface
[in]mplsList of MPLS labels associated with this route
Return values
OPEN_E_NONEadd successful
OPEN_E_PARAMif an input parameter is invalid
OPEN_E_UNAVAILinvalid router interface
OPEN_E_FULLmaximum number of IP Addresses already assigned
OPEN_E_EXISTSaddress already assigned
OPEN_E_FAILfor 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_handleclient handle from registration API
[in]afAddress Family (IPv4 or IPv6)
[in]ipAddrIP address and prefix length.
[in]nextHopNext Hop
[in]intfRouter Interface
Return values
OPEN_E_NONEdelete successful
OPEN_E_PARAMif an input parameter is invalid
OPEN_E_UNAVAILinvalid router interface
OPEN_E_NOT_FOUNDaddress not found
OPEN_E_FAILfor 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 openapiRtrAdminModeSet ( openapiClientHandle_t client_handle,
OPEN_AF_t  af,
OPEN_CONTROL_t  routingMode 
)

Enables/Disables IP Routing Admin mode.

Parameters
[in]client_handleclient handle from registration API
[in]afAddress Family (IPv4 or IPv6)
[in]routingModeRouting mode
Return values
OPEN_E_NONEset successful.
OPEN_E_FAILset failed.
OPEN_E_PARAMError 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 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_handleclient handle from registration API
[in]afAddress Family (IPv4 or IPv6)
[in]intfA routing interface ID
[in]addrTypeAddress Type
[in]ipAddrIP address and prefix length. This argument is not applicable when addrType of DHCP is used.
[in]extArgIf 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_NONEadd successful
OPEN_E_PARAMif an input parameter is invalid
OPEN_E_UNAVAILinvalid router interface
OPEN_E_FULLmaximum number of IP Addresses already assigned
OPEN_E_EXISTSaddress already assigned
OPEN_E_FAILfor 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_handleclient handle from registration API
[in]afAddress Family (IPv4 or IPv6)
[in]intfA routing interface ID
[in]addrTypeAddress Type
[in]ipAddrIP 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]extArgIf 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_NONEdelete successful
OPEN_E_PARAMif an input parameter is invalid
OPEN_E_FAILfor 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_handleclient handle from registration API
[in]intfRouter Interface
[in]unreachableModeUnreachable mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]intfRouter Interface
[in]ipAddrServer IP address.
[in]udpPortUDP port from <1 - 65535>
Return values
OPEN_E_NONEadd successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]intfRouter Interface
[in]ipAddrServer IP address. Use 0 to delete all global entries
[in]udpPortUDP port from <1 - 65535>
Return values
OPEN_E_NONEdelete successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]intfRouter Interface
[in]udpPortUDP port from <1 - 65535>
Return values
OPEN_E_NONEadd successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]intfRouter Interface
[in]udpPortUDP port from <1 - 65535>
Return values
OPEN_E_NONEdelete successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]intfRouter Interface
[in]ipNetBroadcastModeIP Network-directed broadcast mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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 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_handleclient handle from registration API
[in]intfRouter Interface
[in]ipProxyArpModeIP Proxy Arp mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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 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_handleclient handle from registration API
[in]intfRouter Interface
[in]redirectsModeRedirects mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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 openapiRtrIntfMTUSet ( openapiClientHandle_t client_handle,
OPEN_AF_t  af,
uint32_t  intf,
uint32_t  MTU 
)

Configures Router Interface MTU.

Parameters
[in]client_handleclient handle from registration API
[in]afAddress Family (IPv4 or IPv6)
[in]intfRouter Interface
[in]MTUMTU
Return values
OPEN_E_NONEset successful.
OPEN_E_UNAVAILinterface not valid for routing.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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_handleclient handle from registration API
[in]intfRouter Interface
[in]routingModeRouting mode
Return values
OPEN_E_NONEset successful.
OPEN_E_PARAMerror in parameter passed.
OPEN_E_FAILany 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 openapiRtrVlanIntfCreate ( openapiClientHandle_t client_handle,
uint32_t  vlanId 
)

Create a VLAN Routing Interface.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
Return values
OPEN_E_NONEcreate successful
OPEN_E_PARAMif an input parameter is invalid
OPEN_E_EXISTSVLAN ID already in use for port based routing
OPEN_E_FULLmaximum number of Routing VLANs already configured
OPEN_E_NOT_FOUNDdependency not met
OPEN_E_FAILfor 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_handleclient handle from registration API
[in]vlanIdVLAN ID
Return values
OPEN_E_NONEdelete successful
OPEN_E_PARAMif an input parameter is invalid
OPEN_E_NOT_FOUNDVLAN routing interface does not exist
OPEN_E_FAILfor 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_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]intfInterface number if call successful
Return values
OPEN_E_NONEsuccess, intf contains the interface number
OPEN_E_PARAMan input parameter is invalid
OPEN_E_NOT_FOUNDinterface number could not be found for VLAN.
OPEN_E_FAILa failure occurred

OpEN API Version: 1.17

Examples:
routing_example.c.