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.
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.
open_error_t	openapiMirrorSessionReserveStateGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t *state)
	Returns the Port Monitoring session "sessionNum" reserved state.
open_error_t	openapiMirrorSessionReserveStateSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t state)
	Sets the Port Monitoring session "sessionNum" reserved state.
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.
open_error_t	openapiRemoteSpanVlanGet (openapiClientHandle_t *client_handle, uint32_t *rspanVlan)
	Returns the RSPAN VLAN.
open_error_t	openapiRemoteSpanVlanListGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
	Returns list of RSPAN VLAN.
open_error_t	openapiRemoteSpanVlanNextGet (openapiClientHandle_t *client_handle, uint32_t rspanVlan, uint32_t *rspanVlanNext)
	Returns next configured RSPAN VLAN.
open_error_t	openapiRemoteSpanVlanSet (openapiClientHandle_t *client_handle, uint32_t rspanVlan, OPEN_CONTROL_t updateAction)
	Sets the VLAN as RSPAN VLAN.
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".
open_error_t	openapiSwMonitorIpAclGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *ipAccessListNum)
	Returns the IP ACL attached to the mirroring session "sessionNum".
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".
open_error_t	openapiSwMonitorMacAclGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *macAccessListName)
	Returns the MAC ACL attached to the mirroring session "sessionNum".
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".
open_error_t	openapiSwMonitorReflectorPortGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *intIfNum)
	Returns Monitoring Reflector Port for session "sessionNum".
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".
open_error_t	openapiSwMonitorRemoteDstVlanGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *remoteDstVlan)
	Returns the remote destination VLAN for session "sessionNum".
open_error_t	openapiSwMonitorRemoteSrcVlanGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *remoteSrcVlan)
	Returns the remote source VLAN for session "sessionNum".
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".
open_error_t	openapiSwMonitorVlanListGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *bufd)
	Returns the VLAN IDs for session "sessionNum".
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".
open_error_t	openapiSwPortMonitorConfigRemove (openapiClientHandle_t *client_handle)
	Removes port monitoring configuration for all sessions.
open_error_t	openapiSwPortMonitorDestPortGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t *intIfNum)
	Returns Destination Port for session "sessionNum".
open_error_t	openapiSwPortMonitorDestPortRemove (openapiClientHandle_t *client_handle, uint32_t sessionNum)
	Remove Destination Port of session "sessionNum".
open_error_t	openapiSwPortMonitorDestPortSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum)
	Sets Destination Port for session "sessionNum".
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.
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.
open_error_t	openapiSwPortMonitorIsValidDestPort (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
	Checks validity of interface for a destination port.
open_error_t	openapiSwPortMonitorIsValidSrcPort (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *valid)
	Checks validity of interface for a source port.
open_error_t	openapiSwPortMonitorModeGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t *mode)
	Returns the Port Monitoring Mode for session "sessionNum".
open_error_t	openapiSwPortMonitorModeSet (openapiClientHandle_t *client_handle, uint32_t sessionNum, OPEN_CONTROL_t mode)
	Sets the Port Monitoring Mode for session "sessionNum".
open_error_t	openapiSwPortMonitorSessionCount (openapiClientHandle_t *client_handle, uint32_t *sessionCount)
	Returns count of the sessiosns of Port Monitoring sessions.
open_error_t	openapiSwPortMonitorSessionRemove (openapiClientHandle_t *client_handle, uint32_t sessionNum)
	Removes port monitoring configuration for session.
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".
open_error_t	openapiSwPortMonitorSourcePortRemove (openapiClientHandle_t *client_handle, uint32_t sessionNum, uint32_t intIfNum)
	Remove interface from mirrored ports of session "sessionNum".
open_error_t	openapiSwPortMonitorSourcePortsListGet (openapiClientHandle_t *client_handle, uint32_t sessionNum, open_buffdesc *bufd)
	Returns list of source ports for session "sessionNum".
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.
open_error_t	openapiSwPortMonitorValidDestIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
	Returns first valid interface that can be configured as destination port.
open_error_t	openapiSwPortMonitorValidDestIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
	Returns list of valid interfaces that can be configured as destination port.
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.
open_error_t	openapiSwPortMonitorValidSrcIntfFirstGet (openapiClientHandle_t *client_handle, uint32_t *intIfNum)
	Returns first valid interface that can be configured as source port.
open_error_t	openapiSwPortMonitorValidSrcIntfListGet (openapiClientHandle_t *client_handle, open_buffdesc *bufd)
	Returns list of valid interfaces that can be configured as source port.
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.
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".
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".

Detailed Description

Enumeration Type Documentation

