Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
Port Mirroring APIs [OPENAPI_MIRROR]

Enumerations

enum  OPENAPI_MIRROR_DIRECTION_t {
  OPENAPI_MIRROR_UNCONFIGURED = 0, OPENAPI_MIRROR_BIDIRECTIONAL = 1, OPENAPI_MIRROR_INGRESS = 2, OPENAPI_MIRROR_EGRESS = 3,
  OPENAPI_MIRROR_SFLOW = 4
}
 OpEN uses this enumeration to define ports traffic direction. More...
 

Functions

open_error_t openapiMirrorIsRspanVlan (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *status)
 Checks if the VLAN is a RSPAN VLAN. More...
 
open_error_t openapiMirrorIsSrcVlan (openapiClientHandle_t *client_handle, uint32_t vlanId, OPEN_BOOL_t *status)
 Checks if the VLAN is source to any of the mirroring sessions. More...
 
open_error_t openapiMirrorSessionReserveStateGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t *state)
 Returns the Port Monitoring session "sessionNum" reserved state. More...
 
open_error_t openapiMirrorSessionReserveStateSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t state)
 Sets the Port Monitoring session "sessionNum" reserved state. More...
 
open_error_t openapiMirrorSourcePortDirectionGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum, OPENAPI_MIRROR_DIRECTION_t *probeType)
 Returns the direction to be mirrored for a source port. More...
 
open_error_t openapiRemoteSpanVlanGet (openapiClientHandle_t *client_handle, uint32_t *rspanVlan)
 Returns the RSPAN VLAN. More...
 
open_error_t openapiRemoteSpanVlanListGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
 Returns list of RSPAN VLAN. More...
 
open_error_t openapiRemoteSpanVlanNextGet (openapiClientHandle_t *client_handle, uint32_t rspanVlan, uint32_t *rspanVlanNext)
 Returns next configured RSPAN VLAN. More...
 
open_error_t openapiRemoteSpanVlanSet (openapiClientHandle_t *client_handle, uint32_t rspanVlan, OPEN_CONTROL_t updateAction)
 Sets the VLAN as RSPAN VLAN. More...
 
open_error_t openapiSwMonitorDstTypeGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *mirrorDstType)
 Returns the destination mirror type (Port based or VLAN based) for session "sessionNum". More...
 
open_error_t openapiSwMonitorIpAclGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *ipAccessListNum)
 Returns the IP ACL attached to the mirroring session "sessionNum". More...
 
open_error_t openapiSwMonitorIpAclSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t ipAccessListNum, OPEN_CONTROL_t updateAction)
 Attaches IP ACL to the mirroring session "sessionNum". More...
 
open_error_t openapiSwMonitorMacAclGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *macAccessListName)
 Returns the MAC ACL attached to the mirroring session "sessionNum". More...
 
open_error_t openapiSwMonitorMacAclSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *macAccessListName, OPEN_CONTROL_t updateAction)
 Attaches MAC ACL to the mirroring session "sessionNum". More...
 
open_error_t openapiSwMonitorReflectorPortGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *intIfNum)
 Returns Monitoring Reflector Port for session "sessionNum". More...
 
open_error_t openapiSwMonitorReflectorPortSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum, OPEN_CONTROL_t updateAction)
 Sets Monitoring Reflector Port for session "sessionNum". More...
 
open_error_t openapiSwMonitorRemoteDstVlanGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *remoteDstVlan)
 Returns the remote destination VLAN for session "sessionNum". More...
 
open_error_t openapiSwMonitorRemoteSrcVlanGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *remoteSrcVlan)
 Returns the remote source VLAN for session "sessionNum". More...
 
open_error_t openapiSwMonitorSrcTypeGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *mirrorSrcType)
 Returns the source mirror type(Port based or VLAN based) for session "sessionNum". More...
 
open_error_t openapiSwMonitorVlanListGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *bufd)
 Returns the VLAN IDs for session "sessionNum". More...
 
open_error_t openapiSwMonitorVlanListSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *bufd, OPEN_CONTROL_t updateAction)
 Sets the VLAN IDs for session "sessionNum". More...
 
