ikev2: add profile dump API

[vpp.git] / src / plugins / ikev2 / ikev2.api

diff --git a/src/plugins/ikev2/ikev2.api b/src/plugins/ikev2/ikev2.api
index 8c9649f..e38927a 100644 (file)
--- a/src/plugins/ikev2/ikev2.api
+++ b/src/plugins/ikev2/ikev2.api
@@ -14,7 +14,11 @@
  * limitations under the License.
  */
 
-option version = "1.0.0";
+option version = "1.0.1";
+
+import "plugins/ikev2/ikev2_types.api";
+import "vnet/ip/ip_types.api";
+import "vnet/interface_types.api";
 
 /** \brief Get the plugin version
     @param client_index - opaque cookie to identify the sender
@@ -38,6 +42,29 @@ define ikev2_plugin_get_version_reply
   u32 minor;
 };
 
+/** \brief Dump all profiles
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define ikev2_profile_dump
+{
+  u32 client_index;
+  u32 context;
+  option status="in_progress";
+};
+
+/** \brief Details about all profiles
+    @param context - returned sender context, to match reply w/ request
+    @param profile - profile element with encapsulated attributes
+*/
+define ikev2_profile_details
+{
+  u32 context;
+  vl_api_ikev2_profile_t profile;
+  option status="in_progress";
+};
+
+
 /** \brief IKEv2: Add/delete profile
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -50,8 +77,8 @@ autoreply define ikev2_profile_add_del
   u32 client_index;
   u32 context;
 
-  u8 name[64];
-  u8 is_add;
+  string name[64];
+  bool is_add;
   option vat_help = "name <profile_name> [del]";
 };
 
@@ -70,9 +97,9 @@ autoreply define ikev2_profile_set_auth
   u32 client_index;
   u32 context;
 
-  u8 name[64];
+  string name[64];
   u8 auth_method;
-  u8 is_hex;
+  bool is_hex;
   u32 data_len;
   u8 data[data_len];
   option vat_help = "name <profile_name> auth_method <method> (auth_data 0x<data> | auth_data <data>)";
@@ -93,8 +120,8 @@ autoreply define ikev2_profile_set_id
   u32 client_index;
   u32 context;
 
-  u8 name[64];
-  u8 is_local;
+  string name[64];
+  bool is_local;
   u8 id_type;
   u32 data_len;
   u8 data[data_len];
@@ -118,8 +145,8 @@ autoreply define ikev2_profile_set_ts
   u32 client_index;
   u32 context;
 
-  u8 name[64];
-  u8 is_local;
+  string name[64];
+  bool is_local;
   u8 proto;
   u16 start_port;
   u16 end_port;
@@ -139,10 +166,26 @@ autoreply define ikev2_set_local_key
   u32 client_index;
   u32 context;
 
-  u8 key_file[256];
+  string key_file[256];
   option vat_help = "file <absolute_file_path>";
 };
 
+/** \brief IKEv2: Set the tunnel interface which will be protected by IKE
+    If this API is not called, a new tunnel will be created
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param name - IKEv2 profile name
+    @param sw_if_index - Of an existing tunnel
+*/
+autoreply define ikev2_set_tunnel_interface
+{
+  u32 client_index;
+  u32 context;
+  string name[64];
+
+  vl_api_interface_index_t sw_if_index;
+};
+
 /** \brief IKEv2: Set IKEv2 responder interface and IP address
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -156,9 +199,9 @@ autoreply define ikev2_set_responder
   u32 client_index;
   u32 context;
 
-  u8 name[64];
-  u32 sw_if_index;
-  u8 address[4];
+  string name[64];
+  vl_api_interface_index_t sw_if_index;
+  vl_api_ip4_address_t address;
   option vat_help = "<profile_name> interface <interface> address <addr>";
 };
 
@@ -178,7 +221,7 @@ autoreply define ikev2_set_ike_transforms
   u32 client_index;
   u32 context;
 
-  u8 name[64];
+  string name[64];
   u32 crypto_alg;
   u32 crypto_key_size;
   u32 integ_alg;
@@ -202,7 +245,7 @@ autoreply define ikev2_set_esp_transforms
   u32 client_index;
   u32 context;
 
-  u8 name[64];
+  string name[64];
   u32 crypto_alg;
   u32 crypto_key_size;
   u32 integ_alg;
@@ -226,7 +269,7 @@ autoreply define ikev2_set_sa_lifetime
   u32 client_index;
   u32 context;
 
-  u8 name[64];
+  string name[64];
   u64 lifetime;
   u32 lifetime_jitter;
   u32 handover;
@@ -246,7 +289,7 @@ autoreply define ikev2_initiate_sa_init
   u32 client_index;
   u32 context;
 
-  u8 name[64];
+  string name[64];
   option vat_help = "<profile_name>";
 };
 
@@ -298,9 +341,53 @@ autoreply define ikev2_initiate_rekey_child_sa
   option vat_help = "<ispi>";
 };
 
+/** \brief IKEv2: Set UDP encapsulation
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param name - IKEv2 profile name
+*/
+autoreply define ikev2_profile_set_udp_encap
+{
+  u32 client_index;
+  u32 context;
+
+  string name[64];
+};
+
+/** \brief IKEv2: Set/unset custom ipsec-over-udp port
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_set - whether set or unset custom port
+    @param port - port number
+    @param name - IKEv2 profile name
+*/
+autoreply define ikev2_profile_set_ipsec_udp_port
+{
+  u32 client_index;
+  u32 context;
+
+  u8 is_set;
+  u16 port;
+  string name[64];
+};
+
+/** \brief IKEv2: Set liveness parameters
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param period - how often is liveness check performed
+    @param max_retries - max retries for liveness check
+*/
+autoreply define ikev2_profile_set_liveness
+{
+  u32 client_index;
+  u32 context;
+
+  u32 period;
+  u32 max_retries;
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")
  * End:
  */
-