VPPAPIGEN: vppapigen replacement in Python PLY.
[vpp.git] / src / vnet / lisp-cp / one.api
index 7cc9068..32ac702 100644 (file)
@@ -13,6 +13,8 @@
  * limitations under the License.
  */
 
+option version = "1.0.0";
+
 typeonly manual_print manual_endian define one_local_locator
 {
   u32 sw_if_index;
@@ -59,7 +61,7 @@ define one_add_del_locator_set_reply
     @param priority - priority of the locator
     @param weight - weight of the locator
 */
-define one_add_del_locator
+autoreply define one_add_del_locator
 {
   u32 client_index;
   u32 context;
@@ -70,16 +72,6 @@ define one_add_del_locator
   u8 weight;
 };
 
-/** \brief Reply for locator add/del
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_add_del_locator_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief add or delete ONE eid-table
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -98,7 +90,7 @@ define one_add_del_locator_reply
       HMAC_SHA_256_128      2
     @param key - secret key
 */
-define one_add_del_local_eid
+autoreply define one_add_del_local_eid
 {
   u32 client_index;
   u32 context;
@@ -112,50 +104,48 @@ define one_add_del_local_eid
   u8 key[64];
 };
 
-/** \brief Reply for local_eid add/del
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
+/** \brief Set TTL for map register messages
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param ttl - time to live
 */
-define one_add_del_local_eid_reply
+autoreply define one_map_register_set_ttl
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+  u32 ttl;
 };
 
-/** \brief Add/delete map server
+/** \brief Get TTL for map register messages
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param is_add - add address if non-zero; delete otherwise
-    @param is_ipv6 - if non-zero the address is ipv6, else ipv4
-    @param ip_address - map server IP address
 */
-define one_add_del_map_server
+define show_one_map_register_ttl
 {
   u32 client_index;
   u32 context;
-  u8 is_add;
-  u8 is_ipv6;
-  u8 ip_address[16];
 };
 
-/** \brief Reply for one_add_del_map_server
-    @param context - returned sender context, to match reply w/ request
+/** \brief Contains current TTL for map register messages
+    @param client_index - opaque cookie to identify the sender
     @param retval - return code
+    @param ttl - time to live
 */
-define one_add_del_map_server_reply
+define show_one_map_register_ttl_reply
 {
   u32 context;
   i32 retval;
+  u32 ttl;
 };
 
-/** \brief add or delete map-resolver
+/** \brief Add/delete map server
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param is_add - add address if non-zero, else delete
+    @param is_add - add address if non-zero; delete otherwise
     @param is_ipv6 - if non-zero the address is ipv6, else ipv4
-    @param ip_address - array of address bytes
+    @param ip_address - map server IP address
 */
-define one_add_del_map_resolver
+autoreply define one_add_del_map_server
 {
   u32 client_index;
   u32 context;
@@ -164,14 +154,20 @@ define one_add_del_map_resolver
   u8 ip_address[16];
 };
 
-/** \brief Reply for map_resolver add/del
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
+/** \brief add or delete map-resolver
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_add - add address if non-zero, else delete
+    @param is_ipv6 - if non-zero the address is ipv6, else ipv4
+    @param ip_address - array of address bytes
 */
-define one_add_del_map_resolver_reply
+autoreply define one_add_del_map_resolver
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+  u8 is_add;
+  u8 is_ipv6;
+  u8 ip_address[16];
 };
 
 /** \brief enable or disable ONE feature
@@ -179,21 +175,25 @@ define one_add_del_map_resolver_reply
     @param context - sender context, to match reply w/ request
     @param is_en - enable protocol if non-zero, else disable
 */
-define one_enable_disable
+autoreply define one_enable_disable
 {
   u32 client_index;
   u32 context;
   u8 is_en;
 };
 