open_error_t openapiSwPortMonitorConfigRemove (openapiClientHandle_t *client_handle)
 Removes port monitoring configuration for all sessions. More...
 
open_error_t openapiSwPortMonitorDestPortGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *intIfNum)
 Returns Destination Port for session "sessionNum". More...
 
open_error_t openapiSwPortMonitorDestPortRemove (openapiClientHandle_t *client_handle, uint32_t sessionNum)
 Remove Destination Port of session "sessionNum". More...
 
open_error_t openapiSwPortMonitorDestPortSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum)
 Sets Destination Port for session "sessionNum". More...
 
open_error_t openapiSwPortMonitorIsDestConfigured (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *sessionNum, OPEN_BOOL_t *status)
 Determines status of internal interface number which is configured as destination port. More...
 
open_error_t openapiSwPortMonitorIsSrcConfigured (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *status)
 Determines status of internal interface number which is configured as source port. More...
 
open_error_t openapiSwPortMonitorIsValidDestPort (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
 Checks validity of interface for a destination port. More...
 
open_error_t openapiSwPortMonitorIsValidSrcPort (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
 Checks validity of interface for a source port. More...
 
open_error_t openapiSwPortMonitorModeGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t *mode)
 Returns the Port Monitoring Mode for session "sessionNum". More...
 
open_error_t openapiSwPortMonitorModeSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t mode)
 Sets the Port Monitoring Mode for session "sessionNum". More...
 
open_error_t openapiSwPortMonitorSessionCount (openapiClientHandle_t *client_handle, uint32_t *sessionCount)
 Returns count of the sessiosns of Port Monitoring sessions. More...
 
open_error_t openapiSwPortMonitorSessionRemove (openapiClientHandle_t *client_handle, uint32_t sessionNum)
 Removes port monitoring configuration for session. More...
 
open_error_t openapiSwPortMonitorSourcePortAdd (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum, OPENAPI_MIRROR_DIRECTION_t probeType)
 Adds interface to the mirrored ports of session "sessionNum". More...
 
open_error_t openapiSwPortMonitorSourcePortRemove (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum)
 Remove interface from mirrored ports of session "sessionNum". More...
 
open_error_t openapiSwPortMonitorSourcePortsListGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *bufd)
 Returns list of source ports for session "sessionNum". More...
 
open_error_t openapiSwPortMonitorSrcConfiguredSessionGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *sessionNum)
 Returns the session in which internal interface number is configured as a source port. More...
 
open_error_t openapiSwPortMonitorValidDestIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
 Returns first valid interface that can be configured as destination port. More...
 
open_error_t openapiSwPortMonitorValidDestIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
 Returns list of valid interfaces that can be configured as destination port. More...
 
open_error_t openapiSwPortMonitorValidDestIntfNextGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum)
 Returns next valid interface that can be configured as destination port. More...
 
open_error_t openapiSwPortMonitorValidSrcIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
 Returns first valid interface that can be configured as source port. More...
 
open_error_t openapiSwPortMonitorValidSrcIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
 Returns list of valid interfaces that can be configured as source port. More...
 
open_error_t openapiSwPortMonitorValidSrcIntfNextGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum)
 Returns next valid interface that can be configured as source port. More...
 
open_error_t openapiSwRemoteMonitorDstVlanSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint16_t vlanId, OPEN_CONTROL_t updateAction)
 Sets the remote destination VLAN for session "sessionNum". More...
 
open_error_t openapiSwRemoteMonitorSrcVlanSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint16_t vlanId, OPEN_CONTROL_t updateAction)
 Sets the remote source VLAN for session "sessionNum". More...
 

Detailed Description

Enumeration Type Documentation

OpEN uses this enumeration to define ports traffic direction.

Enumerator
OPENAPI_MIRROR_UNCONFIGURED 

Traffic direction is unconfigured.

OPENAPI_MIRROR_BIDIRECTIONAL 

Traffic direction is bidirectional.

OPENAPI_MIRROR_INGRESS 

Traffic direction is ingress.

OPENAPI_MIRROR_EGRESS 

Traffic direction is egress.

