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

Functions

open_error_t openapiPmlDot1qciStreamDelete (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId, uint32_t streamID)
 Deassociate the 802.1Qci stream with static PML entry. More...
 
open_error_t openapiPmlDot1qciStreamGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId, uint32_t *streamID)
 Get the 802.1Qci stream ID associated with static PML entry. More...
 
open_error_t openapiPmlDot1qciStreamSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId, uint32_t streamID)
 Associate the 802.1Qci stream with static PML entry. More...
 
open_error_t openapiPmlGlobalAdminModeGet (openapiClientHandle_t *clientHandle, OPEN_CONTROL_t *adminMode)
 Get the Port MAC Locking Global Admin mode. More...
 
open_error_t openapiPmlGlobalAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
 Sets the PML global admin mode. More...
 
open_error_t openapiPmlIntfAgeTimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *ageTime)
 Gets secure MAC address aging time for the specified interface. More...
 
open_error_t openapiPmlIntfAgeTimeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t ageTime)
 Sets secure MAC address aging time for the specified interface. More...
 
open_error_t openapiPmlIntfDynamicEntryGetFirst (openapiClientHandle_t *clientHandle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t *vlanId)
 Gets the first dynamic entry for an interface. More...
 
open_error_t openapiPmlIntfDynamicEntryGetNext (openapiClientHandle_t *clientHandle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId, open_buffdesc *nextMacAddr, uint32_t *nextVlanId)
 Gets the next dynamic entry for an interface. More...
 
open_error_t openapiPmlIntfDynamicLearnedAddrCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count)
 Gets the count of dynamcially learned mac Addresses. 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 openapiPmlIntfDynamicLimitSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t limit)
 Sets the Port MAC Locking dynamic limit for the specified interface. More...
 
open_error_t openapiPmlIntfDynamicMaxLimitGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *limit)
 Gets the Port MAC Locking maximum dynamic limit for the specified interface. More...
 
open_error_t openapiPmlIntfDynamicToStaticMove (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Converts dynamically locked entries to statically locked entries on this 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 openapiPmlIntfLastViolationAddrGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t *vlanId)
 Gets the last violation entry for an interface. 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 openapiPmlIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t intfMode)
 Set the Port MAC Locking mode for the specified interface. More...
 
open_error_t openapiPmlIntfStaticCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *limit)
 Gets the Port MAC Locking static count for the specified interface. More...
 
open_error_t openapiPmlIntfStaticEntryAdd (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId, OPEN_BOOL_t sticky)
 Adds a statically locked entry to an interface. More...
 
open_error_t openapiPmlIntfStaticEntryDelete (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId)
 Deletes a statically locked entry from an interface. More...
 
open_error_t openapiPmlIntfStaticEntryGetFirst (openapiClientHandle_t *clientHandle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t *vlanId, OPEN_BOOL_t *isSticky)
 Gets the first static entry for an interface. More...
 
open_error_t openapiPmlIntfStaticEntryGetNext (openapiClientHandle_t *clientHandle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t vlanId, open_buffdesc *nextMacAddr, uint32_t *nextVlanId, OPEN_BOOL_t *isnextEntrySticky)
 Gets the next static entry for an interface. More...
 
open_error_t openapiPmlIntfStaticLearnedAddrCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count)
 Gets the count of statically learned mac Addresses. 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 openapiPmlIntfStaticLimitSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t limit)
 Sets the Port MAC Locking static limit for the specified interface. More...
 
open_error_t openapiPmlIntfStaticMaxLimitGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *limit)
 Gets the Port MAC Locking maximum 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 openapiPmlIntfStickyModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t sticky)
 Configures PML sticky mode on this interface. More...
 
open_error_t openapiPmlIntfTrapFrequencyGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *interval)
 Gets the frequency interval between successive SNMP traps. More...
 
