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.2.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
30 @param mtu - MTU. default 1280
31 @param tag - A user field stored with the MAP
33 autoendian define map_add_domain
37 vl_api_ip6_prefix_t ip6_prefix;
38 vl_api_ip4_prefix_t ip4_prefix;
39 vl_api_ip6_prefix_t ip6_src;
43 u16 mtu [default=1280];
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
95 rpc map_domains_get returns map_domains_get_reply
96 stream map_domain_details;
99 define map_domains_get
106 define map_domains_get_reply
113 define map_domain_dump
120 /** \brief Details about a single MAP domain
121 @param context - returned sender context, to match reply w/ request
122 @param domain_index - MAP domain index
123 @param ip6_prefix - Rule IPv6 prefix
124 @param ip4_prefix - Rule IPv4 prefix
125 @param ip6_src - MAP domain IPv6 BR address / Tunnel source
126 @param ea_bits_len - Embedded Address bits length
127 @param psid_offset - Port Set Identifier (PSID) offset
128 @param psid_length - PSID length
131 @param tag - The user field stored with the MAP at creation time
133 define map_domain_details
137 vl_api_ip6_prefix_t ip6_prefix;
138 vl_api_ip4_prefix_t ip4_prefix;
139 vl_api_ip6_prefix_t ip6_src;
155 define map_rule_details
158 vl_api_ip6_address_t ip6_dst;
162 /** \brief Enable or disable a MAP interface
163 @param client_index - opaque cookie to identify the sender
164 @param context - sender context, to match reply w/ request
166 @param is_enable - 0=disable, 1=enable interface
167 @param is_translation - 0=encapsulation, 1=translation
169 autoreply define map_if_enable_disable
173 vl_api_interface_index_t sw_if_index;
175 bool is_translation; /* 0 - encapsulation, 1 - translation */
178 /** \brief Request for a single block of summary stats
179 @param client_index - opaque cookie to identify the sender
180 @param context - sender context, to match reply w/ request
182 define map_summary_stats
188 /** \brief Reply for map_summary_stats request
189 @param context - sender context, to match reply w/ request
190 @param retval - return code for request
191 @param total_bindings -
193 @param total_ip4_fragments -
194 @param total_security_check -
196 define map_summary_stats_reply
203 u64 total_ip4_fragments;
204 u64 total_security_check[2];
208 /** \brief Set MAP fragmentation parameters
209 @param client_index - opaque cookie to identify the sender
210 @param context - sender context, to match reply w/ request
211 @param inner - 1=frag inner packet, 0=frag tunnel packets
212 @param ignore_df - 1=IP4 fragment despite DF bit, 0=honor DF
214 autoreply define map_param_set_fragmentation
223 /** \brief Set MAP ICMP parameters
224 @param client_index - opaque cookie to identify the sender
225 @param context - sender context, to match reply w/ request
226 @param icmp4_err_relay_src - IPv4 ICMP err relay src address
228 autoreply define map_param_set_icmp
232 vl_api_ip4_address_t ip4_err_relay_src;
236 /** \brief Set MAP ICMP6 parameters
237 @param client_index - opaque cookie to identify the sender
238 @param context - sender context, to match reply w/ request
239 @param enable_unreachable - 1 = send ICMP unreachable err msgs
241 autoreply define map_param_set_icmp6
245 bool enable_unreachable;
249 /** \brief Add/delete MAP pre-resolve IP addresses parameters
250 @param client_index - opaque cookie to identify the sender
251 @param context - sender context, to match reply w/ request
252 @param is_add - 1 = Add non-zero IP addresses, 0 = delete
253 @param ip4_nh_address - direct IP4 next-hop address
254 @param ip6_nh_address - direct IP6 next-hop address
256 autoreply define map_param_add_del_pre_resolve
261 vl_api_ip4_address_t ip4_nh_address;
262 vl_api_ip6_address_t ip6_nh_address;
265 /** \brief Set MAP security-check parameters
266 @param client_index - opaque cookie to identify the sender
267 @param context - sender context, to match reply w/ request
268 @param enable - 1=enable security check on first inbound packet
269 @param fragments - 1=enable check on (subsequent) fragments too
271 autoreply define map_param_set_security_check
280 /** \brief Set MAP traffic class parameters
281 @param client_index - opaque cookie to identify the sender
282 @param context - sender context, to match reply w/ request
283 @param copy - 1 = copy packet class/TOS field, 0 = use tc_class instead
284 @param tc_class - class field value when copy == 0
286 autoreply define map_param_set_traffic_class
295 /** \brief Set MAP TCP parameters
296 @param client_index - opaque cookie to identify the sender
297 @param context - sender context, to match reply w/ request
298 @parma tcp_mss - TCP MSS clamping value
300 autoreply define map_param_set_tcp
308 /** \brief Request for a single block of MAP parameters
309 @param client_index - opaque cookie to identify the sender
310 @param context - sender context, to match reply w/ request
319 /** \brief Reply for map_param_get request
320 @param context - sender context, to match reply w/ request
321 @param retval - return code for request
322 @param inner - 1=frag inner packet, 0=frag tunnel packets, ~0=untouched
323 @param ignore_df - 1=IP4 fragm despite DF bit, 0=honor DF, ~0=untouched
324 @param icmp_ip4_err_relay_src - IPv4 ICMP err relay src address
325 @param icmp6_enable_unreachable - 1 = send ICMP unreachable err msgs
326 @param ip4_nh_address - direct IP4 next-hop address
327 @param ip6_nh_address - direct IP6 next-hop address
328 @param sec_check_enable - 1=enable security check on first inbound packet
329 @param sec_check_fragments - 1=enable check on (subsequent) fragments too
330 @param tc_copy - 1 = copy packet class/TOS field, 0 = use class instead
331 @param tc_class - class field value when copy == 0
333 define map_param_get_reply
339 vl_api_ip4_address_t icmp_ip4_err_relay_src;
340 bool icmp6_enable_unreachable;
341 vl_api_ip4_address_t ip4_nh_address;
342 vl_api_ip6_address_t ip6_nh_address;
347 bool sec_check_enable;
348 bool sec_check_fragments;
354 * MAP Error counters/messages
361 description "valid MAP packets";
367 description "bad protocol";
373 description "security check failed";
379 description "encap security check failed";
385 description "decap security check failed";
391 description "unable to translate ICMP";
397 description "unable to relay ICMP";
403 description "unknown";
409 description "no binding";
415 description "no domain";
421 description "packet is a fragment";
427 description "could not cache fragment";
433 description "fragment has unexpected format";
439 description "dropped cached fragment";
445 description "malformed packet";
451 description "can't fragment, DF set";
457 description "time exceeded";
461 "/err/ip4-map" "map";
462 "/err/ip6-map" "map";
463 "/err/ip4-t-map" "map";
464 "/err/ip6-t-map" "map";