enum OPENAPI_MIRROR_DIRECTION_t

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_handle	client handle from registration API
[in]	vlanId	VLAN ID
[out]	status	VLAN RSPAN status (true or false)

Return values

OPEN_E_NONE	VLAN RSPAN status checked.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	vlanId	VLAN ID
[out]	status	VLAN source status (true or false)

Return values

OPEN_E_NONE	VLAN source status checked.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	state	monitoring reserved state (enable or disable)

Return values

OPEN_E_NONE	Monitoring reserved state returned.
OPEN_E_FAIL	Failed to get monitoring reserved state
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	state	monitoring reserved state (enable or disable)

Return values

OPEN_E_NONE	Port Monitoring session reserved state set successful.
OPEN_E_FAIL	Failed to set Port Monitoring session reserved state.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	intIfNum	internal interface number
[out]	probeType	direction of traffic to be mirrored

Return values

OPEN_E_NONE	Direction for a source port returned.
OPEN_E_FAIL	Failed to get direction for a source port.
OPEN_E_INTERNAL	Internal error
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	rspanVlan	VLAN ID

Return values

OPEN_E_NONE	RSPAN VLAN returned.
OPEN_E_FAIL	Failed to get RSPAN VLAN
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	bufd	buffer for outputting comma separated list of source ports

Return values

OPEN_E_NONE	Lst of RSPAN VLAN returned.
OPEN_E_FAIL	Failed to get list of RSPAN VLAN.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_EMPTY	List 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_handle	client handle from registration API
[in]	rspanVlan	VLAN ID
[out]	rspanVlanNext	next VLAN ID

Return values

OPEN_E_NONE	Next configured RSPAN VLAN returned.
OPEN_E_FAIL	Failed to get next configured RSPAN VLAN.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	rspanVlan	VLAN ID
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	VLAN as RSPAN VLAN set successful.
OPEN_E_FAIL	Failed to set VLAN as RSPAN VLAN.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	mirrorDstType	type of mirroring

Return values

OPEN_E_NONE	Destination mirror type returned.
OPEN_E_FAIL	Failed to get destination mirror type for the session.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	ipAccessListNum	IP access list number

Return values

OPEN_E_NONE	IP ACL attached to the mirroring session returned.
OPEN_E_FAIL	Failed to get IP ACL attached to the mirroring session.
OPEN_E_UNAVAIL	Feature is not supported.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	ipAccessListNum	IP access list number to set
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	IP ACL to the mirroring session attached successful.
OPEN_E_FAIL	Failed to attach IP ACL to the mirroring session.
OPEN_E_UNAVAIL	Feature is not supported.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	macAccessListName	MAC access list name
	-	Minimum length OPENAPI_ACL_NAME_LEN_MIN
	-	Maximum length OPENAPI_ACL_NAME_LEN_MAX

Return values

OPEN_E_NONE	MAC ACL attached to the mirroring session returned.
OPEN_E_FAIL	Failed to get MAC ACL attached to the mirroring session.
OPEN_E_UNAVAIL	Feature is not supported.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	macAccessListName	MAC access list name to attach
	-	Minimum length OPENAPI_ACL_NAME_LEN_MIN
	-	Maximum length OPENAPI_ACL_NAME_LEN_MAX
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	MAC ACL to the mirroring session attached successful.
OPEN_E_FAIL	Failed to attach IP ACL to the mirroring session.
OPEN_E_INTERNAL	IP ACL is has already been attached to this session.
OPEN_E_ERROR	MAC ACL does not exist.
OPEN_E_UNAVAIL	Feature is not supported.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	intIfNum	interface number of reflector port

Return values

OPEN_E_NONE	Port Monitoring Reflector Port returned.
OPEN_E_FAIL	Failed to get Port Monitoring Reflector Port.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	intIfNum	internal interface number to set
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	Port Monitoring Reflector Port set successful.
OPEN_E_FAIL	Failed to set Port Monitoring Reflector Port.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	remoteDstVlan	remote destination VLAN

Return values

OPEN_E_NONE	Remote destination VLAN returned.
OPEN_E_FAIL	Failed to get remote destination VLAN.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_EMPTY	Destination 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	remoteSrcVlan	remote source VLAN

Return values

OPEN_E_NONE	Remote source VLAN returned.
OPEN_E_FAIL	Failed to get remote source VLAN.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_EMPTY	Source 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	mirrorSrcType	type of mirroring

Return values

OPEN_E_NONE	Source mirror type returned.
OPEN_E_FAIL	Failed to get source mirror type for the session.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	bufd	buffer for outputting comma separated list of attached VLANs

Return values

