Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Functions
Port MAC Locking (PML) Configuration And Status [OPENAPI_PML]

Functions

open_error_t openapiPmlGlobalAdminModeGet (openapiClientHandle_t *clientHandle, OPEN_CONTROL_t *adminMode)
 Get the Port MAC Locking Global Admin mode. More...
 
open_error_t openapiPmlIntfDynamicLimitGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit)
 Get the Port MAC Locking dynamic limit for the specified interface. More...
 
open_error_t openapiPmlIntfIsValid (openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_BOOL_t *isValid)
 Get whether an interface is a valid PML interface or not. More...
 
open_error_t openapiPmlIntfModeGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *mode)
 Get the Port MAC Locking mode for the specified interface. More...
 
open_error_t openapiPmlIntfStaticLimitGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit)
 Get the Port MAC Locking static limit for the specified interface. More...
 
open_error_t openapiPmlIntfStickyModeGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *stickyMode)
 Get the Port MAC Locking sticky mode for the specified interface. More...
 
open_error_t openapiPmlIntfViolationDDisableModeGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *mode)
 Get the Port MAC Locking violation D-Disable mode for the specified interface. More...
 
open_error_t openapiPmlIntfViolationTrapModeGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *trapMode)
 Get the Port MAC Locking violation trap mode for the specified interface. More...
 

Detailed Description

Function Documentation

open_error_t openapiPmlGlobalAdminModeGet ( openapiClientHandle_t clientHandle,
OPEN_CONTROL_t adminMode 
)

Get the Port MAC Locking Global Admin mode.

Parameters
[in]clientHandleclient handle from registration API
[out]adminModeon success, PML global admin mode.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfDynamicLimitGet ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
uint32_t *  limit 
)

Get the Port MAC Locking dynamic limit for the specified interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]limiton success, dynamic limit
Return values
OPEN_E_NONEOn success.
OPEN_E_UNAVAILInterface is not a valid PML interface.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfIsValid ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
OPEN_BOOL_t isValid 
)

Get whether an interface is a valid PML interface or not.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]isValidif OPEN_TRUE, valid. Otherwise, OPEN_FALSE
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfModeGet ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
OPEN_CONTROL_t mode 
)

Get the Port MAC Locking mode for the specified interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]modeon success, PML interface admin mode
Return values
OPEN_E_NONEOn success.
OPEN_E_UNAVAILInterface is not a valid PML interface.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticLimitGet ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
uint32_t *  limit 
)

Get the Port MAC Locking static limit for the specified interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]limiton success, static limit
Return values
OPEN_E_NONEOn success.
OPEN_E_UNAVAILInterface is not a valid PML interface.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfStickyModeGet ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
OPEN_CONTROL_t stickyMode 
)

Get the Port MAC Locking sticky mode for the specified interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]stickyModeon success, PML sticky mode
Return values
OPEN_E_NONEOn success.
OPEN_E_UNAVAILInterface is not a valid PML interface.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfViolationDDisableModeGet ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
OPEN_CONTROL_t mode 
)

Get the Port MAC Locking violation D-Disable mode for the specified interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]modeon success, PML violation D-Disable mode
Return values
OPEN_E_NONEOn success.
OPEN_E_UNAVAILInterface is not a valid PML interface.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.
open_error_t openapiPmlIntfViolationTrapModeGet ( openapiClientHandle_t clientHandle,
uint32_t  ifNum,
OPEN_CONTROL_t trapMode 
)

Get the Port MAC Locking violation trap mode for the specified interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]trapModeon success, PML violation trap mode
Return values
OPEN_E_NONEOn success.
OPEN_E_UNAVAILInterface is not a valid PML interface.
OPEN_E_PARAMBad parameter was passed.
OPEN_E_FAILOn failure.

OpEN API Version: 1.18

Examples:
pml_example.c.