Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
View And Configure SDM Templates [OPENAPI_SDM]

Macros

#define OPEN_MAX_SDM_TEMPLATES   5
 Maximum number of SDM templates. More...
 
#define OPEN_SDM_TEMPLATE_NAME_LEN   32
 Maximum number of characters in a template name, including the NULL terminator. More...
 

Enumerations

enum  OPEN_SDM_TEMPLATE_ID_t {
  OPEN_SDM_TEMPLATE_NONE = 0, OPEN_SDM_TEMPLATE_DUAL_DEFAULT = 1, OPEN_SDM_TEMPLATE_V4_DEFAULT = 2, OPEN_SDM_TEMPLATE_V4_DATA_CENTER = 3,
  OPEN_SDM_TEMPLATE_DATA_CENTER_PLUS = 4, OPEN_SDM_TEMPLATE_DUAL_DATA_CENTER = 5, OPEN_SDM_TEMPLATE_MPLS_DUAL_DATA_CENTER = 6, OPEN_SDM_TEMPLATE_DCVPN_DUAL_DATA_CENTER = 7,
  OPEN_SDM_TEMPLATE_DCVPN_V4_DATA_CENTER = 8, OPEN_SDM_TEMPLATE_ALPM = 9, OPEN_SDM_TEMPLATE_ALPM_MPLS_DUAL_DATA_CENTER = 10, OPEN_SDM_TEMPLATE_MAX = OPEN_SDM_TEMPLATE_ALPM_MPLS_DUAL_DATA_CENTER
}
 

Functions

open_error_t openapiSdmActiveTemplateGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t *templateId)
 Get the template ID of the active SDM template. More...
 
open_error_t openapiSdmNextActiveTemplateGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t *templateId)
 Get the template ID of the next active SDM template. More...
 
open_error_t openapiSdmNextActiveTemplateSet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId)
 Set the template ID of the next active SDM template. More...
 
open_error_t openapiSdmTemplateIdNextGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t *templateId)
 Get the next supported SDM template. More...
 
open_error_t openapiSdmTemplateMaxArpEntriesGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxEntries)
 Get the maximum number of ARP entries supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateMaxEcmpNextHopsGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxHops)
 Get the maximum number of ECMP next hops supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateMaxIpv4McastRoutesGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes)
 Get the maximum number of IPv4 multicast routes supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateMaxIpv4RoutesGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes)
 Get the maximum number of IPv4 routes supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateMaxIpv6McastRoutesGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes)
 Get the maximum number of IPv6 multicast routes supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateMaxIpv6RoutesGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxRoutes)
 Get the maximum number of IPv6 routes supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateMaxNdpEntriesGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, uint32_t *maxEntries)
 Get the maximum number of NDP entries supported in a specific SDM template. More...
 
open_error_t openapiSdmTemplateNameGet (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, open_buffdesc *templateName)
 Given a template ID, get the corresponding template name. More...
 
open_error_t openapiSdmTemplateSupported (openapiClientHandle_t *client_handle, OPEN_SDM_TEMPLATE_ID_t templateId, OPEN_BOOL_t *supported)
 Determine if a given SDM template is supported. More...
 

Detailed Description

Macro Definition Documentation

#define OPEN_MAX_SDM_TEMPLATES   5

Maximum number of SDM templates.

Definition at line 47 of file openapi_sdm.h.

#define OPEN_SDM_TEMPLATE_NAME_LEN   32

Maximum number of characters in a template name, including the NULL terminator.

Definition at line 49 of file openapi_sdm.h.

Enumeration Type Documentation

Enumerator
OPEN_SDM_TEMPLATE_NONE 

No SDM template.

OPEN_SDM_TEMPLATE_DUAL_DEFAULT 

Dual default SDM template.

OPEN_SDM_TEMPLATE_V4_DEFAULT 

V4 default SDM template.

OPEN_SDM_TEMPLATE_V4_DATA_CENTER 

