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.
16 option version = "3.0.0";
18 import "vnet/ip/ip_types.api";
20 /** \brief Add MAP domains
21 @param client_index - opaque cookie to identify the sender
22 @param context - sender context, to match reply w/ request
23 @param ip6_prefix - Rule IPv6 prefix
24 @param ip4_prefix - Rule IPv4 prefix
25 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
26 @param ea_bits_len - Embedded Address bits length
27 @param psid_offset - Port Set Identifider (PSID) offset
28 @param psid_length - PSID length
35 vl_api_ip6_prefix_t ip6_prefix;
36 vl_api_ip4_prefix_t ip4_prefix;
37 vl_api_ip6_prefix_t ip6_src;
44 /** \brief Reply for MAP domain add
45 @param context - returned sender context, to match reply w/ request
46 @param index - MAP domain index
47 @param retval - return code
49 define map_add_domain_reply
56 /** \brief Delete MAP domain
57 @param client_index - opaque cookie to identify the sender
58 @param context - sender context, to match reply w/ request
59 @param index - MAP Domain index
61 autoreply define map_del_domain
69 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
70 @param client_index - opaque cookie to identify the sender
71 @param context - sender context, to match reply w/ request
72 @param index - MAP Domain index
73 @param is_add - If 1 add rule, if 0 delete rule
74 @param ip6_dst - MAP CE IPv6 address
75 @param psid - Rule PSID
77 autoreply define map_add_del_rule
83 vl_api_ip6_address_t ip6_dst;
88 /** \brief Get list of map domains
89 @param client_index - opaque cookie to identify the sender
91 define map_domain_dump
97 define map_domain_details
101 vl_api_ip6_prefix_t ip6_prefix;
102 vl_api_ip4_prefix_t ip4_prefix;
103 vl_api_ip6_prefix_t ip6_src;
118 define map_rule_details
121 vl_api_ip6_address_t ip6_dst;
125 /** \brief Enable or disable a MAP interface
126 @param client_index - opaque cookie to identify the sender
127 @param context - sender context, to match reply w/ request
129 @param is_enable - 0=disable, 1=enable interface
130 @param is_translation - 0=encapsulation, 1=translation
132 autoreply define map_if_enable_disable
138 bool is_translation; /* 0 - encapsulation, 1 - translation */
141 /** \brief Request for a single block of summary stats
142 @param client_index - opaque cookie to identify the sender
143 @param context - sender context, to match reply w/ request
145 define map_summary_stats
151 /** \brief Reply for map_summary_stats request
152 @param context - sender context, to match reply w/ request
153 @param retval - return code for request
154 @param total_bindings -
156 @param total_ip4_fragments -
157 @param total_security_check -
159 define map_summary_stats_reply
166 u64 total_ip4_fragments;
167 u64 total_security_check[2];
171 /** \brief Set MAP fragmentation parameters
172 @param client_index - opaque cookie to identify the sender
173 @param context - sender context, to match reply w/ request
174 @param inner - 1=frag inner packet, 0=frag tunnel packets
175 @param ignore_df - 1=IP4 fragment despite DF bit, 0=honor DF
177 autoreply define map_param_set_fragmentation
186 /** \brief Set MAP ICMP parameters
187 @param client_index - opaque cookie to identify the sender
188 @param context - sender context, to match reply w/ request
189 @param icmp4_err_relay_src - IPv4 ICMP err relay src address
191 autoreply define map_param_set_icmp
195 vl_api_ip4_address_t ip4_err_relay_src;
199 /** \brief Set MAP ICMP6 parameters
200 @param client_index - opaque cookie to identify the sender
201 @param context - sender context, to match reply w/ request
202 @param enable_unreachable - 1 = send ICMP unreachable err msgs
204 autoreply define map_param_set_icmp6
208 bool enable_unreachable;
212 /** \brief Add/delete MAP pre-resolve IP addresses parameters
213 @param client_index - opaque cookie to identify the sender
214 @param context - sender context, to match reply w/ request
215 @param is_add - 1 = Add non-zero IP addresses, 0 = delete
216 @param ip4_nh_address - direct IP4 next-hop address
217 @param ip6_nh_address - direct IP6 next-hop address
219 autoreply define map_param_add_del_pre_resolve
224 vl_api_ip4_address_t ip4_nh_address;
225 vl_api_ip6_address_t ip6_nh_address;
229 /** \brief Set MAP reassembly parameters
230 @param client_index - opaque cookie to identify the sender
231 @param context - sender context, to match reply w/ request
232 @param is_ip6 - 1 = params apply to IPv6, 0 = params apply to IPv4
233 @param lifetime_ms - reassembly valid lifetime, or ~0
234 @param pool_size - max number of reassemblies, or ~0
235 @param buffers - max number of reassembly buffers, or ~0
236 @param ht_ratio - hash-table size factor, or ~0
238 autoreply define map_param_set_reassembly
250 /** \brief Set MAP security-check parameters
251 @param client_index - opaque cookie to identify the sender
252 @param context - sender context, to match reply w/ request
253 @param enable - 1=enable security check on first inbound packet
254 @param fragments - 1=enable check on (subsequent) fragments too
256 autoreply define map_param_set_security_check
265 /** \brief Set MAP traffic class parameters
266 @param client_index - opaque cookie to identify the sender
267 @param context - sender context, to match reply w/ request
268 @param copy - 1 = copy packet class/TOS field, 0 = use class instead
269 @param class - class field value when copy == 0
271 autoreply define map_param_set_traffic_class
280 /** \brief Set MAP TCP parammeters
281 @param client_index - opaque cookie to identify the sender
282 @param context - sender context, to match reply w/ request
283 @parma tcp_mss - TCP MSS clamping value
285 autoreply define map_param_set_tcp
293 /** \brief Request for a single block of MAP parameters
294 @param client_index - opaque cookie to identify the sender
295 @param context - sender context, to match reply w/ request
304 /** \brief Reply for map_param_get request
305 @param context - sender context, to match reply w/ request
306 @param retval - return code for request
307 @param inner - 1=frag inner packet, 0=frag tunnel packets, ~0=untouched
308 @param ignore_df - 1=IP4 fragm despite DF bit, 0=honor DF, ~0=untouched
309 @param icmp_ip4_err_relay_src - IPv4 ICMP err relay src address
310 @param icmp6_enable_unreachable - 1 = send ICMP unreachable err msgs
311 @param ip4_nh_address - direct IP4 next-hop address
312 @param ip6_nh_address - direct IP6 next-hop address
313 @param ip4_lifetime_ms - reassembly valid lifetime, or ~0
314 @param ip4_pool_size - max number of reassemblies, or ~0
315 @param ip4_buffers - max number of reassembly buffers, or ~0
316 @param ip4_ht_ratio - reassembly valid lifetime, or ~0
317 @param ip6_lifetime_ms - max number of reassemblies, or ~0
318 @param ip6_pool_size - max number of reassemblies, or ~0
319 @param ip6_buffers - max number of reassembly buffers, or ~0
320 @param ip6_ht_ratio - hash-table size factor, or ~0
321 @param sec_check_enable - 1=enable security check on first inbound packet
322 @param sec_check_fragments - 1=enable check on (subsequent) fragments too
323 @param tc_copy - 1 = copy packet class/TOS field, 0 = use class instead
324 @param tc_class - class field value when copy == 0
326 define map_param_get_reply
332 vl_api_ip4_address_t icmp_ip4_err_relay_src;
333 bool icmp6_enable_unreachable;
334 vl_api_ip4_address_t ip4_nh_address;
335 vl_api_ip6_address_t ip6_nh_address;
344 bool sec_check_enable;
345 bool sec_check_fragments;