-/** \brief Reply for gpe enable/disable
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
+/** \brief configure or delete ONE NSH mapping
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param ls_name - locator set name
+    @param is_add - add locator set if non-zero; delete otherwise
 */
-define one_enable_disable_reply
+autoreply define one_nsh_set_locator_set
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+  u8 is_add;
+  u8 ls_name[64];
 };
 
 /** \brief configure or disable ONE PITR node
@@ -202,7 +202,7 @@ define one_enable_disable_reply
     @param ls_name - locator set name
     @param is_add - add locator set if non-zero, else disable pitr
 */
-define one_pitr_set_locator_set
+autoreply define one_pitr_set_locator_set
 {
   u32 client_index;
   u32 context;
@@ -210,16 +210,6 @@ define one_pitr_set_locator_set
   u8 ls_name[64];
 };
 
-/** \brief Reply for one_pitr_set_locator_set
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_pitr_set_locator_set_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief configure or disable use of PETR
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -227,7 +217,7 @@ define one_pitr_set_locator_set_reply
     @param address - PETR IP address
     @param is_add - add locator set if non-zero, else disable PETR
 */
-define one_use_petr
+autoreply define one_use_petr
 {
   u32 client_index;
   u32 context;
@@ -236,16 +226,6 @@ define one_use_petr
   u8 is_add;
 };
 
-/** \brief Reply for one_use_petr
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_use_petr_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Request for ONE PETR status
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -298,45 +278,25 @@ define show_one_rloc_probe_state_reply
     @param context - sender context, to match reply w/ request
     @param is_enable - enable if non-zero; disable otherwise
 */
-define one_rloc_probe_enable_disable
+autoreply define one_rloc_probe_enable_disable
 {
   u32 client_index;
   u32 context;
   u8 is_enabled;
 };
 
-/** \brief Reply for one_rloc_probe_enable_disable
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_rloc_probe_enable_disable_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief enable/disable ONE map-register
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param is_enable - enable if non-zero; disable otherwise
 */
-define one_map_register_enable_disable
+autoreply define one_map_register_enable_disable
 {
   u32 client_index;
   u32 context;
   u8 is_enabled;
 };
 
-/** \brief Reply for one_map_register_enable_disable
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_map_register_enable_disable_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Get state of ONE map-register
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -366,23 +326,13 @@ define show_one_map_register_state_reply
       0 - destination only
       1 - source/destaination
 */
-define one_map_request_mode
+autoreply define one_map_request_mode
 {
   u32 client_index;
   u32 context;
   u8 mode;
 };
 
-/** \brief Reply for one_map_request_mode
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_map_request_mode_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Request for ONE map-request mode
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -425,12 +375,18 @@ typeonly manual_endian manual_print define one_remote_locator
       0 : ipv4
       1 : ipv6
       2 : mac
+      3 : NSH : both information (service path ID and service index) are
+        encoded in 'eid' field in a following way:
+
+        |4 B |1 B |
+        -----------
+        |SPI | SI |
     @param deid - dst EID
     @param seid - src EID, valid only if is_src_dst is enabled
     @param rloc_num - number of remote locators
     @param rlocs - remote locator records
 */
-manual_print manual_endian define one_add_del_remote_mapping
+autoreply manual_print manual_endian define one_add_del_remote_mapping
 {
   u32 client_index;
   u32 context;
@@ -448,14 +404,158 @@ manual_print manual_endian define one_add_del_remote_mapping
   vl_api_one_remote_locator_t rlocs[rloc_num];
 };
 
