Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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. More... | |
#define | OPEN_L2OL3_TUNNEL_VXLAN_UDP_PORT (4789) |
Default: UDP port used by VXLAN in IPv4 UDP header. More... | |
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. More... | |
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. More... | |
open_error_t | openapiL2oL3ResourceLimitsGet (openapiClientHandle_t *client_handle, open_l2ol3ResourceLimits_t *resourceLimits) |
Get Overlay configuration maximum allowed limits. More... | |
open_error_t | openapiL2oL3ResourceStatsGet (openapiClientHandle_t *client_handle, open_l2ol3ResourceStats_t *resourceStats) |
Get Overlay global statistics. More... | |
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. More... | |
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. More... | |
open_error_t | openapiL2oL3SwitchVxlanUdpDestPortGet (openapiClientHandle_t *client_handle, uint32_t *udpDestPort) |
Gets VXLAN UDP port configured on the switch. More... | |
open_error_t | openapiL2oL3SwitchVxlanUdpDestPortSet (openapiClientHandle_t *client_handle, uint32_t udpDestPort) |
Set VXLAN UDP port on the switch. More... | |
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. More... | |
open_error_t | openapiL2oL3TenantDelete (openapiClientHandle_t *client_handle, uint32_t tenant) |
Deletes specified tenant configuration. More... | |
open_error_t | openapiL2oL3TenantGet (openapiClientHandle_t *client_handle, uint32_t tenant, open_l2ol3TenantConfig_t *tenantConfig) |
Get the configuration for a specified tenant. More... | |
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. More... | |
open_error_t | openapiL2oL3TenantL2FwdEntryDelete (openapiClientHandle_t *client_handle, uint32_t tenantId, open_buffdesc *macAddress) |
Deletes a forwarding entry of the specified tenant system. More... | |
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. More... | |
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. More... | |
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. More... | |
open_error_t | openapiL2oL3TunnelCapabilitiesGet (openapiClientHandle_t *client_handle, uint32_t *capabilities) |
Get Overlay capabilities of the Switch. More... | |
open_error_t | openapiL2oL3TunnelCounterClear (openapiClientHandle_t *client_handle, uint32_t tunnelHandle) |
Clears packet/byte counters of the tenant tunnel specified by tunnel handle. More... | |
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. More... | |
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. More... | |
open_error_t | openapiL2oL3TunnelDelete (openapiClientHandle_t *client_handle, uint32_t tunnelHandle) |
Delete a tenant tunnel specified by the tunnel handle. More... | |
open_error_t | openapiL2oL3TunnelGet (openapiClientHandle_t *client_handle, uint32_t tunnelHandle, open_l2ol3TunnelInfo_t *tunnelInfo) |
Gets tenant tunnel entry from the specified tunnel handle. More... | |
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. More... | |
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. More... | |
#define OPEN_L2OL3_TENANT_ID_RESERVED (0xFFFFFF) |
This is reserved ID and used for internal purposes.
Definition at line 54 of file openapi_l2ol3tunnel.h.
#define OPEN_L2OL3_TUNNEL_VXLAN_UDP_PORT (4789) |
Default: UDP port used by VXLAN in IPv4 UDP header.
Switch also terminates VXLAN matching this UDP port
Definition at line 49 of file openapi_l2ol3tunnel.h.
Tenant Access Port Classification Types.
Enumerator | |
---|---|
OPEN_L2OL3_ACCESS_MATCH_PORT |
Classifies based on incoming port. |
OPEN_L2OL3_ACCESS_MATCH_PORT_VLAN |
Classifies based on incoming VLAN tag. |
Definition at line 94 of file openapi_l2ol3tunnel.h.
enum OPEN_L2OL3_CONFIG_t |
Overlay Configuration Methods.
Enumerator | |
---|---|
OPEN_L2OL3_CONFIG_CREATE |
Create Operation. |
OPEN_L2OL3_CONFIG_UPDATE |
Update Operation. |
Definition at line 69 of file openapi_l2ol3tunnel.h.
enum OPEN_L2OL3_REASON_t |
Tunnel Status Reason Codes.
Definition at line 76 of file openapi_l2ol3tunnel.h.
Overlay Types.
Enumerator | |
---|---|
OPEN_L2OL3_TUNNEL_TYPE_VXLAN |
VXLAN tunnel type. |
OPEN_L2OL3_TUNNEL_TYPE_NVGRE |
NVGRE tunnel type. |
Definition at line 61 of file openapi_l2ol3tunnel.h.
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.
[in] | client_handle | Client handle from registration API. |
[in] | accessPortHandle | Access Port Handle. |
[out] | accessPortInfo | Access Port Information. |
OPEN_E_NONE | Access Port info get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Access Port does not exists |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | accessPortHandle | Access Port Handle. |
[out] | accessPortNextInfo | Next Access Port Information. |
OPEN_E_NONE | Next access port info get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Next access port was not found |
OpEN API Version: 1.3
open_error_t openapiL2oL3ResourceLimitsGet | ( | openapiClientHandle_t * | client_handle, |
open_l2ol3ResourceLimits_t * | resourceLimits | ||
) |
Get Overlay configuration maximum allowed limits.
[in] | client_handle | Client handle from registration API. |
[out] | resourceLimits | Resource Limit Values. |
OPEN_E_NONE | Resource limits retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Switch does not support Overlays |
OpEN API Version: 1.3
open_error_t openapiL2oL3ResourceStatsGet | ( | openapiClientHandle_t * | client_handle, |
open_l2ol3ResourceStats_t * | resourceStats | ||
) |
Get Overlay global statistics.
[in] | client_handle | Client handle from registration API. |
[out] | resourceStats | Global statistics. |
OPEN_E_NONE | Global statistics retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Switch does not support Overlays |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | tunnelType | Type of Overlay functionality. |
[out] | mode | Overlay Mode. |
OPEN_E_NONE | Mode retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | tunnelType | Type of Overlay functionality. |
[in] | mode | Overlay Tunnel Mode. |
OPEN_E_NONE | Capabilities retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_EXISTS | Specified Overlay mode already configured |
OpEN API Version: 1.3
open_error_t openapiL2oL3SwitchVxlanUdpDestPortGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | udpDestPort | ||
) |
Gets VXLAN UDP port configured on the switch.
[in] | client_handle | Client handle from registration API. |
[out] | udpDestPort | UDP Port Number |
OPEN_E_NONE | VXLAN UDP port get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | VXLAN feature is not supported |
OpEN API Version: 1.3
open_error_t openapiL2oL3SwitchVxlanUdpDestPortSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | udpDestPort | ||
) |
Set VXLAN UDP port on the switch.
[in] | client_handle | Client handle from registration API. |
[in] | udpDestPort | UDP Port Number |
OPEN_E_NONE | VXLAN UDP port set successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_EXISTS | Already configured |
OPEN_E_FAILURE | Operation failed due to no support for VXLAN or Overlay mode is not set to VXLAN or other failure. |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | configType | Configuration Type. |
[in] | tenant | Tenant identifier. |
[in] | tenantConfig | Tenant configuration Information. |
OPEN_E_NONE | Tenant configured successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_ERROR | Overlay functionality is not enabled on the switch |
OPEN_E_FULL | Attempting to create an entry, but already reached maximum number of tenants |
OPEN_E_EXISTS | Specified tenant already exists during update |
OPEN_E_NOT_FOUND | Specified tenant does not exist |
OPEN_E_FAIL | Tenant configuration failed |
OpEN API Version: 1.3
open_error_t openapiL2oL3TenantDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | tenant | ||
) |
Deletes specified tenant configuration.
[in] | client_handle | Client handle from registration API. |
[in] | tenant | Tenant identifier. |
OPEN_E_NONE | Tenant deleted successfully |
OPEN_E_NOT_FOUND | Tenant does not exist |
OPEN_E_ERROR | Switch mode not configured |
OPEN_E_FAIL | Tenant configuration clean up failed |
OpEN API Version: 1.3
open_error_t openapiL2oL3TenantGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | tenant, | ||
open_l2ol3TenantConfig_t * | tenantConfig | ||
) |
Get the configuration for a specified tenant.
[in] | client_handle | Client handle from registration API. |
[in] | tenant | Tenant identifier. |
[out] | tenantConfig | Tenant Configuration Information |
OPEN_E_NONE | Tenant Information get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Tenant does not exist |
OpEN API Version: 1.3
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.
[in] | client_handle | client handle from registration API. |
[in] | tenantId | Tenant identifier. |
[in] | macAddress | MAC address of the tenant system. |
[in] | destIntfHandle | Destination handle. This is tenant access handle or tunnel handle. |
OPEN_E_NONE | MAC address entry added successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_EXISTS | Attempting to create an entry for a MAC address which already exists in the database |
OPEN_E_NOT_FOUND | Tenant does not exist or destIntfHandle is invalid |
OPEN_E_FULL | Attempting to create an entry, but already reached maximum number supported MAC entries |
OPEN_E_FAIL | MAC entry add failed |
OPEN_E_ERROR | Overlay functionality is not enabled on the switch |
OpEN API Version: 1.3
open_error_t openapiL2oL3TenantL2FwdEntryDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | tenantId, | ||
open_buffdesc * | macAddress | ||
) |
Deletes a forwarding entry of the specified tenant system.
[in] | client_handle | client handle from registration API. |
[in] | tenantId | Tenant identifier. |
[in] | macAddress | MAC address of the tenant system. |
OPEN_E_NONE | Forwarding entry deleted |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Either tenant or forwarding entry was not found |
OPEN_E_FAIL | MAC entry delete failed |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | tenantId | Tenant identifier. |
[in] | macAddress | MAC address to search or get |
[out] | macEntry | MAC entry information, if found |
OPEN_E_NONE | Forwarding entry retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Forwarding entry was not found |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | tenantId | Tenant identifier. |
[in] | macAddress | MAC address to search. |
[out] | nextMacEntry | Forwarding entry of the next host. |
OPEN_E_NONE | Next forwarding entry retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Next forwarding entry was not found |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[in] | tenant | Tenant identifier. |
[out] | nextTenant | Next Tenant identifier. |
[out] | nextTenantConfig | Next Tenant information. |
OPEN_E_NONE | Next tenant retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Next tenant was not found |
OpEN API Version: 1.3
open_error_t openapiL2oL3TunnelCapabilitiesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | capabilities | ||
) |
Get Overlay capabilities of the Switch.
[in] | client_handle | Client handle from registration API. |
[out] | capabilities | Supported Overlay tunnel capabilities. |
OPEN_E_NONE | Capabilities retrieved successfully |
OPEN_E_PARAM | Error in parameter passed |
OpEN API Version: 1.3
open_error_t openapiL2oL3TunnelCounterClear | ( | openapiClientHandle_t * | client_handle, |
uint32_t | tunnelHandle | ||
) |
Clears packet/byte counters of the tenant tunnel specified by tunnel handle.
[in] | client_handle | client handle from registration API. |
[in] | tunnelHandle | Tenant tunnel handle. |
OPEN_E_NONE | Tunnel counter cleared successfully |
OPEN_E_NOT_FOUND | Tunnel was not found |
OPEN_E_FAIL | Failed to clear hardware tunnel counters |
OpEN API Version: 1.3
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.
[in] | client_handle | client handle from registration API. |
[in] | tunnelHandle | Tenant tunnel handle. |
[out] | tunnelStats | Tunnel counters information. |
OPEN_E_NONE | Tunnel counter get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Tunnel was not found |
OPEN_E_FAIL | Failed to get hardware tunnel counters |
OpEN API Version: 1.3
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.
[in] | client_handle | client handle from registration API. |
[in] | configType | Configuration type. |
[in] | tenant | Tenant identifier. |
[in] | remoteIPAddr | IP address of remote TEP. |
[out] | tunnelHandle | Unique handle to tenant tunnel. |
OPEN_E_NONE | Tunnel creation successful |
OPEN_E_PARAM | Error in parameters passed |
OPEN_E_ERROR | Overlay functionality is not enabled on the switch |
OPEN_E_UNAVAIL | Tunnel update operation is not supported |
OPEN_E_FULL | Attempting to create an entry, but already reached maximum number of tunnels |
OPEN_E_EXISTS | Tunnel to remoteIPAddr exists. API returns the handle to the existing tunnel in 'tunnelHandle' |
OPEN_E_NOT_FOUND | Tenant does not exist. |
OpEN API Version: 1.3
open_error_t openapiL2oL3TunnelDelete | ( | openapiClientHandle_t * | client_handle, |
uint32_t | tunnelHandle | ||
) |
Delete a tenant tunnel specified by the tunnel handle.
[in] | client_handle | client handle from registration API. |
[in] | tunnelHandle | Unique handle to the tenant tunnel. |
OPEN_E_NONE | Tunnel deleted successfully |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Tunnel does not exist |
OPEN_E_FAIL | Tunnel delete failed |
OpEN API Version: 1.3
open_error_t openapiL2oL3TunnelGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | tunnelHandle, | ||
open_l2ol3TunnelInfo_t * | tunnelInfo | ||
) |
Gets tenant tunnel entry from the specified tunnel handle.
[in] | client_handle | client handle from registration API. |
[in] | tunnelHandle | Unique handle to the tenant tunnel. |
[out] | tunnelInfo | Tenant tunnel information. |
OPEN_E_NONE | Tunnel info get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Tunnel does not exists |
OpEN API Version: 1.3
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.
[in] | client_handle | Client handle from registration API. |
[out] | ipAddr | IPv4 IP address |
OPEN_E_NONE | IP address get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | No IP address available or IP address changed. |
OpEN API Version: 1.3
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.
[in] | client_handle | client handle from registration API. |
[in] | tunnelHandle | Tenant tunnel handle. |
[out] | tunnelInfoNext | Next tunnel entry information. |
OPEN_E_NONE | Next tunnel entry get successful |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_NOT_FOUND | Next tunnel entry was not found |
OpEN API Version: 1.3