2 * Copyright (c) 2015-2020 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 option version = "4.0.0";
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
22 enum transport_proto : u8
24 TRANSPORT_PROTO_API_TCP,
25 TRANSPORT_PROTO_API_UDP,
26 TRANSPORT_PROTO_API_NONE,
27 TRANSPORT_PROTO_API_TLS,
28 TRANSPORT_PROTO_API_QUIC,
31 /** \brief Application attach to session layer
32 @param client_index - opaque cookie to identify the sender
33 @param context - sender context, to match reply w/ request
34 @param options - segment size, fifo sizes, etc.
35 @param namespace_id - string
41 string namespace_id[];
44 /** \brief Application attach reply
45 @param context - sender context, to match reply w/ request
46 @param retval - return code for the request
47 @param app_mq - app message queue
48 @param vpp_ctrl_mq - vpp message queue for control events that should
49 be handled in main thread, i.e., bind/connect
50 @param vpp_ctrl_mq_thread_index - thread index of the ctrl mq
51 @param app_index - index of the newly created app
52 @param n_fds - number of fds exchanged
53 @param fd_flags - set of flags that indicate which fds are to be expected
54 over the socket (set only if socket transport available)
55 @param segment_size - size of first shm segment
56 @param segment_handle - handle for segment
57 @param segment_name - name of segment client needs to attach to
59 define app_attach_reply {
64 u8 vpp_ctrl_mq_thread;
70 string segment_name[];
73 /** \brief Application detach from session layer
74 @param client_index - opaque cookie to identify the sender
75 @param context - sender context, to match reply w/ request
77 autoreply define application_detach {
82 /** \brief Add certificate and key
83 @param client_index - opaque cookie to identify the sender
84 @param context - sender context, to match reply w/ request
85 @param engine - crypto engine
86 @param cert_len - cert length (comes first)
87 @param certkey_len - cert and key length
88 @param certkey - cert & key data (due to API limitation)
90 define app_add_cert_key_pair {
95 u8 certkey[certkey_len];
98 /** \brief Add certificate and key
99 @param context - sender context, to match reply w/ request
100 @param retval - return code for the request
101 @param index - index in certificate store
103 define app_add_cert_key_pair_reply {
109 /** \brief Delete certificate and key
110 @param client_index - opaque cookie to identify the sender
111 @param context - sender context, to match reply w/ request
112 @param index - index in certificate store
114 autoreply define app_del_cert_key_pair {
120 /** \brief Application add TLS certificate
121 ### WILL BE DEPRECATED POST 20.01 ###
122 @param client_index - opaque cookie to identify the sender
123 @param context - sender context, to match reply w/ request
124 @param cert_len - certificate length
125 @param cert - certificate as a string
127 autoreply define application_tls_cert_add {
128 option deprecated="to be removed post 21.06";
136 /** \brief Application add TLS key
137 ### WILL BE DEPRECATED POST 20.01 ###
138 @param client_index - opaque cookie to identify the sender
139 @param context - sender context, to match reply w/ request
140 @param key_len - certificate length
141 @param key - PEM encoded key as a string
143 autoreply define application_tls_key_add {
144 option deprecated="to be removed post 21.06";
152 /** \brief add/del application worker
153 @param client_index - opaque cookie to identify the sender
154 client to vpp direction only
155 @param context - sender context, to match reply w/ request
156 @param app_index - application index
157 @param wrk_index - worker index, if a delete
158 @param is_add - set if an add
160 define app_worker_add_del
166 bool is_add [default=true];
169 /** \brief Reply for app worker add/del
170 @param context - returned sender context, to match reply w/ request
171 @param retval - return code
172 @param wrk_index - worker index, if add
173 @param app_event_queue_address - vpp event queue address of new worker
174 @param n_fds - number of fds exchanged
175 @param fd_flags - set of flags that indicate which fds are to be expected
176 over the socket (set only if socket transport available)
177 @param segment_handle - handle for segment
178 @param is_add - add if non zero, else delete
179 @param segment_name - name of segment client needs to attach to
181 define app_worker_add_del_reply
186 u64 app_event_queue_address;
190 bool is_add [default=true];
191 string segment_name[];
194 /** \brief enable/disable session layer
195 @param client_index - opaque cookie to identify the sender
196 client to vpp direction only
197 @param context - sender context, to match reply w/ request
198 @param is_enable - disable session layer if 0, enable otherwise
200 autoreply define session_enable_disable {
203 bool is_enable [default=true];
206 /** \brief enable/disable session layer socket api
207 @param client_index - opaque cookie to identify the sender
208 client to vpp direction only
209 @param context - sender context, to match reply w/ request
210 @param is_enable - disable session layer if 0, enable otherwise
212 autoreply define session_sapi_enable_disable {
215 bool is_enable [default=true];
218 /** \brief add/del application namespace
219 @param client_index - opaque cookie to identify the sender
220 client to vpp direction only
221 @param context - sender context, to match reply w/ request
222 @param secret - secret shared between app and vpp
223 @param sw_if_index - local interface that "supports" namespace. Set to
225 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
227 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
229 @param namespace_id - namespace id
231 define app_namespace_add_del {
236 vl_api_interface_index_t sw_if_index [default=0xffffffff];
239 string namespace_id[];
242 /** \brief add/del application namespace
243 @param client_index - opaque cookie to identify the sender
244 client to vpp direction only
245 @param context - sender context, to match reply w/ request
246 @param secret - secret shared between app and vpp
247 @param sw_if_index - local interface that "supports" namespace. Set to
249 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
251 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
253 @param namespace_id - namespace id
254 @param netns - linux net namespace
256 define app_namespace_add_del_v2 {
260 vl_api_interface_index_t sw_if_index [default=0xffffffff];
263 string namespace_id[64];
267 /** \brief add/del application namespace
268 @param client_index - opaque cookie to identify the sender
269 client to vpp direction only
270 @param context - sender context, to match reply w/ request
271 @param secret - secret shared between app and vpp
272 @param sw_if_index - local interface that "supports" namespace. Set to
274 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
276 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
278 @param namespace_id - namespace id
279 @param netns - linux net namespace
280 @param sock_name - socket name (path, abstract socket name)
282 define app_namespace_add_del_v3 {
286 bool is_add [default=true];
287 vl_api_interface_index_t sw_if_index [default=0xffffffff];
290 string namespace_id[64];
295 /** \brief Reply for app namespace add/del
296 @param context - returned sender context, to match reply w/ request
297 @param retval - return code
298 @param appns_index - app namespace index
300 define app_namespace_add_del_reply
308 /** \brief Reply for app namespace add/del
309 @param context - returned sender context, to match reply w/ request
310 @param retval - return code
311 @param appns_index - app namespace index
313 define app_namespace_add_del_v2_reply
320 define app_namespace_add_del_v3_reply
327 enum session_rule_scope {
328 SESSION_RULE_SCOPE_API_GLOBAL = 0,
329 SESSION_RULE_SCOPE_API_LOCAL = 1,
330 SESSION_RULE_SCOPE_API_BOTH = 2,
333 /** \brief add/del session rule
334 @param client_index - opaque cookie to identify the sender
335 client to vpp direction only
336 @param context - sender context, to match reply w/ request
337 @param transport_proto - transport protocol
338 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
339 @param lcl_ip - local ip
340 @param lcl_plen - local prefix length
341 @param rmt_ip - remote ip
342 @param rmt_ple - remote prefix length
343 @param lcl_port - local port
344 @param rmt_port - remote port
345 @param action_index - the only action defined now is forward to
346 application with index action_index
347 @param is_add - flag to indicate if add or del
348 @param appns_index - application namespace where rule is to be applied to
349 @param scope - enum that indicates scope of the rule: global or local.
350 If 0, default is global, 1 is global 2 is local, 3 is both
353 autoreply define session_rule_add_del {
356 vl_api_transport_proto_t transport_proto;
362 bool is_add [default=true];
364 vl_api_session_rule_scope_t scope;
368 /** \brief Dump session rules
369 @param client_index - opaque cookie to identify the sender
370 @param context - sender context, to match reply w/ request
372 define session_rules_dump
378 /** \brief Session rules details
379 @param context - sender context, to match reply w/ request
380 @param transport_proto - transport protocol
381 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
382 @param lcl_ip - local ip
383 @param lcl_plen - local prefix length
384 @param rmt_ip - remote ip
385 @param rmt_ple - remote prefix length
386 @param lcl_port - local port
387 @param rmt_port - remote port
388 @param action_index - the only action defined now is forward to
389 application with index action_index
390 @param appns_index - application namespace where rule is to be applied to
391 @param scope - enum that indicates scope of the rule: global or local.
392 If 0, default is global, 1 is global 2 is local, 3 is both
395 define session_rules_details
398 vl_api_transport_proto_t transport_proto;
405 vl_api_session_rule_scope_t scope;
411 * eval: (c-set-style "gnu")