src/vnet/cop/cop.api

   1 /*
   2  * Copyright (c) 2015-2016 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 = "1.0.0";
  17
  18  /** \brief cop: enable/disable junk filtration features on an interface
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param sw_if_inded - desired interface
  22     @param enable_disable - 1 => enable, 0 => disable
  23 */
  24
  25 autoreply define cop_interface_enable_disable
  26 {
  27   u32 client_index;
  28   u32 context;
  29   u32 sw_if_index;
  30   u8 enable_disable;
  31 };
  32
  33 /** \brief cop: enable/disable whitelist filtration features on an interface
  34     Note: the supplied fib_id must match in order to remove the feature!
  35
  36     @param client_index - opaque cookie to identify the sender
  37     @param context - sender context, to match reply w/ request
  38     @param sw_if_index - interface handle, physical interfaces only
  39     @param fib_id - fib identifier for the whitelist / blacklist fib
  40     @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
  41     @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
  42     @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
  43 */
  44
  45 autoreply define cop_whitelist_enable_disable
  46 {
  47   u32 client_index;
  48   u32 context;
  49   u32 sw_if_index;
  50   u32 fib_id;
  51   u8 ip4;
  52   u8 ip6;
  53   u8 default_cop;
  54 };
  55
  56 /** \brief get_node_graph - get a copy of the vpp node graph
  57     including the current set of graph arcs.
  58
  59     @param client_index - opaque cookie to identify the sender
  60     @param context - sender context, to match reply w/ request
  61 */
  62
  63  /*
  64  * Local Variables:
  65  * eval: (c-set-style "gnu")
  66  * End:
  67  */
  68