OPENAPI_MIRROR_SFLOW 

Traffic direction is swlow.

Definition at line 45 of file openapi_mirror.h.

Function Documentation

open_error_t openapiMirrorIsRspanVlan ( openapiClientHandle_t client_handle,
uint32_t  vlanId,
OPEN_BOOL_t status 
)

Checks if the VLAN is a RSPAN VLAN.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]statusVLAN RSPAN status (true or false)
Return values
OPEN_E_NONEVLAN RSPAN status checked.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiMirrorIsSrcVlan ( openapiClientHandle_t client_handle,
uint32_t  vlanId,
OPEN_BOOL_t status 
)

Checks if the VLAN is source to any of the mirroring sessions.

Parameters
[in]client_handleclient handle from registration API
[in]vlanIdVLAN ID
[out]statusVLAN source status (true or false)
Return values
OPEN_E_NONEVLAN source status checked.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiMirrorSessionReserveStateGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
OPEN_CONTROL_t state 
)

Returns the Port Monitoring session "sessionNum" reserved state.

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]statemonitoring reserved state (enable or disable)
Return values
OPEN_E_NONEMonitoring reserved state returned.
OPEN_E_FAILFailed to get monitoring reserved state
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiMirrorSessionReserveStateSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
OPEN_CONTROL_t  state 
)

Sets the Port Monitoring session "sessionNum" reserved state.

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]statemonitoring reserved state (enable or disable)
Return values
OPEN_E_NONEPort Monitoring session reserved state set successful.
OPEN_E_FAILFailed to set Port Monitoring session reserved state.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiMirrorSourcePortDirectionGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t  intIfNum,
OPENAPI_MIRROR_DIRECTION_t probeType 
)

Returns the direction to be mirrored for a source port.

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]intIfNuminternal interface number
[out]probeTypedirection of traffic to be mirrored
Return values
OPEN_E_NONEDirection for a source port returned.
OPEN_E_FAILFailed to get direction for a source port.
OPEN_E_INTERNALInternal error
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiRemoteSpanVlanGet ( openapiClientHandle_t client_handle,
uint32_t *  rspanVlan 
)

Returns the RSPAN VLAN.

Parameters
[in]client_handleclient handle from registration API
[out]rspanVlanVLAN ID
Return values
OPEN_E_NONERSPAN VLAN returned.
OPEN_E_FAILFailed to get RSPAN VLAN
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiRemoteSpanVlanListGet ( openapiClientHandle_t client_handle,
open_buffdesc bufd 
)

Returns list of RSPAN VLAN.

Parameters
[in]client_handleclient handle from registration API
[out]bufdbuffer for outputting comma separated list of source ports
Return values
OPEN_E_NONELst of RSPAN VLAN returned.
OPEN_E_FAILFailed to get list of RSPAN VLAN.
OPEN_E_PARAMError in parameter passed.
OPEN_E_EMPTYList is empty.

OpEN API Version: 1.7

open_error_t openapiRemoteSpanVlanNextGet ( openapiClientHandle_t client_handle,
uint32_t  rspanVlan,
uint32_t *  rspanVlanNext 
)

Returns next configured RSPAN VLAN.

Parameters
[in]client_handleclient handle from registration API
[in]rspanVlanVLAN ID
[out]rspanVlanNextnext VLAN ID
Return values
OPEN_E_NONENext configured RSPAN VLAN returned.
OPEN_E_FAILFailed to get next configured RSPAN VLAN.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiRemoteSpanVlanSet ( openapiClientHandle_t client_handle,
uint32_t  rspanVlan,
OPEN_CONTROL_t  updateAction 
)

Sets the VLAN as RSPAN VLAN.

Parameters
[in]client_handleclient handle from registration API
[in]rspanVlanVLAN ID
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONEVLAN as RSPAN VLAN set successful.
OPEN_E_FAILFailed to set VLAN as RSPAN VLAN.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwMonitorDstTypeGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  mirrorDstType 
)

Returns the destination mirror type (Port based or VLAN based) for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]mirrorDstTypetype of mirroring
Return values
OPEN_E_NONEDestination mirror type returned.
OPEN_E_FAILFailed to get destination mirror type for the session.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwMonitorIpAclGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  ipAccessListNum 
)

