Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_mirror.h
Go to the documentation of this file.
1 
9 /********************************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.?0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ********************************************************************************
26 *
27 * @filename openapi_mirror.h
28 *
29 * @purpose Provide interface to Port Mirroring APIs
30 *
31 * @component OpEN
32 *
33 * @create 06/08/2015
34 *
35 * @end
36 *
37 ********************************************************************************/
38 #ifndef OPENAPI_MIRROR_H_INCLUDED
39 #define OPENAPI_MIRROR_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
45 typedef enum
46 {
47  OPENAPI_MIRROR_UNCONFIGURED = 0,
48  OPENAPI_MIRROR_BIDIRECTIONAL = 1,
49  OPENAPI_MIRROR_INGRESS = 2,
50  OPENAPI_MIRROR_EGRESS = 3,
51  OPENAPI_MIRROR_SFLOW = 4
52 } OPENAPI_MIRROR_DIRECTION_t;
53 
54 /***************************************************************************/
71 open_error_t openapiSwPortMonitorSourcePortsListGet(openapiClientHandle_t * client_handle,
72  uint32_t sessionNum,
73  open_buffdesc * bufd);
74 
75 /*****************************************************************/
92 open_error_t openapiMirrorSourcePortDirectionGet(openapiClientHandle_t * client_handle,
93  uint32_t sessionNum,
94  uint32_t intIfNum,
95  OPENAPI_MIRROR_DIRECTION_t * probeType);
96 
97 /****************************************************************************/
115 open_error_t openapiSwPortMonitorSourcePortAdd(openapiClientHandle_t * client_handle,
116  uint32_t sessionNum,
117  uint32_t intIfNum,
118  OPENAPI_MIRROR_DIRECTION_t probeType);
119 
120 /****************************************************************************/
137 open_error_t openapiSwPortMonitorSourcePortRemove(openapiClientHandle_t * client_handle,
138  uint32_t sessionNum,
139  uint32_t intIfNum);
140 
141 /***************************************************************************/
156 open_error_t openapiSwPortMonitorDestPortGet(openapiClientHandle_t * client_handle,
157  uint32_t sessionNum,
158  uint32_t *intIfNum);
159 
160 /****************************************************************************/
177 open_error_t openapiSwPortMonitorDestPortSet(openapiClientHandle_t * client_handle,
178  uint32_t sessionNum,
179  uint32_t intIfNum);
180 
181 /****************************************************************************/
196 open_error_t openapiSwPortMonitorDestPortRemove(openapiClientHandle_t * client_handle,
197  uint32_t sessionNum);
198 
199 /*****************************************************************************/
214 open_error_t openapiSwPortMonitorModeGet(openapiClientHandle_t * client_handle,
215  uint32_t sessionNum,
216  OPEN_CONTROL_t * mode);
217 
218 /****************************************************************************/
234 open_error_t openapiSwPortMonitorModeSet(openapiClientHandle_t * client_handle,
235  uint32_t sessionNum,
236  OPEN_CONTROL_t mode);
237 
238 /*****************************************************************************/
252 open_error_t openapiSwPortMonitorSessionCount(openapiClientHandle_t * client_handle,
253  uint32_t * sessionCount);
254 
255 /****************************************************************************/
269 open_error_t openapiSwPortMonitorConfigRemove(openapiClientHandle_t * client_handle);
270 
271 /****************************************************************************/
286 open_error_t openapiSwPortMonitorSessionRemove(openapiClientHandle_t * client_handle,
287  uint32_t sessionNum);
288 
289 /*****************************************************************************/
305 open_error_t openapiSwPortMonitorIsDestConfigured(openapiClientHandle_t * client_handle,
306  uint32_t intIfNum,
307  uint32_t * sessionNum,
308  OPEN_BOOL_t * status);
309 
310 /*****************************************************************************/
325 open_error_t openapiSwPortMonitorIsSrcConfigured(openapiClientHandle_t * client_handle,
326  uint32_t intIfNum,
327  OPEN_BOOL_t * status);
328 
329 /*****************************************************************************/
345 open_error_t openapiSwPortMonitorSrcConfiguredSessionGet(openapiClientHandle_t * client_handle,
346  uint32_t intIfNum,
347  uint32_t * sessionNum);
348 
349 /*****************************************************************************/
363 open_error_t openapiSwPortMonitorIsValidSrcPort(openapiClientHandle_t * client_handle,
364  uint32_t intIfNum,
365  OPEN_BOOL_t * valid);
366 
367 /*****************************************************************************/
381 open_error_t openapiSwPortMonitorIsValidDestPort(openapiClientHandle_t * client_handle,
382  uint32_t intIfNum,
383  OPEN_BOOL_t * valid);
384 
385 /*****************************************************************************/
400 open_error_t openapiSwPortMonitorValidSrcIntfFirstGet(openapiClientHandle_t * client_handle,
401  uint32_t * intIfNum);
402 
403 /*****************************************************************************/
420 open_error_t openapiSwPortMonitorValidSrcIntfNextGet(openapiClientHandle_t * client_handle,
421  uint32_t intIfNum,
422  uint32_t * nextIntIfNum);
423 
424 /*****************************************************************************/
438 open_error_t openapiSwPortMonitorValidSrcIntfListGet(openapiClientHandle_t * client_handle,
439  open_buffdesc * bufd);
440 
441 /*****************************************************************************/
456 open_error_t openapiSwPortMonitorValidDestIntfFirstGet(openapiClientHandle_t * client_handle,
457  uint32_t * intIfNum);
458 
459 /*****************************************************************************/
476 open_error_t openapiSwPortMonitorValidDestIntfNextGet(openapiClientHandle_t * client_handle,
477  uint32_t intIfNum,
478  uint32_t *nextIntIfNum);
479 
480 /*****************************************************************************/
494 open_error_t openapiSwPortMonitorValidDestIntfListGet(openapiClientHandle_t * client_handle,
495  open_buffdesc * bufd);
496 
497 /*****************************************************************************/
513 open_error_t openapiSwMonitorVlanListGet(openapiClientHandle_t * client_handle,
514  uint32_t sessionNum,
515  open_buffdesc * bufd);
516 
517 /****************************************************************************/
535 open_error_t openapiSwMonitorVlanListSet(openapiClientHandle_t * client_handle,
536  uint32_t sessionNum,
537  open_buffdesc * bufd,
538  OPEN_CONTROL_t updateAction);
539 
540 /*****************************************************************************/
556 open_error_t openapiSwMonitorSrcTypeGet(openapiClientHandle_t * client_handle,
557  uint32_t sessionNum,
558  uint32_t * mirrorSrcType);
559 
560 /*****************************************************************************/
576 open_error_t openapiSwMonitorDstTypeGet(openapiClientHandle_t * client_handle,
577  uint32_t sessionNum,
578  uint32_t * mirrorDstType);
579 
580 /*****************************************************************************/
596 open_error_t openapiSwMonitorRemoteSrcVlanGet(openapiClientHandle_t * client_handle,
597  uint32_t sessionNum,
598  uint32_t * remoteSrcVlan);
599 
600 /****************************************************************************/
618 open_error_t openapiSwRemoteMonitorSrcVlanSet(openapiClientHandle_t * client_handle,
619  uint32_t sessionNum,
620  uint16_t vlanId,
621  OPEN_CONTROL_t updateAction);
622 
623 /*****************************************************************************/
639 open_error_t openapiSwMonitorRemoteDstVlanGet(openapiClientHandle_t * client_handle,
640  uint32_t sessionNum,
641  uint32_t * remoteDstVlan);
642 
643 /****************************************************************************/
660 open_error_t openapiSwRemoteMonitorDstVlanSet(openapiClientHandle_t * client_handle,
661  uint32_t sessionNum,
662  uint16_t vlanId,
663  OPEN_CONTROL_t updateAction);
664 
665 /*****************************************************************************/
680 open_error_t openapiSwMonitorReflectorPortGet(openapiClientHandle_t * client_handle,
681  uint32_t sessionNum,
682  uint32_t * intIfNum);
683 
684 /****************************************************************************/
701 open_error_t openapiSwMonitorReflectorPortSet(openapiClientHandle_t * client_handle,
702  uint32_t sessionNum,
703  uint32_t intIfNum,
704  OPEN_CONTROL_t updateAction);
705 
706 /*****************************************************************************/
723 open_error_t openapiSwMonitorIpAclGet(openapiClientHandle_t * client_handle,
724  uint32_t sessionNum,
725  uint32_t * ipAccessListNum);
726 
727 /****************************************************************************/
745 open_error_t openapiSwMonitorIpAclSet(openapiClientHandle_t * client_handle,
746  uint32_t sessionNum,
747  uint32_t ipAccessListNum,
748  OPEN_CONTROL_t updateAction);
749 
750 /*****************************************************************************/
769 open_error_t openapiSwMonitorMacAclGet(openapiClientHandle_t * client_handle,
770  uint32_t sessionNum,
771  open_buffdesc * macAccessListName);
772 
773 /****************************************************************************/
795 open_error_t openapiSwMonitorMacAclSet(openapiClientHandle_t * client_handle,
796  uint32_t sessionNum,
797  open_buffdesc * macAccessListName,
798  OPEN_CONTROL_t updateAction);
799 
800 /*****************************************************************************/
814 open_error_t openapiRemoteSpanVlanGet(openapiClientHandle_t * client_handle,
815  uint32_t * rspanVlan);
816 
817 /*****************************************************************************/
832 open_error_t openapiRemoteSpanVlanNextGet(openapiClientHandle_t * client_handle,
833  uint32_t rspanVlan,
834  uint32_t * rspanVlanNext);
835 
836 /*****************************************************************************/
851 open_error_t openapiRemoteSpanVlanListGet(openapiClientHandle_t * client_handle,
852  open_buffdesc * bufd);
853 
854 /****************************************************************************/
870 open_error_t openapiRemoteSpanVlanSet(openapiClientHandle_t * client_handle,
871  uint32_t rspanVlan,
872  OPEN_CONTROL_t updateAction);
873 
874 /*****************************************************************************/
888 open_error_t openapiMirrorIsRspanVlan(openapiClientHandle_t * client_handle,
889  uint32_t vlanId,
890  OPEN_BOOL_t * status);
891 
892 /*****************************************************************************/
906 open_error_t openapiMirrorIsSrcVlan(openapiClientHandle_t * client_handle,
907  uint32_t vlanId,
908  OPEN_BOOL_t * status);
909 
910 /*****************************************************************************/
925 open_error_t openapiMirrorSessionReserveStateGet(openapiClientHandle_t * client_handle,
926  uint32_t sessionNum,
927  OPEN_CONTROL_t * state);
928 
929 /****************************************************************************/
945 open_error_t openapiMirrorSessionReserveStateSet(openapiClientHandle_t * client_handle,
946  uint32_t sessionNum,
947  OPEN_CONTROL_t state);
948 #endif /* OPENAPI_MIRROR_H_INCLUDED */
949