Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
openapi_mirror.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

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...