Returns the IP ACL attached to the mirroring session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]ipAccessListNumIP access list number
Return values
OPEN_E_NONEIP ACL attached to the mirroring session returned.
OPEN_E_FAILFailed to get IP ACL attached to the mirroring session.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwMonitorIpAclSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t  ipAccessListNum,
OPEN_CONTROL_t  updateAction 
)

Attaches IP ACL to the mirroring session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]ipAccessListNumIP access list number to set
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONEIP ACL to the mirroring session attached successful.
OPEN_E_FAILFailed to attach IP ACL to the mirroring session.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwMonitorMacAclGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
open_buffdesc macAccessListName 
)

Returns the MAC ACL attached to the mirroring session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]macAccessListNameMAC access list name
-Minimum length OPENAPI_ACL_NAME_LEN_MIN
-Maximum length OPENAPI_ACL_NAME_LEN_MAX
Return values
OPEN_E_NONEMAC ACL attached to the mirroring session returned.
OPEN_E_FAILFailed to get MAC ACL attached to the mirroring session.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwMonitorMacAclSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
open_buffdesc macAccessListName,
OPEN_CONTROL_t  updateAction 
)

Attaches MAC ACL to the mirroring session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]macAccessListNameMAC access list name to attach
-Minimum length OPENAPI_ACL_NAME_LEN_MIN
-Maximum length OPENAPI_ACL_NAME_LEN_MAX
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONEMAC ACL to the mirroring session attached successful.
OPEN_E_FAILFailed to attach IP ACL to the mirroring session.
OPEN_E_INTERNALIP ACL is has already been attached to this session.
OPEN_E_ERRORMAC ACL does not exist.
OPEN_E_UNAVAILFeature is not supported.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwMonitorReflectorPortGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  intIfNum 
)

Returns Monitoring Reflector Port for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]intIfNuminterface number of reflector port
Return values
OPEN_E_NONEPort Monitoring Reflector Port returned.
OPEN_E_FAILFailed to get Port Monitoring Reflector Port.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwMonitorReflectorPortSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t  intIfNum,
OPEN_CONTROL_t  updateAction 
)

Sets Monitoring Reflector Port for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]intIfNuminternal interface number to set
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONEPort Monitoring Reflector Port set successful.
OPEN_E_FAILFailed to set Port Monitoring Reflector Port.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwMonitorRemoteDstVlanGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  remoteDstVlan 
)

Returns the remote destination VLAN for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]remoteDstVlanremote destination VLAN
Return values
OPEN_E_NONERemote destination VLAN returned.
OPEN_E_FAILFailed to get remote destination VLAN.
OPEN_E_PARAMError in parameter passed.
OPEN_E_EMPTYDestination VLAN isn't configured.

OpEN API Version: 1.7

open_error_t openapiSwMonitorRemoteSrcVlanGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  remoteSrcVlan 
)

Returns the remote source VLAN for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]remoteSrcVlanremote source VLAN
Return values
OPEN_E_NONERemote source VLAN returned.
OPEN_E_FAILFailed to get remote source VLAN.
OPEN_E_PARAMError in parameter passed.
OPEN_E_EMPTYSource VLAN isn't configured.

OpEN API Version: 1.7

open_error_t openapiSwMonitorSrcTypeGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  mirrorSrcType 
)

Returns the source mirror type(Port based or VLAN based) for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]mirrorSrcTypetype of mirroring
Return values
OPEN_E_NONESource mirror type returned.
OPEN_E_FAILFailed to get source mirror type for the session.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwMonitorVlanListGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
open_buffdesc bufd 
)

Returns the VLAN IDs for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]bufdbuffer for outputting comma separated list of attached VLANs
Return values
OPEN_E_NONEList of valid VLANs returned.
OPEN_E_FAILFailed to get list of valid VLANs.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwMonitorVlanListSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
open_buffdesc bufd,
OPEN_CONTROL_t  updateAction 
)

