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  /** \brief Enable/Disable span to mirror traffic from one interface to another
  18     @param client_index - opaque cookie to identify the sender
  19     @param context - sender context which was passed in the request
  20     @param sw_if_index_from - interface to be mirorred
  21     @param sw_if_index_to - interface where the traffic is mirrored
  22     @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
  23 */
  24 define sw_interface_span_enable_disable {
  25     u32 client_index;
  26     u32 context;
  27     u32 sw_if_index_from;
  28     u32 sw_if_index_to;
  29     u8  state;
  30 };
  31
  32 /** \brief Reply to SPAN enable/disable request
  33     @param context - sender context which was passed in the request
  34 */
  35 define sw_interface_span_enable_disable_reply {
  36     u32 context;
  37     i32 retval;
  38 };
  39
  40 /** \brief SPAN dump request
  41     @param client_index - opaque cookie to identify the sender
  42     @param context - sender context, to match reply w/ request
  43 */
  44 define sw_interface_span_dump {
  45     u32 client_index;
  46     u32 context;
  47 };
  48
  49 /** \brief Reply to SPAN dump request
  50     @param context - sender context which was passed in the request
  51     @param sw_if_index_from - mirorred interface
  52     @param sw_if_index_to - interface where the traffic is mirrored
  53     @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
  54 */
  55 define sw_interface_span_details {
  56     u32 context;
  57     u32 sw_if_index_from;
  58     u32 sw_if_index_to;
  59     u8 state;
  60 };