src/plugins/ioam/udp-ping/udp_ping.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2017 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 option version = "2.0.0";
  18
  19 /** \brief UDP-Probe Add/Delete request
  20     @param src_ip_address - Source ipv4/v6 address for the udp-ping flow
  21     @param dst_ip_address - Destination ipv4/v6 address for the udp-ping flow
  22     @param start_src_port - Starting source port of port range for udp-ping
  23     @param end_src_port - End source port of port range for udp-ping
  24     @param start_dst_port - Starting destination port of port range for udp-ping
  25     @param end_dst_port - End destination port of port range for udp-ping
  26     @param interval - Time interval in seconds at which udp-probe need to be sent
  27     @param is_ipv4 - To determine whether IPv4 or IPv6 address is used
  28     @param dis - TRUE is delete, FALSE if Add
  29 */
  30 autoreply define udp_ping_add_del {
  31   u32 client_index;
  32   u32 context;
  33   u8 src_ip_address[16];
  34   u8 dst_ip_address[16];
  35   u16 start_src_port;
  36   u16 end_src_port;
  37   u16 start_dst_port;
  38   u16 end_dst_port;
  39   u16 interval;
  40   u8 is_ipv4;
  41   u8 dis;
  42   u8 fault_det;
  43   u8 reserve[3];
  44 };
  45
  46 /** \brief Udp-probe export add/del request
  47     @param context - sender context, to match reply w/ request
  48     @param retval - return value for request
  49     @param enable - If TRUE then enable export else disable
  50 */
  51 autoreply define udp_ping_export {
  52    u32 client_index;
  53    u32 context;
  54    u32 enable;
  55 };
  56