Sets the VLAN IDs for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]bufdstring buffer of comma separated list of vlans to set attached VLANs
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONEList of valid VLANs set successful.
OPEN_E_FAILFailed to set list of valid VLANs for the session.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorConfigRemove ( openapiClientHandle_t client_handle)

Removes port monitoring configuration for all sessions.

Parameters
[in]client_handleclient handle from registration API
Return values
OPEN_E_NONEMirroring config data is removed successfully.
OPEN_E_FAILFailed to remove destination mirroring config data.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorDestPortGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t *  intIfNum 
)

Returns Destination Port for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]intIfNuminternal destination interface number
Return values
OPEN_E_NONEDestination Port returned.
OPEN_E_FAILFailed to get Destination Port.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorDestPortRemove ( openapiClientHandle_t client_handle,
uint32_t  sessionNum 
)

Remove Destination Port of session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
Return values
OPEN_E_NONEDestination port is cleared.
OPEN_E_FAILFailed to clear destination port.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorDestPortSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t  intIfNum 
)

Sets Destination Port for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]intIfNumthe internal destibation interface number to set
Return values
OPEN_E_NONEDestination Port for session set successfully.
OPEN_E_FAILFailed to set Destination Port for session.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorIsDestConfigured ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  sessionNum,
OPEN_BOOL_t status 
)

Determines status of internal interface number which is configured as destination port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNumthe internal interface number
[out]sessionNumsession number
[out]statusinterface status (true or false)
Return values
OPEN_E_NONEStatus of interface determined successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorIsSrcConfigured ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
OPEN_BOOL_t status 
)

Determines status of internal interface number which is configured as source port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNumthe internal interface number
[out]statusinterface status (true or false)
Return values
OPEN_E_NONEStatus of interface determined successfully.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorIsValidDestPort ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
OPEN_BOOL_t valid 
)

Checks validity of interface for a destination port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNumthe internal interface number
[out]validvalidation status
Return values
OPEN_E_NONEValidity of interface checked.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorIsValidSrcPort ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
OPEN_BOOL_t valid 
)

Checks validity of interface for a source port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNumthe internal interface number
[out]validvalidation status
Return values
OPEN_E_NONEValidity of interface checked.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorModeGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
OPEN_CONTROL_t mode 
)

Returns the Port Monitoring Mode for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]modemonitoring mode (enable/disable)
Return values
OPEN_E_NONEPort Monitoring Mode returned.
OPEN_E_FAILFailed to get Port Monitoring Mode.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorModeSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
OPEN_CONTROL_t  mode 
)

Sets the Port Monitoring Mode for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]modemonitoring mode (enable/disable)
Return values
OPEN_E_NONEPort Monitoring Mode set successfully.
OPEN_E_FAILFailed to set Port Monitoring Mode.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorSessionCount ( openapiClientHandle_t client_handle,
uint32_t *  sessionCount 
)

Returns count of the sessiosns of Port Monitoring sessions.

Parameters
[in]client_handleclient handle from registration API
[out]sessionCountcount of the sessions
Return values
OPEN_E_NONECount of Port Monitoring sessions returned.
OPEN_E_PARAMError in parameter passed.
Note
It returns maximum number of sessions that can be configured.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorSessionRemove ( openapiClientHandle_t client_handle,
uint32_t  sessionNum 
)

Removes port monitoring configuration for session.

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
Return values
OPEN_E_NONESession removed successfully.
OPEN_E_FAILFailed to remove session.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorSourcePortAdd ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t  intIfNum,
OPENAPI_MIRROR_DIRECTION_t  probeType 
)

Adds interface to the mirrored ports of session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]intIfNuminternal interface number
[in]probeTypedirection of traffic to be mirrored
Return values
OPEN_E_NONEInterface added to the mirrored ports successfully.
OPEN_E_FAILFailed to add interface to the mirrored ports.
OPEN_E_INTERNALInternal error
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorSourcePortRemove ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint32_t  intIfNum 
)

Remove interface from mirrored ports of session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]intIfNuminternal interface number to be removed
Return values
OPEN_E_NONEInterface removed from source interface list.
OPEN_E_FAILFailed to remove interface from source interface list.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorSourcePortsListGet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
open_buffdesc bufd 
)