OPEN_E_NONE	List of valid VLANs returned.
OPEN_E_FAIL	Failed to get list of valid VLANs.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	bufd	string buffer of comma separated list of vlans to set attached VLANs
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	List of valid VLANs set successful.
OPEN_E_FAIL	Failed to set list of valid VLANs for the session.
OPEN_E_PARAM	Error 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_handle

client handle from registration API

Return values

OPEN_E_NONE	Mirroring config data is removed successfully.
OPEN_E_FAIL	Failed to remove destination mirroring config data.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	intIfNum	internal destination interface number

Return values

OPEN_E_NONE	Destination Port returned.
OPEN_E_FAIL	Failed to get Destination Port.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number

Return values

OPEN_E_NONE	Destination port is cleared.
OPEN_E_FAIL	Failed to clear destination port.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	intIfNum	the internal destibation interface number to set

Return values

OPEN_E_NONE	Destination Port for session set successfully.
OPEN_E_FAIL	Failed to set Destination Port for session.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	the internal interface number
[out]	sessionNum	session number
[out]	status	interface status (true or false)

Return values

OPEN_E_NONE	Status of interface determined successfully.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	the internal interface number
[out]	status	interface status (true or false)

Return values

OPEN_E_NONE	Status of interface determined successfully.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	the internal interface number
[out]	valid	validation status

Return values

OPEN_E_NONE	Validity of interface checked.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	the internal interface number
[out]	valid	validation status

Return values

OPEN_E_NONE	Validity of interface checked.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	mode	monitoring mode (enable/disable)

Return values

OPEN_E_NONE	Port Monitoring Mode returned.
OPEN_E_FAIL	Failed to get Port Monitoring Mode.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	mode	monitoring mode (enable/disable)

Return values

OPEN_E_NONE	Port Monitoring Mode set successfully.
OPEN_E_FAIL	Failed to set Port Monitoring Mode.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	sessionCount	count of the sessions

Return values

OPEN_E_NONE	Count of Port Monitoring sessions returned.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number

Return values

OPEN_E_NONE	Session removed successfully.
OPEN_E_FAIL	Failed to remove session.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	intIfNum	internal interface number
[in]	probeType	direction of traffic to be mirrored

Return values

OPEN_E_NONE	Interface added to the mirrored ports successfully.
OPEN_E_FAIL	Failed to add interface to the mirrored ports.
OPEN_E_INTERNAL	Internal error
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	intIfNum	internal interface number to be removed

Return values

OPEN_E_NONE	Interface removed from source interface list.
OPEN_E_FAIL	Failed to remove interface from source interface list.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[out]	bufd	buffer 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_NONE	List of source ports returned.
OPEN_E_FAIL	Failed to get list of source ports.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	the internal interface number
[out]	sessionNum	session number

Return values

OPEN_E_NONE	Session number returned.
OPEN_E_FAIL	Failed to get session number.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	intIfNum	internal interface number of first valid destination interface

Return values

OPEN_E_NONE	First valid interface returned.
OPEN_E_FAIL	Failed to get first valid interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	bufd	buffer for outputting comma separated list of destination ports

Return values

OPEN_E_NONE	List of valid interfaces returned.
OPEN_E_FAIL	Failed to get list of valid interfaces.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	internal interface number of a valid destination port
[out]	nextIntIfNum	internal interface number of next valid destination port

Return values

OPEN_E_NONE	Next valid interface returned.
OPEN_E_FAIL	Failed to get next valid interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	intIfNum	internal interface number of first valid source interface

Return values

OPEN_E_NONE	First valid interface returned.
OPEN_E_FAIL	Failed to get first valid interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[out]	bufd	buffer for outputting comma separated list of source ports

Return values

OPEN_E_NONE	List of valid interfaces returned.
OPEN_E_FAIL	Failed to get list of valid interfaces.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	intIfNum	internal interface number of a valid source port
[out]	nextIntIfNum	internal interface number of next valid source port

Return values

OPEN_E_NONE	Next valid interface returned.
OPEN_E_FAIL	Failed to get next valid interface.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	vlanId	remote destination VLAN to set
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	Remote destination VLAN set successful.
OPEN_E_FAIL	Failed to set remote destination VLAN.
OPEN_E_PARAM	Error 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_handle	client handle from registration API
[in]	sessionNum	session number
[in]	vlanId	set of Valid VLAN IDs to be added to the session
[in]	updateAction	action to specify add/remove

Return values

OPEN_E_NONE	Remote source VLAN set successful.
OPEN_E_FAIL	Failed to set remote source VLAN.
OPEN_E_PARAM	Error in parameter passed.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.7