-/** \brief Reply for one_add_del_remote_mapping
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
+/** \brief Add/delete L2 ARP entries
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_add - add if non-zero; delete otherwise
+    @param bd - bridge domain
+    @param mac - MAC address
+    @param ip4 - IPv4 address
+*/
+autoreply define one_add_del_l2_arp_entry
+{
+  u32 client_index;
+  u32 context;
+  u8 is_add;
+  u8 mac[6];
+  u32 bd;
+  u32 ip4;
+};
+
+/** \brief Request for L2 ARP entries from specified bridge domain
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param bd - bridge domain
+*/
+define one_l2_arp_entries_get
+{
+  u32 client_index;
+  u32 context;
+  u32 bd;
+};
+
+typeonly manual_print manual_endian define one_l2_arp_entry
+{
+  u8 mac[6];
+  u32 ip4;
+};
+
+/** \brief Reply with L2 ARP entries from specified bridge domain
+    @param context - sender context, to match reply w/ request
+    @param retval - error code
+    @param count - number of elements in the list
+    @param vl_api_one_arp_entry_t - list of entries
 */
-define one_add_del_remote_mapping_reply
+manual_print manual_endian define one_l2_arp_entries_get_reply
+{
+  u32 context;
+  i32 retval;
+  u32 count;
+  vl_api_one_l2_arp_entry_t entries[count];
+};
+
+autoreply define one_add_del_ndp_entry
+{
+  u32 client_index;
+  u32 context;
+  u8 is_add;
+  u8 mac[6];
+  u32 bd;
+  u8 ip6[16];
+};
+
+define one_ndp_entries_get
+{
+  u32 client_index;
+  u32 context;
+  u32 bd;
+};
+
+typeonly manual_print manual_endian define one_ndp_entry
+{
+  u8 mac[6];
+  u8 ip6[16];
+};
+
+manual_print manual_endian define one_ndp_entries_get_reply
 {
   u32 context;
   i32 retval;
+  u32 count;
+  vl_api_one_ndp_entry_t entries[count];
+};
+
+/** \brief Set ONE transport protocol
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param protocol - supported vaules:
+      1: UDP based LISP (default)
+      2: binary API
+*/
+autoreply define one_set_transport_protocol
+{
+  u32 client_index;
+  u32 context;
+  u8 protocol;
+};
+
+define one_get_transport_protocol
+{
+  u32 client_index;
+  u32 context;
+};
+
+define one_get_transport_protocol_reply
+{
+  u32 context;
+  i32 retval;
+  u8 protocol;
+};
+
+/** \brief Request for list of bridge domains used by neighbor discovery
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define one_ndp_bd_get
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Reply with list of bridge domains used by neighbor discovery
+    @param context - sender context, to match reply w/ request
+    @param count - number of elements in the list
+    @param bridge_domains - list of BDs
+*/
+manual_print manual_endian define one_ndp_bd_get_reply
+{
+  u32 context;
+  i32 retval;
+  u32 count;
+  u32 bridge_domains[count];
+};
+
+/** \brief Request for list of bridge domains used by L2 ARP table
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define one_l2_arp_bd_get
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Reply with list of bridge domains used by L2 ARP table
+    @param context - sender context, to match reply w/ request
+    @param count - number of elements in the list
+    @param bridge_domains - list of BDs
+*/
+manual_print manual_endian define one_l2_arp_bd_get_reply
+{
+  u32 context;
+  i32 retval;
+  u32 count;
+  u32 bridge_domains[count];
 };
 
 /** \brief add or delete ONE adjacency adjacency
@@ -470,7 +570,7 @@ define one_add_del_remote_mapping_reply
     @param reid - remote EID
     @param leid - local EID
 */
-define one_add_del_adjacency
+autoreply define one_add_del_adjacency
 {
   u32 client_index;
   u32 context;
@@ -483,23 +583,13 @@ define one_add_del_adjacency
   u8 leid_len;
 };
 
-/** \brief Reply for one_add_del_adjacency
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_add_del_adjacency_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief add or delete map request itr rlocs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param is_add - add address if non-zero, else delete
     @param locator_set_name - locator set name
 */
-define one_add_del_map_request_itr_rlocs
+autoreply define one_add_del_map_request_itr_rlocs
 {
   u32 client_index;
   u32 context;
@@ -507,17 +597,6 @@ define one_add_del_map_request_itr_rlocs
   u8 locator_set_name[64];
 };
 
