openapi_l2ol3tunnel.h File Reference

#include "openapi_common.h"

Go to the source code of this file.

Data Structures
struct	open_l2ol3AccessPortInfo_t
	Access Port Entry Information. More...
struct	open_l2ol3ErrorStats_t
	Overlay Failure Statistics Information. More...
struct	open_l2ol3L2FwdEntry_t
	Tenant Forwarding Entry Information. More...
struct	open_l2ol3ResourceLimits_t
	Overlay Global Resource Limits. More...
struct	open_l2ol3ResourceStats_t
	Overlay Global Statistics Information. More...
struct	open_l2ol3TenantConfig_t
	Tenant Configuration Information. More...
struct	open_l2ol3TunnelInfo_t
	Tunnel Port Entry Information. More...
struct	open_l2ol3TunnelStats_t
	Tunnel Counters Information. More...
struct	open_l2ol3TunnelStatus_t
	Tunnel Status Information. More...

Macros
#define	OPEN_L2OL3_TENANT_ID_MAX   (0xFFFFFE)
	Maximum value allowed for VXLAN VNID or NVGRE VSID.
#define	OPEN_L2OL3_TENANT_ID_MIN   (1)
	Minimum value allowed for VXLAN VNID or NVGRE VSID.
#define	OPEN_L2OL3_TENANT_ID_RESERVED   (0xFFFFFF)
	This is reserved ID and used for internal purposes.
#define	OPEN_L2OL3_TUNNEL_VXLAN_UDP_PORT   (4789)
	Default: UDP port used by VXLAN in IPv4 UDP header.

Enumerations
enum	OPEN_L2OL3_ACCESS_MATCH_t { OPEN_L2OL3_ACCESS_MATCH_PORT = 1, OPEN_L2OL3_ACCESS_MATCH_PORT_VLAN = 2 }
	Tenant Access Port Classification Types. More...
enum	OPEN_L2OL3_CONFIG_t { OPEN_L2OL3_CONFIG_CREATE = 1, OPEN_L2OL3_CONFIG_UPDATE = 2 }
	Overlay Configuration Methods. More...
enum	OPEN_L2OL3_REASON_t { OPEN_L2OL3_REASON_INVALID = 0, OPEN_L2OL3_REASON_INITIATOR_NOT_RESOLVED = 1, OPEN_L2OL3_REASON_INITIATOR_FAILED = 2, OPEN_L2OL3_REASON_TERMINATOR_FAILED = 4 }
	Tunnel Status Reason Codes. More...
enum	OPEN_L2OL3_TUNNEL_TYPE_t { OPEN_L2OL3_TUNNEL_TYPE_INVALID = 0, OPEN_L2OL3_TUNNEL_TYPE_VXLAN = 2, OPEN_L2OL3_TUNNEL_TYPE_NVGRE = 4 }
	Overlay Types. More...

Functions
open_error_t	openapiL2oL3AccessPortGet (openapiClientHandle_t *client_handle, uint32_t accessPortHandle, open_l2ol3AccessPortInfo_t *accessPortInfo)
	Gets access port information from the specified access port handle.
open_error_t	openapiL2oL3AccessPortNextGet (openapiClientHandle_t *client_handle, uint32_t accessPortHandle, open_l2ol3AccessPortInfo_t *accessPortNextInfo)
	Gets next access port entry for the next numerically higher access port handle after the specified access port handle.
open_error_t	openapiL2oL3ResourceLimitsGet (openapiClientHandle_t *client_handle, open_l2ol3ResourceLimits_t *resourceLimits)
	Get Overlay configuration maximum allowed limits.
open_error_t	openapiL2oL3ResourceStatsGet (openapiClientHandle_t *client_handle, open_l2ol3ResourceStats_t *resourceStats)
	Get Overlay global statistics.
open_error_t	openapiL2oL3SwitchTunnelModeGet (openapiClientHandle_t *client_handle, OPEN_L2OL3_TUNNEL_TYPE_t tunnelType, OPEN_CONTROL_t *mode)
	Gets the mode of the specified Overlay type.
open_error_t	openapiL2oL3SwitchTunnelModeSet (openapiClientHandle_t *client_handle, OPEN_L2OL3_TUNNEL_TYPE_t tunnelType, OPEN_CONTROL_t mode)
	Set the switch mode for the specified type of Overlay functionality.
