mactime: remove api boilerplate
[vpp.git] / src / plugins / mactime / mactime.api
index 7cad782..edad2c4 100644 (file)
  */
 
 /** \file
-    This file defines vpp mactime control-plane API messages 
+    This file defines vpp mactime control-plane API messages
 */
-option version = "1.0.0";
+option version = "1.1.1";
 
-/** \brief api to enable or disable the time-based src mac filter on 
+/** \brief api to enable or disable the time-based src mac filter on
     an interface
 */
 
-autoreply define mactime_enable_disable 
+autoreply define mactime_enable_disable
 {
   u32 client_index;             /**< client index, from api_main */
   u32 context;                  /**< application context */
   u8 enable_disable;            /**< enable=1, disable=0 */
   u32 sw_if_index;              /**< the interface handle  */
+  option vat_help = "<intfc> [disable]";
 };
 
 /** \brief a time range structure
- * times are in double-precision fp seconds since 1/1/1970, 
+ * times are in double-precision fp seconds since 1/1/1970,
  * which was a Thursday.
  */
-typeonly define time_range
+typedef time_range
 {
   f64 start;                    /**< start of the time range  */
   f64 end;                      /**< end of the time range */
-}; 
+};
 
 /** \brief configure per src-mac time ranges
  *
@@ -54,9 +55,9 @@ typeonly define time_range
  *   set count = number of ranges
  *   set each range start/end in seconds since Sunday began
  *   As in: start/end >= 0.0 && start/end < 7.0 *86400.0
- * 
+ *
  *  to create a (time-range-based) dynamic drop entry:
- *   Same procedure to create a dynamic allow entry, 
+ *   Same procedure to create a dynamic allow entry,
  *   set drop=1 instead of allow=1
  *
  *  to delete a per src-mac entry (of any kind)
@@ -74,11 +75,15 @@ autoreply define mactime_add_del_range
   u8 is_add;                    /**< add=1, del=0  */
   u8 drop;                      /**< drop flag */
   u8 allow;                     /**< allow flag */
+  u8 allow_quota;               /**< allow subject to quota */
+  u8 no_udp_10001;              /**< drop udp to port 10001 */
+  u64 data_quota;              /**< max bytes this device */
   u8 mac_address[6];            /**< src mac address */
   u8 device_name[64];           /**< device name */
   u32 count;                    /**< number of time ranges to follow */
   /** time ranges, in seconds since Sunday began */
-  vl_api_time_range_t ranges[count]; 
+  vl_api_time_range_t ranges[count];
+  option vat_help = "name <devname> mac <mac-addr> allow drop allow-range Mon - Fri 9:00 - 17:00";
 };
 
 /*