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.

open_error_t	openapiArpEntryDel (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr)
	Delete an ARP entry.

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.

open_error_t	openapiIpHelperAddressAdd (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr, uint32_t udpPort)
	Adds IP Helper Address and UDP port number.

open_error_t	openapiIpHelperAddressDel (openapiClientHandle_t *client_handle, open_inet_addr_t ipAddr, uint32_t udpPort)
	Deletes IP Helper Address and UDP port number.

open_error_t	openapiIpHelperModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t ipHelperMode)
	Enables/Disables IP Helper mode.

open_error_t	openapiIpICMPEchoReplyModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t echoReplyMode)
	Enables/Disables IP ICMP Echo Reply mode.

open_error_t	openapiIpRedirectsModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t redirectsMode)
	Enables/Disables generation of IP Redirects messages.

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.

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.

open_error_t	openapiRtrAdminModeSet (openapiClientHandle_t *client_handle, OPEN_AF_t af, OPEN_CONTROL_t routingMode)
	Enables/Disables IP Routing Admin mode.

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.

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.

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.

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.

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.

open_error_t	openapiRtrIntfIpHelperDiscardAdd (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t udpPort)
	Adds IP Helper Discard entry in an interface.

open_error_t	openapiRtrIntfIpHelperDiscardDel (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t udpPort)
	Deletes IP Helper Discard entry in an interface.

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.

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.

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.

open_error_t	openapiRtrIntfMTUSet (openapiClientHandle_t *client_handle, OPEN_AF_t af, uint32_t intf, uint32_t MTU)
	Configures Router Interface MTU.

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.

open_error_t	openapiRtrVlanIntfCreate (openapiClientHandle_t *client_handle, uint32_t vlanId)
	Create a VLAN Routing Interface.

open_error_t	openapiRtrVlanIntfDelete (openapiClientHandle_t *client_handle, uint32_t vlanId)
	Delete a VLAN Routing Interface.

open_error_t	openapiRtrVlanIntfIfNumGet (openapiClientHandle_t client_handle, uint32_t vlanId, uint32_t intf)
	Get the interface number for a VLAN Routing Interface.

Detailed Description

Enumeration Type Documentation

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.

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

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

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation