src/vnet/span/span.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2016 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 option version = "1.0.0";
  18
  19  /** \brief Enable/Disable span to mirror traffic from one interface to another
  20     @param client_index - opaque cookie to identify the sender
  21     @param context - sender context which was passed in the request
  22     @param sw_if_index_from - interface to be mirrored
  23     @param sw_if_index_to - interface where the traffic is mirrored
  24     @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
  25     @param is_l2 - 0 = mirror at hw device level, 1 = mirror at L2
  26 */
  27 autoreply define sw_interface_span_enable_disable {
  28     u32 client_index;
  29     u32 context;
  30     u32 sw_if_index_from;
  31     u32 sw_if_index_to;
  32     u8  state;
  33     u8  is_l2;
  34 };
  35
  36 /** \brief SPAN dump request
  37     @param client_index - opaque cookie to identify the sender
  38     @param context - sender context, to match reply w/ request
  39     @param is_l2 - 0 = hw device level, 1 = L2
  40 */
  41 define sw_interface_span_dump {
  42     u32 client_index;
  43     u32 context;
  44     u8 is_l2;
  45 };
  46
  47 /** \brief Reply to SPAN dump request
  48     @param context - sender context which was passed in the request
  49     @param sw_if_index_from - mirrored interface
  50     @param sw_if_index_to - interface where the traffic is mirrored
  51     @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
  52     @param is_l2 - 0 = mirrored at hw device level, 1 = mirrored at l2
  53 */
  54 define sw_interface_span_details {
  55     u32 context;
  56     u32 sw_if_index_from;
  57     u32 sw_if_index_to;
  58     u8 state;
  59     u8 is_l2;
  60 };