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.
open_error_t	openapiPmlIntfDynamicLimitGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit)
	Get the Port MAC Locking dynamic limit for the specified interface.
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.
open_error_t	openapiPmlIntfModeGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the Port MAC Locking mode for the specified interface.
open_error_t	openapiPmlIntfStaticLimitGet (openapiClientHandle_t *clientHandle, uint32_t ifNum, uint32_t *limit)
	Get the Port MAC Locking static limit for the specified interface.
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.
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.
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.

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]	clientHandle	client handle from registration API
[out]	adminMode	on success, PML global admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	limit	on success, dynamic limit

Return values

OPEN_E_NONE	On success.
OPEN_E_UNAVAIL	Interface is not a valid PML interface.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	isValid	if OPEN_TRUE, valid. Otherwise, OPEN_FALSE

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	mode	on success, PML interface admin mode

Return values

OPEN_E_NONE	On success.
OPEN_E_UNAVAIL	Interface is not a valid PML interface.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	limit	on success, static limit

Return values

OPEN_E_NONE	On success.
OPEN_E_UNAVAIL	Interface is not a valid PML interface.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	stickyMode	on success, PML sticky mode

Return values

OPEN_E_NONE	On success.
OPEN_E_UNAVAIL	Interface is not a valid PML interface.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	mode	on success, PML violation D-Disable mode

Return values

OPEN_E_NONE	On success.
OPEN_E_UNAVAIL	Interface is not a valid PML interface.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On 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]	clientHandle	client handle from registration API
[in]	ifNum	interface number
[out]	trapMode	on success, PML violation trap mode

Return values

OPEN_E_NONE	On success.
OPEN_E_UNAVAIL	Interface is not a valid PML interface.
OPEN_E_PARAM	Bad parameter was passed.
OPEN_E_FAIL	On failure.

OpEN API Version: 1.18

Examples:

pml_example.c.