open_error_t openapiPmlIntfTrapFrequencySet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t interval)
 Sets the frequency interval between successive SNMP traps. 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 openapiPmlIntfViolationDDisableModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
 Sets 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...
 
open_error_t openapiPmlIntfVlanDynamicLearnedAddrCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId, uint32_t *count)
 Gets the Port MAC Locking vlan dynamic learned address count for the specified interface and vlan. More...
 
open_error_t openapiPmlIntfVlanDynamicLimitGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId, uint32_t *limit)
 Gets the Port MAC Locking vlan dynamic limit for the specified interface. More...
 
open_error_t openapiPmlIntfVlanDynamicLimitSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId, uint32_t limit)
 Sets the Port MAC Locking vlan dynamic limit for the specified interface. More...
 
open_error_t openapiPmlNextValidIntfGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *nextIfNum)
 Gets the next valid PML interface. More...
 
open_error_t openapiPmlStaticAddrCountByVlanGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *count)
 Gets the count of statically learned mac Addresses. More...
 
open_error_t openapiPmlStaticAddrGlobalCountGet (openapiClientHandle_t *client_handle, uint32_t *count)
 Gets the global count of statically learned mac Addresses. More...
 
open_error_t openapiPmlVlanAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
 Gets the PML vlan admin mode. More...
 
open_error_t openapiPmlVlanAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
 Sets the PML vlan admin mode. More...
 
open_error_t openapiPmlVlanDynamicEntryGetFirst (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, uint32_t *vlanId)
 Gets the first dynamic entry for a vlan on a given interface. More...
 
open_error_t openapiPmlVlanDynamicEntryGetNext (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr, open_buffdesc *nextMacAddr, uint32_t *vlanId)
 Gets the next dynamic entry for a vlan on a given interface. More...
 
open_error_t openapiPmlVlanDynamicLimitGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *limit)
 Gets the MAC limit per Vlan. More...
 
open_error_t openapiPmlVlanDynamicLimitSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t limit)
 Sets the vlan MAC Locking limit. More...
 
open_error_t openapiPmlVlanModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *mode)
 Gets the MAC Locking mode for the specified vlan. More...
 
open_error_t openapiPmlVlanModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t mode)
 Sets the MAC Locking mode for the specified vlan. More...
 
open_error_t openapiPmlVlanOperationalLimitGet (openapiClientHandle_t *client_handle, uint32_t vlanId, uint32_t *limit)
 Gets operational vlan MAC locking limit. More...
 
open_error_t openapiPmlVlanViolationDDisableModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *mode)
 Gets the MAC Locking violation D-Disable mode for the specified vlan. More...
 
open_error_t openapiPmlVlanViolationDDisableModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t mode)
 Sets the MAC Locking violation D-Disable mode for the specified vlan. More...
 
open_error_t openapiPmlVlanViolationTrapModeGet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *mode)
 Gets the MAC Locking violation trap mode for the specified vlan. More...
 
open_error_t openapiPmlVlanViolationTrapModeSet (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t mode)
 Sets the MAC Locking violation trap mode for the specified vlan. More...
 

Detailed Description

Function Documentation

open_error_t openapiPmlDot1qciStreamDelete ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId,
uint32_t  streamID 
)

Deassociate the 802.1Qci stream with static PML entry.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
[in]streamID802.1QCI StreamID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlDot1qciStreamGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId,
uint32_t *  streamID 
)

Get the 802.1Qci stream ID associated with static PML entry.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
[out]streamID802.1QCI StreamID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlDot1qciStreamSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId,
uint32_t  streamID 
)

Associate the 802.1Qci stream with static PML entry.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
[in]streamID802.1QCI StreamID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
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 openapiPmlGlobalAdminModeSet ( openapiClientHandle_t *  client_handle,
OPEN_CONTROL_t  adminMode 
)

Sets the PML global admin mode.

Parameters
[in]client_handleclient handle from registration API
[in]adminModePML global admin mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfAgeTimeGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  ageTime 
)

