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 = "2.3.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;
46 /** \brief Reply for MAP domain add
47 @param context - returned sender context, to match reply w/ request
48 @param index - MAP domain index
49 @param retval - return code
51 define map_add_domain_reply
58 /** \brief Delete MAP domain
59 @param client_index - opaque cookie to identify the sender
60 @param context - sender context, to match reply w/ request
61 @param index - MAP Domain index
63 autoreply define map_del_domain
71 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
72 @param client_index - opaque cookie to identify the sender
73 @param context - sender context, to match reply w/ request
74 @param index - MAP Domain index
75 @param is_add - If 1 add rule, if 0 delete rule
76 @param ip6_dst - MAP CE IPv6 address
77 @param psid - Rule PSID
79 autoreply define map_add_del_rule
85 vl_api_ip6_address_t ip6_dst;
90 /** \brief Get list of map domains
91 @param client_index - opaque cookie to identify the sender
93 define map_domain_dump
99 define map_domain_details
103 vl_api_ip6_prefix_t ip6_prefix;
104 vl_api_ip4_prefix_t ip4_prefix;
105 vl_api_ip6_prefix_t ip6_src;
121 define map_rule_details
124 vl_api_ip6_address_t ip6_dst;
128 /** \brief Enable or disable a MAP interface
129 @param client_index - opaque cookie to identify the sender
130 @param context - sender context, to match reply w/ request
132 @param is_enable - 0=disable, 1=enable interface
133 @param is_translation - 0=encapsulation, 1=translation
135 autoreply define map_if_enable_disable
141 bool is_translation; /* 0 - encapsulation, 1 - translation */
144 /** \brief Request for a single block of summary stats
145 @param client_index - opaque cookie to identify the sender
146 @param context - sender context, to match reply w/ request
148 define map_summary_stats
154 /** \brief Reply for map_summary_stats request
155 @param context - sender context, to match reply w/ request
156 @param retval - return code for request
157 @param total_bindings -
159 @param total_ip4_fragments -
160 @param total_security_check -
162 define map_summary_stats_reply
169 u64 total_ip4_fragments;
170 u64 total_security_check[2];
174 /** \brief Set MAP fragmentation parameters
175 @param client_index - opaque cookie to identify the sender
176 @param context - sender context, to match reply w/ request
177 @param inner - 1=frag inner packet, 0=frag tunnel packets
178 @param ignore_df - 1=IP4 fragment despite DF bit, 0=honor DF
180 autoreply define map_param_set_fragmentation
189 /** \brief Set MAP ICMP parameters
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
192 @param icmp4_err_relay_src - IPv4 ICMP err relay src address
194 autoreply define map_param_set_icmp
198 vl_api_ip4_address_t ip4_err_relay_src;
202 /** \brief Set MAP ICMP6 parameters
203 @param client_index - opaque cookie to identify the sender
204 @param context - sender context, to match reply w/ request
205 @param enable_unreachable - 1 = send ICMP unreachable err msgs
207 autoreply define map_param_set_icmp6
211 bool enable_unreachable;
215 /** \brief Add/delete MAP pre-resolve IP addresses parameters
216 @param client_index - opaque cookie to identify the sender
217 @param context - sender context, to match reply w/ request
218 @param is_add - 1 = Add non-zero IP addresses, 0 = delete
219 @param ip4_nh_address - direct IP4 next-hop address
220 @param ip6_nh_address - direct IP6 next-hop address
222 autoreply define map_param_add_del_pre_resolve
227 vl_api_ip4_address_t ip4_nh_address;
228 vl_api_ip6_address_t ip6_nh_address;
232 /** \brief Set MAP reassembly parameters
233 @param client_index - opaque cookie to identify the sender
234 @param context - sender context, to match reply w/ request
235 @param is_ip6 - 1 = params apply to IPv6, 0 = params apply to IPv4
236 @param lifetime_ms - reassembly valid lifetime, or ~0
237 @param pool_size - max number of reassemblies, or ~0
238 @param buffers - max number of reassembly buffers, or ~0
239 @param ht_ratio - hash-table size factor, or ~0
241 autoreply define map_param_set_reassembly
253 /** \brief Set MAP security-check parameters
254 @param client_index - opaque cookie to identify the sender
255 @param context - sender context, to match reply w/ request
256 @param enable - 1=enable security check on first inbound packet
257 @param fragments - 1=enable check on (subsequent) fragments too
259 autoreply define map_param_set_security_check
268 /** \brief Set MAP traffic class parameters
269 @param client_index - opaque cookie to identify the sender
270 @param context - sender context, to match reply w/ request
271 @param copy - 1 = copy packet class/TOS field, 0 = use class instead
272 @param class - class field value when copy == 0
274 autoreply define map_param_set_traffic_class
283 /** \brief Set MAP TCP parammeters
284 @param client_index - opaque cookie to identify the sender
285 @param context - sender context, to match reply w/ request
286 @parma tcp_mss - TCP MSS clamping value
288 autoreply define map_param_set_tcp
296 /** \brief Request for a single block of MAP parameters
297 @param client_index - opaque cookie to identify the sender
298 @param context - sender context, to match reply w/ request
307 /** \brief Reply for map_param_get request
308 @param context - sender context, to match reply w/ request
309 @param retval - return code for request
310 @param inner - 1=frag inner packet, 0=frag tunnel packets, ~0=untouched
311 @param ignore_df - 1=IP4 fragm despite DF bit, 0=honor DF, ~0=untouched
312 @param icmp_ip4_err_relay_src - IPv4 ICMP err relay src address
313 @param icmp6_enable_unreachable - 1 = send ICMP unreachable err msgs
314 @param ip4_nh_address - direct IP4 next-hop address
315 @param ip6_nh_address - direct IP6 next-hop address
316 @param ip4_lifetime_ms - reassembly valid lifetime, or ~0
317 @param ip4_pool_size - max number of reassemblies, or ~0
318 @param ip4_buffers - max number of reassembly buffers, or ~0
319 @param ip4_ht_ratio - reassembly valid lifetime, or ~0
320 @param ip6_lifetime_ms - max number of reassemblies, or ~0
321 @param ip6_pool_size - max number of reassemblies, or ~0
322 @param ip6_buffers - max number of reassembly buffers, or ~0
323 @param ip6_ht_ratio - hash-table size factor, or ~0
324 @param sec_check_enable - 1=enable security check on first inbound packet
325 @param sec_check_fragments - 1=enable check on (subsequent) fragments too
326 @param tc_copy - 1 = copy packet class/TOS field, 0 = use class instead
327 @param tc_class - class field value when copy == 0
329 define map_param_get_reply
335 vl_api_ip4_address_t icmp_ip4_err_relay_src;
336 bool icmp6_enable_unreachable;
337 vl_api_ip4_address_t ip4_nh_address;
338 vl_api_ip6_address_t ip6_nh_address;
347 bool sec_check_enable;
348 bool sec_check_fragments;