src/plugins/tracenode/tracenode.api

   1 /*
   2  * Copyright (c) 2023 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "0.1.0";
  17
  18 import "vnet/interface_types.api";
  19
  20 /** \brief Enable/disable trace filtering feature
  21     @param client_index - opaque cookie to identify the sender
  22     @param context - sender context, to match reply w/ request
  23     @param sw_if_index - interface on which to enable/disable trace filtering feature
  24     @param is_pcap - if non-zero enable the feature for pcap capture, else for trace
  25     @param enable - if non-zero then enable the feature, else disable it
  26 */
  27 autoreply define tracenode_enable_disable
  28 {
  29   u32 client_index;
  30   u32 context;
  31   vl_api_interface_index_t sw_if_index;
  32   bool is_pcap [default=false];
  33   bool enable [default=true];
  34
  35   option vat_help = "tracenode_enable_disable <intfc> [disable] [pcap]";
  36 };
  37
  38 /*
  39  * Local Variables:
  40  * eval: (c-set-style "gnu")
  41  * End:
  42  */