src/plugins/nsim/nsim.api

   1 /**
   2  * @file nsim.api
   3  * @brief VPP control-plane API messages for the network delay simulator
   4  */
   5
   6 option version = "2.2.1";
   7 import "vnet/interface_types.api";
   8
   9 /** \brief enable / disable the network delay simulation cross-connect
  10     @param client_index - opaque cookie to identify the sender
  11     @param context - sender context, to match reply w/ request
  12     @param enable_disable - enable or disable the feature
  13     @param sw_if_index0 - one interface to cross-connect
  14     @param sw_if_index1 - the other interface to cross-connect
  15 */
  16 autoreply define nsim_cross_connect_enable_disable
  17 {
  18   /* Client identifier, set from api_main.my_client_index */
  19   u32 client_index;
  20
  21   /* Arbitrary context, so client can match reply to request */
  22   u32 context;
  23
  24   /* Enable / disable the feature on the interfaces */
  25   bool enable_disable;
  26
  27   /* Interface handles */
  28   vl_api_interface_index_t sw_if_index0;
  29   vl_api_interface_index_t sw_if_index1;
  30   option vat_help = "[<intfc0> | sw_if_index <swif0>] [<intfc1> | sw_if_index <swif1>] [disable]";
  31 };
  32
  33 /** \brief enable / disable the network delay simulation output feature
  34     @param client_index - opaque cookie to identify the sender
  35     @param context - sender context, to match reply w/ request
  36     @param enable_disable - enable or disable the feature
  37     @param sw_if_index0 - interface
  38 */
  39 autoreply define nsim_output_feature_enable_disable
  40 {
  41   /* Client identifier, set from api_main.my_client_index */
  42   u32 client_index;
  43
  44   /* Arbitrary context, so client can match reply to request */
  45   u32 context;
  46
  47   /* Enable / disable the feature on the interfaces */
  48   bool enable_disable;
  49
  50   /* Interface handles */
  51   vl_api_interface_index_t sw_if_index;
  52   option vat_help = "[<intfc> | sw_if_index <nnn> [disable]";
  53 };
  54
  55 /** \brief configure the network delay simulation cross-connect
  56     @param client_index - opaque cookie to identify the sender
  57     @param context - sender context, to match reply w/ request
  58     @param delay_in_usec - microseconds of link delay to simulate
  59     @param average_packet_size - average packet size for wheel sizing
  60     @param bandwidth_in_bits_per_second - bps for wheel sizing
  61 */
  62 autoreply define nsim_configure
  63 {
  64   option deprecated;
  65   /* Client identifier, set from api_main.my_client_index */
  66   u32 client_index;
  67
  68   /* Arbitrary context, so client can match reply to request */
  69   u32 context;
  70
  71   /* Configuration parameters */
  72   u32 delay_in_usec;
  73   u32 average_packet_size;
  74   u64 bandwidth_in_bits_per_second;
  75   u32 packets_per_drop;
  76   option vat_help = "delay <time> bandwidth <bw> [packet-size <nn>] [packets-per-drop <nnnn>]";
  77 };
  78
  79 /** \brief configure the network delay simulation cross-connect
  80     @param client_index - opaque cookie to identify the sender
  81     @param context - sender context, to match reply w/ request
  82     @param delay_in_usec - microseconds of link delay to simulate
  83     @param average_packet_size - average packet size for wheel sizing
  84     @param bandwidth_in_bits_per_second - bps for wheel sizing
  85 */
  86 autoreply define nsim_configure2
  87 {
  88   /* Client identifier, set from api_main.my_client_index */
  89   u32 client_index;
  90
  91   /* Arbitrary context, so client can match reply to request */
  92   u32 context;
  93
  94   /* Configuration parameters */
  95   u32 delay_in_usec;
  96   u32 average_packet_size;
  97   u64 bandwidth_in_bits_per_second;
  98   u32 packets_per_drop;
  99   u32 packets_per_reorder;
 100   option vat_help = "delay <time> bandwidth <bw> [packet-size <nn>] [packets-per-drop <nnnn>]";
 101 };
 102