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
  22 /** \brief
  23     @param client_index - opaque cookie to identify the sender
  24     @param context - sender context, to match reply w/ request
  25     @param address - address to send arp request or gratuitous arp.
  26     @param sw_if_index - interface to send
  27     @param repeat - number of packets to send
  28     @param interval - if more than 1 packet is sent, the delay between send
  29     @param is_garp - is garp or arp request
  30 */
  31
  32 define arping
  33 {
  34   u32 client_index;
  35   u32 context;
  36   vl_api_address_t address;
  37   vl_api_interface_index_t sw_if_index;
  38   bool is_garp;
  39   u32 repeat [default=1];
  40   f64 interval [default=1.0];
  41   option vat_help = "<address> <interface> [gratuitouss] [repeat <count>] [interval <sec>]";
  42 };
  43
  44 /** \brief
  45     @param context - sender context, to match reply w/ request
  46     @param retval - return value for request
  47     @reply_count - return value for reply count
  48 */
  49
  50 define arping_reply
  51 {
  52   u32 context;
  53   i32 retval;
  54   u32 reply_count;
  55 };
  56
  57 /*
  58  * Local Variables:
  59  * eval: (c-set-style "gnu")
  60  * End:
  61  */