src/plugins/arping/arping.api

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2021 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
  18 option version = "1.0.0";
  19 import "vnet/interface_types.api";
  20 import "vnet/ip/ip_types.api";
  21 import "vnet/ethernet/ethernet_types.api";
  22
  23 /** \brief
  24     @param client_index - opaque cookie to identify the sender
  25     @param context - sender context, to match reply w/ request
  26     @param address - address to send arp request or gratuitous arp.
  27     @param sw_if_index - interface to send
  28     @param repeat - number of packets to send
  29     @param interval - if more than 1 packet is sent, the delay between send
  30     @param is_garp - is garp or arp request
  31 */
  32
  33 define arping
  34 {
  35   u32 client_index;
  36   u32 context;
  37   vl_api_address_t address;
  38   vl_api_interface_index_t sw_if_index;
  39   bool is_garp;
  40   u32 repeat [default=1];
  41   f64 interval [default=1.0];
  42   option vat_help = "<address> <interface> [gratuitouss] [repeat <count>] [interval <sec>]";
  43 };
  44
  45 /** \brief
  46     @param context - sender context, to match reply w/ request
  47     @param retval - return value for request
  48     @reply_count - return value for reply count
  49 */
  50
  51 define arping_reply
  52 {
  53   u32 context;
  54   i32 retval;
  55   u32 reply_count;
  56 };
  57
  58 /*
  59  * Address Conflict Detection
  60  */
  61 define arping_acd
  62 {
  63   u32 client_index;
  64   u32 context;
  65   vl_api_address_t address;
  66   vl_api_interface_index_t sw_if_index;
  67   bool is_garp;
  68   u32 repeat [default=1];
  69   f64 interval [default=1.0];
  70 };
  71
  72 define arping_acd_reply
  73 {
  74   u32 context;
  75   i32 retval;
  76   u32 reply_count;
  77   vl_api_mac_address_t mac_address;
  78 };
  79
  80 /*
  81  * Local Variables:
  82  * eval: (c-set-style "gnu")
  83  * End:
  84  */