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 = "4.1.1";
18 import "vnet/ip/ip_types.api";
19 import "vnet/interface_types.api";
21 /** \brief Add MAP domains
22 @param client_index - opaque cookie to identify the sender
23 @param context - sender context, to match reply w/ request
24 @param ip6_prefix - Rule IPv6 prefix
25 @param ip4_prefix - Rule IPv4 prefix
26 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
27 @param ea_bits_len - Embedded Address bits length
28 @param psid_offset - Port Set Identifier (PSID) offset
29 @param psid_length - PSID length
31 @param tag - A user field stored with the MAP
37 vl_api_ip6_prefix_t ip6_prefix;
38 vl_api_ip4_prefix_t ip4_prefix;
39 vl_api_ip6_prefix_t ip6_src;
47 /** \brief Reply for MAP domain add
48 @param context - returned sender context, to match reply w/ request
49 @param index - MAP domain index
50 @param retval - return code
52 define map_add_domain_reply
59 /** \brief Delete MAP domain
60 @param client_index - opaque cookie to identify the sender
61 @param context - sender context, to match reply w/ request
62 @param index - MAP Domain index
64 autoreply define map_del_domain
72 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
73 @param client_index - opaque cookie to identify the sender
74 @param context - sender context, to match reply w/ request
75 @param index - MAP Domain index
76 @param is_add - If 1 add rule, if 0 delete rule
77 @param ip6_dst - MAP CE IPv6 address
78 @param psid - Rule PSID
80 autoreply define map_add_del_rule
86 vl_api_ip6_address_t ip6_dst;
91 /** \brief Get list of map domains
92 @param client_index - opaque cookie to identify the sender
94 define map_domain_dump
100 /** \brief Details about a single MAP domain
101 @param context - returned sender context, to match reply w/ request
102 @param domain_index - MAP domain index
103 @param ip6_prefix - Rule IPv6 prefix
104 @param ip4_prefix - Rule IPv4 prefix
105 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
106 @param ea_bits_len - Embedded Address bits length
107 @param psid_offset - Port Set Identifier (PSID) offset
108 @param psid_length - PSID length
111 @param tag - The user field stored with the MAP at creation time
113 define map_domain_details
117 vl_api_ip6_prefix_t ip6_prefix;
118 vl_api_ip4_prefix_t ip4_prefix;
119 vl_api_ip6_prefix_t ip6_src;
135 define map_rule_details
138 vl_api_ip6_address_t ip6_dst;
142 /** \brief Enable or disable a MAP interface
143 @param client_index - opaque cookie to identify the sender
144 @param context - sender context, to match reply w/ request
146 @param is_enable - 0=disable, 1=enable interface
147 @param is_translation - 0=encapsulation, 1=translation
149 autoreply define map_if_enable_disable
153 vl_api_interface_index_t sw_if_index;
155 bool is_translation; /* 0 - encapsulation, 1 - translation */
158 /** \brief Request for a single block of summary stats
159 @param client_index - opaque cookie to identify the sender
160 @param context - sender context, to match reply w/ request
162 define map_summary_stats
168 /** \brief Reply for map_summary_stats request
169 @param context - sender context, to match reply w/ request
170 @param retval - return code for request
171 @param total_bindings -
173 @param total_ip4_fragments -
174 @param total_security_check -
176 define map_summary_stats_reply
183 u64 total_ip4_fragments;
184 u64 total_security_check[2];
188 /** \brief Set MAP fragmentation parameters
189 @param client_index - opaque cookie to identify the sender
190 @param context - sender context, to match reply w/ request
191 @param inner - 1=frag inner packet, 0=frag tunnel packets
192 @param ignore_df - 1=IP4 fragment despite DF bit, 0=honor DF
194 autoreply define map_param_set_fragmentation
203 /** \brief Set MAP ICMP parameters
204 @param client_index - opaque cookie to identify the sender
205 @param context - sender context, to match reply w/ request
206 @param icmp4_err_relay_src - IPv4 ICMP err relay src address
208 autoreply define map_param_set_icmp
212 vl_api_ip4_address_t ip4_err_relay_src;
216 /** \brief Set MAP ICMP6 parameters
217 @param client_index - opaque cookie to identify the sender
218 @param context - sender context, to match reply w/ request
219 @param enable_unreachable - 1 = send ICMP unreachable err msgs
221 autoreply define map_param_set_icmp6
225 bool enable_unreachable;
229 /** \brief Add/delete MAP pre-resolve IP addresses parameters
230 @param client_index - opaque cookie to identify the sender
231 @param context - sender context, to match reply w/ request
232 @param is_add - 1 = Add non-zero IP addresses, 0 = delete
233 @param ip4_nh_address - direct IP4 next-hop address
234 @param ip6_nh_address - direct IP6 next-hop address
236 autoreply define map_param_add_del_pre_resolve
241 vl_api_ip4_address_t ip4_nh_address;
242 vl_api_ip6_address_t ip6_nh_address;
245 /** \brief Set MAP security-check parameters
246 @param client_index - opaque cookie to identify the sender
247 @param context - sender context, to match reply w/ request
248 @param enable - 1=enable security check on first inbound packet
249 @param fragments - 1=enable check on (subsequent) fragments too
251 autoreply define map_param_set_security_check
260 /** \brief Set MAP traffic class parameters
261 @param client_index - opaque cookie to identify the sender
262 @param context - sender context, to match reply w/ request
263 @param copy - 1 = copy packet class/TOS field, 0 = use tc_class instead
264 @param tc_class - class field value when copy == 0
266 autoreply define map_param_set_traffic_class
275 /** \brief Set MAP TCP parameters
276 @param client_index - opaque cookie to identify the sender
277 @param context - sender context, to match reply w/ request
278 @parma tcp_mss - TCP MSS clamping value
280 autoreply define map_param_set_tcp
288 /** \brief Request for a single block of MAP parameters
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
299 /** \brief Reply for map_param_get request
300 @param context - sender context, to match reply w/ request
301 @param retval - return code for request
302 @param inner - 1=frag inner packet, 0=frag tunnel packets, ~0=untouched
303 @param ignore_df - 1=IP4 fragm despite DF bit, 0=honor DF, ~0=untouched
304 @param icmp_ip4_err_relay_src - IPv4 ICMP err relay src address
305 @param icmp6_enable_unreachable - 1 = send ICMP unreachable err msgs
306 @param ip4_nh_address - direct IP4 next-hop address
307 @param ip6_nh_address - direct IP6 next-hop address
308 @param sec_check_enable - 1=enable security check on first inbound packet
309 @param sec_check_fragments - 1=enable check on (subsequent) fragments too
310 @param tc_copy - 1 = copy packet class/TOS field, 0 = use class instead
311 @param tc_class - class field value when copy == 0
313 define map_param_get_reply
319 vl_api_ip4_address_t icmp_ip4_err_relay_src;
320 bool icmp6_enable_unreachable;
321 vl_api_ip4_address_t ip4_nh_address;
322 vl_api_ip6_address_t ip6_nh_address;
327 bool sec_check_enable;
328 bool sec_check_fragments;