-/** \brief Reply for one_add_del_map_request_itr_rlocs
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-
-define one_add_del_map_request_itr_rlocs_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief map/unmap vni/bd_index to vrf
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -525,7 +604,7 @@ define one_add_del_map_request_itr_rlocs_reply
     @param dp_table - virtual network id/bridge domain index
     @param vrf - vrf
 */
-define one_eid_table_add_del_map
+autoreply define one_eid_table_add_del_map
 {
   u32 client_index;
   u32 context;
@@ -535,16 +614,6 @@ define one_eid_table_add_del_map
   u8 is_l2;
 };
 
-/** \brief Reply for one_eid_table_add_del_map
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define one_eid_table_add_del_map_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Request for map one locator status
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -664,6 +733,12 @@ define one_eid_table_details
         0: EID is IPv4
         1: EID is IPv6
         2: EID is ethernet address
+        3 : NSH : both information (service path ID and service index) are
+          encoded in 'eid' field in a following way:
+
+          |4 B |1 B |
+          -----------
+          |SPI | SI |
     @param eid - endpoint identifier
     @param filter - filter type;
       Support values:
@@ -855,6 +930,29 @@ define one_get_map_request_itr_rlocs_reply
   u8 locator_set_name[64];
 };
 
+/** \brief Request for ONE NSH mapping
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define show_one_nsh_mapping
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Reply for ONE NSH mapping
+    @param context - sender context, to match reply w/ request
+    @param is_set - is ONE NSH mapping set
+    @param locator_set_name - name of the locator_set if NSH mapping is set
+*/
+define show_one_nsh_mapping_reply
+{
+  u32 context;
+  i32 retval;
+  u8 is_set;
+  u8 locator_set_name[64];
+};
+
 /** \brief Request for ONE PITR status
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -901,17 +999,17 @@ define one_stats_details
   u32 bytes;
 };
 
-define one_stats_enable_disable
+autoreply define one_stats_flush
 {
   u32 client_index;
   u32 context;
-  u8 is_en;
 };
 
-define one_stats_enable_disable_reply
+autoreply define one_stats_enable_disable
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+  u8 is_en;
 };
 
 define show_one_stats_enable_disable
@@ -927,6 +1025,86 @@ define show_one_stats_enable_disable_reply
   u8 is_en;
 };
 
+autoreply define one_map_register_fallback_threshold
+{
+  u32 client_index;
+  u32 context;
+  u32 value;
+};
+
+define show_one_map_register_fallback_threshold
+{
+  u32 client_index;
+  u32 context;
+};
+
+define show_one_map_register_fallback_threshold_reply
+{
+  u32 context;
+  i32 retval;
+  u32 value;
+};
+
+autoreply define one_enable_disable_xtr_mode
+{
+  u32 client_index;
+  u32 context;
+  u8 is_en;
+};
+
+define one_show_xtr_mode
+{
+  u32 client_index;
+  u32 context;
+};
+
+define one_show_xtr_mode_reply
+{
+  u32 context;
+  i32 retval;
+  u8 is_en;
+};
+
+autoreply define one_enable_disable_petr_mode
+{
+  u32 client_index;
+  u32 context;
+  u8 is_en;
+};
+
+define one_show_petr_mode
+{
+  u32 client_index;
+  u32 context;
+};
+
+define one_show_petr_mode_reply
+{
+  u32 context;
+  i32 retval;
+  u8 is_en;
+};
+
+autoreply define one_enable_disable_pitr_mode
+{
+  u32 client_index;
+  u32 context;
+  u8 is_en;
+};
+
+define one_show_pitr_mode
+{
+  u32 client_index;
+  u32 context;
+};
+
+define one_show_pitr_mode_reply
+{
+  u32 context;
+  i32 retval;
+  u8 is_en;
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")