open_error_t	openapiL2oL3SwitchVxlanUdpDestPortGet (openapiClientHandle_t *client_handle, uint32_t *udpDestPort)
	Gets VXLAN UDP port configured on the switch.
open_error_t	openapiL2oL3SwitchVxlanUdpDestPortSet (openapiClientHandle_t *client_handle, uint32_t udpDestPort)
	Set VXLAN UDP port on the switch.
open_error_t	openapiL2oL3TenantCreate (openapiClientHandle_t *client_handle, OPEN_L2OL3_CONFIG_t configType, uint32_t tenant, open_l2ol3TenantConfig_t tenantConfig)
	Creates or updates specified tenant configuration.
open_error_t	openapiL2oL3TenantDelete (openapiClientHandle_t *client_handle, uint32_t tenant)
	Deletes specified tenant configuration.
open_error_t	openapiL2oL3TenantGet (openapiClientHandle_t *client_handle, uint32_t tenant, open_l2ol3TenantConfig_t *tenantConfig)
	Get the configuration for a specified tenant.
open_error_t	openapiL2oL3TenantL2FwdEntryAdd (openapiClientHandle_t *client_handle, uint32_t tenantId, open_buffdesc *macAddress, uint32_t destIntfHandle)
	Configures a forwarding entry for the specified tenant system.
open_error_t	openapiL2oL3TenantL2FwdEntryDelete (openapiClientHandle_t *client_handle, uint32_t tenantId, open_buffdesc *macAddress)
	Deletes a forwarding entry of the specified tenant system.
open_error_t	openapiL2oL3TenantL2FwdEntryGet (openapiClientHandle_t *client_handle, uint32_t tenantId, open_buffdesc *macAddress, open_l2ol3L2FwdEntry_t *macEntry)
	Gets forwarding entry specified by tenant and MAC address.
open_error_t	openapiL2oL3TenantL2FwdEntryNextGet (openapiClientHandle_t *client_handle, uint32_t tenantId, open_buffdesc *macAddress, open_l2ol3L2FwdEntry_t *nextMacEntry)
	Get the next forwarding entry available after the forwarding entry specified by tenant and MAC address.
open_error_t	openapiL2oL3TenantNextGet (openapiClientHandle_t *client_handle, uint32_t tenant, uint32_t *nextTenant, open_l2ol3TenantConfig_t *nextTenantConfig)
	Get the next tenant entry for the next numerically higher tenant after the specified tenant.
open_error_t	openapiL2oL3TunnelCapabilitiesGet (openapiClientHandle_t *client_handle, uint32_t *capabilities)
	Get Overlay capabilities of the Switch.
open_error_t	openapiL2oL3TunnelCounterClear (openapiClientHandle_t *client_handle, uint32_t tunnelHandle)
	Clears packet/byte counters of the tenant tunnel specified by tunnel handle.
open_error_t	openapiL2oL3TunnelCounterGet (openapiClientHandle_t *client_handle, uint32_t tunnelHandle, open_l2ol3TunnelStats_t *tunnelStats)
	Gets packet/byte counters of the tenant tunnel specified tunnel handle.
open_error_t	openapiL2oL3TunnelCreate (openapiClientHandle_t *client_handle, OPEN_L2OL3_CONFIG_t configType, uint32_t tenant, uint32_t remoteIPAddr, uint32_t *tunnelHandle)
	Create a tunnel to a specified remote TEP for a specified tenant.
open_error_t	openapiL2oL3TunnelDelete (openapiClientHandle_t *client_handle, uint32_t tunnelHandle)
	Delete a tenant tunnel specified by the tunnel handle.
open_error_t	openapiL2oL3TunnelGet (openapiClientHandle_t *client_handle, uint32_t tunnelHandle, open_l2ol3TunnelInfo_t *tunnelInfo)
	Gets tenant tunnel entry from the specified tunnel handle.
open_error_t	openapiL2oL3TunnelLocalIPAddrGet (openapiClientHandle_t *client_handle, uint32_t *ipAddr)
	Gets the preferred IP address that can be used as Local TEP or local Overlay Gateway IP address.
open_error_t	openapiL2oL3TunnelNextGet (openapiClientHandle_t *client_handle, uint32_t tunnelId, open_l2ol3TunnelInfo_t *tunnelInfoNext)
	Gets tunnel entry for the next numerically higher tunnel handle after the specified tunnel handle.