Gets secure MAC address aging time for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]ageTimeAge time in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfAgeTimeSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  ageTime 
)

Sets secure MAC address aging time for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]ageTimeAge time in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfDynamicEntryGetFirst ( openapiClientHandle_t *  clientHandle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t *  vlanId 
)

Gets the first dynamic entry for an interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]macAddrMAC address
[out]vlanIdVLAN ID
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.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfDynamicEntryGetNext ( openapiClientHandle_t *  clientHandle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId,
open_buffdesc *  nextMacAddr,
uint32_t *  nextVlanId 
)

Gets the next dynamic entry for an interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
[out]nextMacAddrNext MAC address
[out]nextVlanIdnext VLAN ID
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.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfDynamicLearnedAddrCountGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  count 
)

Gets the count of dynamcially learned mac Addresses.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]countLearned dynamic address count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

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 openapiPmlIntfDynamicLimitSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  limit 
)

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

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]limitDynamic limit
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfDynamicMaxLimitGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  limit 
)

Gets the Port MAC Locking maximum dynamic limit for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]limitMaximum dynamic limit
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfDynamicToStaticMove ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum 
)

Converts dynamically locked entries to statically locked entries on this interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

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 openapiPmlIntfLastViolationAddrGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t *  vlanId 
)

Gets the last violation entry for an interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]macAddrMAC address
[out]vlanIdVLAN ID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

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 openapiPmlIntfModeSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  intfMode 
)

Set the Port MAC Locking mode for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]intfModePML interface admin mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticCountGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  limit 
)

Gets the Port MAC Locking static count for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]limitStatic count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticEntryAdd ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId,
OPEN_BOOL_t  sticky 
)

Adds a statically locked entry to an interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
[in]stickySticky
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticEntryDelete ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId 
)

Deletes a statically locked entry from an interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticEntryGetFirst ( openapiClientHandle_t *  clientHandle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t *  vlanId,
OPEN_BOOL_t *  isSticky 
)

Gets the first static entry for an interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[out]macAddrMAC address
[out]vlanIdVLAN ID
[out]isStickyon success, whether entry is sticky or not
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.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticEntryGetNext ( openapiClientHandle_t *  clientHandle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t  vlanId,
open_buffdesc *  nextMacAddr,
uint32_t *  nextVlanId,
OPEN_BOOL_t *  isnextEntrySticky 
)

Gets the next static entry for an interface.

Parameters
[in]clientHandleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[in]vlanIdVLAN ID
[out]nextMacAddrNext MAC address
[out]nextVlanIdnext VLAN ID
[out]isnextEntryStickyon success, whether next entry is sticky or not
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.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticLearnedAddrCountGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  count 
)

Gets the count of statically learned mac Addresses.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]countStatic address count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

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 openapiPmlIntfStaticLimitSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  limit 
)

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

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]limitStatic limit
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfStaticMaxLimitGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  limit 
)

Gets the Port MAC Locking maximum static limit for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]limitMaximum static limit
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

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 openapiPmlIntfStickyModeSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  sticky 
)

Configures PML sticky mode on this interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]stickySticky mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfTrapFrequencyGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  interval 
)

Gets the frequency interval between successive SNMP traps.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]intervalTime interval in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfTrapFrequencySet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  interval 
)

Sets the frequency interval between successive SNMP traps.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]intervalTime interval in seconds
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

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 openapiPmlIntfViolationDDisableModeSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
OPEN_CONTROL_t  mode 
)

Sets the port MAC locking violation D-Disable mode for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]modeViolation D-Disable Mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

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.
open_error_t openapiPmlIntfVlanDynamicLearnedAddrCountGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  vlanId,
uint32_t *  count 
)

Gets the Port MAC Locking vlan dynamic learned address count for the specified interface and vlan.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]vlanIdVLAN ID
[out]countMAC lock learned address count per vlan per interface
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfVlanDynamicLimitGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  vlanId,
uint32_t *  limit 
)

