2 * Copyright (c) 2016 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.
17 * @brief VPP control-plane API messages.
19 * This file defines VPP control-plane API messages which are generally
20 * called through a shared memory interface.
23 /** \brief Add/del S-NAT address range
24 @param client_index - opaque cookie to identify the sender
25 @param context - sender context, to match reply w/ request
26 @param is_ip4 - 1 if address type is IPv4
27 @param first_ip_address - first IP address
28 @param last_ip_address - last IP address
29 @param is_add - 1 if add, 0 if delete
31 define snat_add_address_range {
35 u8 first_ip_address[16];
36 u8 last_ip_address[16];
40 /** \brief Add S-NAT address range reply
41 @param context - sender context, to match reply w/ request
42 @param retval - return code
44 define snat_add_address_range_reply {
49 /** \brief Dump S-NAT addresses
50 @param client_index - opaque cookie to identify the sender
51 @param context - sender context, to match reply w/ request
53 define snat_address_dump {
58 /** \brief S-NAT address details response
59 @param context - sender context, to match reply w/ request
60 @param is_ip4 - 1 if address type is IPv4
61 @param ip_address - IP address
63 define snat_address_details {
69 /** \brief Enable/disable S-NAT feature on the interface
70 @param client_index - opaque cookie to identify the sender
71 @param context - sender context, to match reply w/ request
72 @param is_add - 1 if add, 0 if delete
73 @param is_inside - 1 if inside, 0 if outside
74 @param sw_if_index - software index of the interface
76 define snat_interface_add_del_feature {
84 /** \brief Enable/disable S-NAT feature on the interface reply
85 @param context - sender context, to match reply w/ request
86 @param retval - return code
88 define snat_interface_add_del_feature_reply {
93 /** \brief Dump interfaces with S-NAT feature
94 @param client_index - opaque cookie to identify the sender
95 @param context - sender context, to match reply w/ request
97 define snat_interface_dump {
102 /** \brief S-NAT interface details response
103 @param context - sender context, to match reply w/ request
104 @param is_inside - 1 if inside, 0 if outside
105 @param sw_if_index - software index of the interface
107 define snat_interface_details {
113 /** \brief Add/delete S-NAT static mapping
114 @param client_index - opaque cookie to identify the sender
115 @param context - sender context, to match reply w/ request
116 @param is_add - 1 if add, 0 if delete
117 @param is_ip4 - 1 if address type is IPv4
118 @param addr_only - 1 if address only mapping
119 @param local_ip_address - local IP address
120 @param external_ip_address - external IP address
121 @param protocol - IP protocol
122 @param local_port - local port number
123 @param external_port - external port number
124 @param external_sw_if_index - external interface (if set
125 external_ip_address is ignored)
126 @param vfr_id - VRF ID
128 define snat_add_static_mapping {
134 u8 local_ip_address[16];
135 u8 external_ip_address[16];
139 u32 external_sw_if_index;
143 /** \brief Add/delete S-NAT static mapping reply
144 @param context - sender context, to match reply w/ request
145 @param retval - return code
147 define snat_add_static_mapping_reply {
152 /** \brief Dump S-NAT static mappings
153 @param client_index - opaque cookie to identify the sender
154 @param context - sender context, to match reply w/ request
156 define snat_static_mapping_dump {
161 /** \brief S-NAT static mapping details response
162 @param context - sender context, to match reply w/ request
163 @param is_ip4 - 1 if address type is IPv4
164 @param addr_only - 1 if address only mapping
165 @param local_ip_address - local IP address
166 @param external_ip_address - external IP address
167 @param protocol - IP protocol
168 @param local_port - local port number
169 @param external_port - external port number
170 @param vfr_id - VRF ID
172 define snat_static_mapping_details {
176 u8 local_ip_address[16];
177 u8 external_ip_address[16];
184 /** \brief Control ping from client to api server request
185 @param client_index - opaque cookie to identify the sender
186 @param context - sender context, to match reply w/ request
188 define snat_control_ping
194 /** \brief Control ping from the client to the server response
195 @param client_index - opaque cookie to identify the sender
196 @param context - sender context, to match reply w/ request
197 @param retval - return code for the request
198 @param vpe_pid - the pid of the vpe, returned by the server
200 define snat_control_ping_reply
208 /** \brief Show S-NAT plugin startup config
209 @param client_index - opaque cookie to identify the sender
210 @param context - sender context, to match reply w/ request
212 define snat_show_config
218 /** \brief Show S-NAT plugin startup config reply
219 @param context - sender context, to match reply w/ request
220 @param retval - return code for the request
221 @param static_mapping_only - if 1 dynamic translations disabled
222 @param static_mapping_connection_tracking - if 1 create session data
223 @param translation_buckets - number of translation hash buckets
224 @param translation_memory_size - translation hash memory size
225 @param user_buckets - number of user hash buckets
226 @param user_memory_size - user hash memory size
227 @param max_translations_per_user - maximum number of translations per user
228 @param outside_vrf_id - outside VRF id
229 @param inside_vrf_id - default inside VRF id
231 define snat_show_config_reply
235 u8 static_mapping_only;
236 u8 static_mapping_connection_tracking;
237 u32 translation_buckets;
238 u32 translation_memory_size;
240 u32 user_memory_size;
241 u32 max_translations_per_user;
246 /** \brief Set S-NAT workers
247 @param client_index - opaque cookie to identify the sender
248 @param context - sender context, to match reply w/ request
249 @param worker_mask - S-NAT workers mask
251 define snat_set_workers {
257 /** \brief Set S-NAT workers reply
258 @param context - sender context, to match reply w/ request
259 @param retval - return code
261 define snat_set_workers_reply {
266 /** \brief Dump S-NAT workers
267 @param client_index - opaque cookie to identify the sender
268 @param context - sender context, to match reply w/ request
270 define snat_worker_dump {
275 /** \brief S-NAT workers details response
276 @param context - sender context, to match reply w/ request
277 @param worker_index - worker index
278 @param lcore_id - lcore ID
279 @param name - worker name
281 define snat_worker_details {
288 /** \brief Add/delete S-NAT pool address from specific interfce
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
291 @param is_add - 1 if add, 0 if delete
292 @param sw_if_index - software index of the interface
294 define snat_add_del_interface_addr {
302 /** \brief Add/delete S-NAT pool address from specific interfce reply
303 @param context - sender context, to match reply w/ request
304 @param retval - return code
306 define snat_add_del_interface_addr_reply {
311 /** \brief Dump S-NAT pool addresses interfaces
312 @param client_index - opaque cookie to identify the sender
313 @param context - sender context, to match reply w/ request
315 define snat_interface_addr_dump {
320 /** \brief S-NAT pool addresses interfaces details response
321 @param context - sender context, to match reply w/ request
322 @param sw_if_index - software index of the interface
324 define snat_interface_addr_details {
329 /** \brief Enable/disable S-NAT IPFIX logging
330 @param client_index - opaque cookie to identify the sender
331 @param context - sender context, to match reply w/ request
332 @param domain_id - observation domain ID
333 @param src_port - source port number
334 @param enable - 1 if enable, 0 if disable
336 define snat_ipfix_enable_disable {
344 /** \brief Enable/disable S-NAT IPFIX logging reply
345 @param context - sender context, to match reply w/ request
346 @param retval - return code
348 define snat_ipfix_enable_disable_reply {