V4 datacenter SDM template.

OPEN_SDM_TEMPLATE_DATA_CENTER_PLUS 

Datacenter plus SDM template.

OPEN_SDM_TEMPLATE_DUAL_DATA_CENTER 

Dual datacenter SDM template.

OPEN_SDM_TEMPLATE_MPLS_DUAL_DATA_CENTER 

MPLS dual datacenter SDM template.

OPEN_SDM_TEMPLATE_DCVPN_DUAL_DATA_CENTER 

DCVPN dual datacenter SDM template.

OPEN_SDM_TEMPLATE_DCVPN_V4_DATA_CENTER 

DCVPN V4 datacenter SDM template.

OPEN_SDM_TEMPLATE_ALPM 

ALPM SDM template.

OPEN_SDM_TEMPLATE_ALPM_MPLS_DUAL_DATA_CENTER 

ALPM MPLS dual datacenter SDM template.

Definition at line 54 of file openapi_sdm.h.

Function Documentation

open_error_t openapiSdmActiveTemplateGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t templateId 
)

Get the template ID of the active SDM template.

Parameters
[in]client_handleOpEN client handle
[out]templateIdActive SDM template ID
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.

OpEN API Version: 1.14

open_error_t openapiSdmNextActiveTemplateGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t templateId 
)

Get the template ID of the next active SDM template.

Parameters
[in]client_handleOpEN client handle
[out]templateIdNext active SDM template ID
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
Note
This is not an iterator function, templateId argument is strictly an output argument and returns the next active SDM template ID.

OpEN API Version: 1.14

open_error_t openapiSdmNextActiveTemplateSet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId 
)

Set the template ID of the next active SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_FAILTemplate is not stored persistently.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.
Note
If templateId is OPEN_SDM_TEMPLATE_NONE, deletes the next active template ID from persistent storage.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateIdNextGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t templateId 
)

Get the next supported SDM template.

Parameters
[in]client_handleOpEN client handle
[out]templateIdnext template ID
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDA next template ID does not exist.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxArpEntriesGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxEntries 
)

Get the maximum number of ARP entries supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxEntriesmax entries
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxEcmpNextHopsGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxHops 
)

Get the maximum number of ECMP next hops supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxHopsmax ECMP next hops for the template
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxIpv4McastRoutesGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxRoutes 
)

Get the maximum number of IPv4 multicast routes supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxRoutesmax IPv4 multicast routes for the template
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxIpv4RoutesGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxRoutes 
)

Get the maximum number of IPv4 routes supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxRoutesmax IPv4 routes for the template
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxIpv6McastRoutesGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxRoutes 
)

Get the maximum number of IPv6 multicast routes supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxRoutesmax IPv6 multicast routes for the template
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxIpv6RoutesGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxRoutes 
)

Get the maximum number of IPv6 routes supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxRoutesmax IPv6 routes for the template
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateMaxNdpEntriesGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
uint32_t *  maxEntries 
)

Get the maximum number of NDP entries supported in a specific SDM template.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]maxEntriesmax NDP entries for the template
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateNameGet ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
open_buffdesc templateName 
)

Given a template ID, get the corresponding template name.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]templateNametemplate name (when return is OPEN_E_NONE)
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.
OPEN_E_NOT_FOUNDTemplate ID does not match a valid template.
OPEN_E_INTERNALUnable to map template ID to internal value.
Note
The template name is no more than OPEN_SDM_TEMPLATE_NAME_LEN, including the NULL terminator.

OpEN API Version: 1.14

open_error_t openapiSdmTemplateSupported ( openapiClientHandle_t client_handle,
OPEN_SDM_TEMPLATE_ID_t  templateId,
OPEN_BOOL_t supported 
)

Determine if a given SDM template is supported.

Parameters
[in]client_handleOpEN client handle
[in]templateIdtemplate ID
[out]supportedboolean indicating if template is supported or not
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid parameter.

OpEN API Version: 1.14