Gets the Port MAC Locking vlan dynamic limit for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]vlanIdVLAN ID
[out]limitMAC lock limit per vlan per interface
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlIntfVlanDynamicLimitSet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t  vlanId,
uint32_t  limit 
)

Sets the Port MAC Locking vlan dynamic limit for the specified interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]vlanIdVLAN ID
[in]limitMAC lock limit per vlan per interface
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlNextValidIntfGet ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
uint32_t *  nextIfNum 
)

Gets the next valid PML interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]nextIfNumNext valid PML interface number
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlStaticAddrCountByVlanGet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
uint32_t *  count 
)

Gets the count of statically learned mac Addresses.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]countStatic address count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlStaticAddrGlobalCountGet ( openapiClientHandle_t *  client_handle,
uint32_t *  count 
)

Gets the global count of statically learned mac Addresses.

Parameters
[in]client_handleclient handle from registration API
[out]countLearned static address count
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanAdminModeGet ( openapiClientHandle_t *  client_handle,
OPEN_CONTROL_t *  adminMode 
)

Gets the PML vlan admin mode.

Parameters
[in]client_handleclient handle from registration API
[out]adminModePML vlan admin mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanAdminModeSet ( openapiClientHandle_t *  client_handle,
OPEN_CONTROL_t  adminMode 
)

Sets the PML vlan admin mode.

Parameters
[in]client_handleclient handle from registration API
[in]adminModePML vlan admin mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanDynamicEntryGetFirst ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
uint32_t *  vlanId 
)

Gets the first dynamic entry for a vlan on a given interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[out]macAddrMAC address
[out]vlanIdVLAN ID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanDynamicEntryGetNext ( openapiClientHandle_t *  client_handle,
uint32_t  ifNum,
open_buffdesc *  macAddr,
open_buffdesc *  nextMacAddr,
uint32_t *  vlanId 
)

Gets the next dynamic entry for a vlan on a given interface.

Parameters
[in]client_handleclient handle from registration API
[in]ifNuminterface number
[in]macAddrMAC address
[out]nextMacAddrMAC address
[out]vlanIdVLAN ID
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanDynamicLimitGet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
uint32_t *  limit 
)

Gets the MAC limit per Vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]limitMAC lock limit per vlan
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanDynamicLimitSet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
uint32_t  limit 
)

Sets the vlan MAC Locking limit.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[in]limitMAC lock limit per vlan
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanModeGet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
uint32_t *  mode 
)

Gets the MAC Locking mode for the specified vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]modeVLAN MAC Locking mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanModeSet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
uint32_t  mode 
)

Sets the MAC Locking mode for the specified vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[in]modeVLAN MAC Locking mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanOperationalLimitGet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
uint32_t *  limit 
)

Gets operational vlan MAC locking limit.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]limitMAC lock operational limit per vlan
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanViolationDDisableModeGet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
OPEN_BOOL_t *  mode 
)

Gets the MAC Locking violation D-Disable mode for the specified vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]modeViolation D-Disable Mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanViolationDDisableModeSet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
OPEN_BOOL_t  mode 
)

Sets the MAC Locking violation D-Disable mode for the specified vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[in]modeViolation D-Disable Mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanViolationTrapModeGet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
OPEN_BOOL_t *  mode 
)

Gets the MAC Locking violation trap mode for the specified vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]modeViolation trap Mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.

OpEN API Version: 1.25

Examples:
pml_example.c.
open_error_t openapiPmlVlanViolationTrapModeSet ( openapiClientHandle_t *  client_handle,
uint32_t  vlanId,
OPEN_BOOL_t  mode 
)

Sets the MAC Locking violation trap mode for the specified vlan.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[in]modeViolation trap Mode
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
OPEN_E_UNAVAILFeature not available.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:
pml_example.c.