Returns list of source ports for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[out]bufdbuffer for outputting comma separated list of source ports. Must be at least OPENAPI_CLI_MAX_STRING_LENGTH bytes in length. Comma separated list of source ports.
Return values
OPEN_E_NONEList of source ports returned.
OPEN_E_FAILFailed to get list of source ports.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorSrcConfiguredSessionGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  sessionNum 
)

Returns the session in which internal interface number is configured as a source port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNumthe internal interface number
[out]sessionNumsession number
Return values
OPEN_E_NONESession number returned.
OPEN_E_FAILFailed to get session number.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorValidDestIntfFirstGet ( openapiClientHandle_t client_handle,
uint32_t *  intIfNum 
)

Returns first valid interface that can be configured as destination port.

Parameters
[in]client_handleclient handle from registration API
[out]intIfNuminternal interface number of first valid destination interface
Return values
OPEN_E_NONEFirst valid interface returned.
OPEN_E_FAILFailed to get first valid interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorValidDestIntfListGet ( openapiClientHandle_t client_handle,
open_buffdesc bufd 
)

Returns list of valid interfaces that can be configured as destination port.

Parameters
[in]client_handleclient handle from registration API
[out]bufdbuffer for outputting comma separated list of destination ports
Return values
OPEN_E_NONEList of valid interfaces returned.
OPEN_E_FAILFailed to get list of valid interfaces.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorValidDestIntfNextGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  nextIntIfNum 
)

Returns next valid interface that can be configured as destination port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNuminternal interface number of a valid destination port
[out]nextIntIfNuminternal interface number of next valid destination port
Return values
OPEN_E_NONENext valid interface returned.
OPEN_E_FAILFailed to get next valid interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorValidSrcIntfFirstGet ( openapiClientHandle_t client_handle,
uint32_t *  intIfNum 
)

Returns first valid interface that can be configured as source port.

Parameters
[in]client_handleclient handle from registration API
[out]intIfNuminternal interface number of first valid source interface
Return values
OPEN_E_NONEFirst valid interface returned.
OPEN_E_FAILFailed to get first valid interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorValidSrcIntfListGet ( openapiClientHandle_t client_handle,
open_buffdesc bufd 
)

Returns list of valid interfaces that can be configured as source port.

Parameters
[in]client_handleclient handle from registration API
[out]bufdbuffer for outputting comma separated list of source ports
Return values
OPEN_E_NONEList of valid interfaces returned.
OPEN_E_FAILFailed to get list of valid interfaces.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwPortMonitorValidSrcIntfNextGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  nextIntIfNum 
)

Returns next valid interface that can be configured as source port.

Parameters
[in]client_handleclient handle from registration API
[in]intIfNuminternal interface number of a valid source port
[out]nextIntIfNuminternal interface number of next valid source port
Return values
OPEN_E_NONENext valid interface returned.
OPEN_E_FAILFailed to get next valid interface.
OPEN_E_PARAMError in parameter passed.

OpEN API Version: 1.7

open_error_t openapiSwRemoteMonitorDstVlanSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint16_t  vlanId,
OPEN_CONTROL_t  updateAction 
)

Sets the remote destination VLAN for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]vlanIdremote destination VLAN to set
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONERemote destination VLAN set successful.
OPEN_E_FAILFailed to set remote destination VLAN.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7

open_error_t openapiSwRemoteMonitorSrcVlanSet ( openapiClientHandle_t client_handle,
uint32_t  sessionNum,
uint16_t  vlanId,
OPEN_CONTROL_t  updateAction 
)

Sets the remote source VLAN for session "sessionNum".

Parameters
[in]client_handleclient handle from registration API
[in]sessionNumsession number
[in]vlanIdset of Valid VLAN IDs to be added to the session
[in]updateActionaction to specify add/remove
Return values
OPEN_E_NONERemote source VLAN set successful.
OPEN_E_FAILFailed to set remote source VLAN.
OPEN_E_PARAMError in parameter passed.
Note
Calling this API will change the running configuration of the switch

OpEN API Version: 1.7