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.
18 This file defines vpp IP control-plane API messages which are generally
19 called through a shared memory interface.
22 /** \brief Add / del table request
23 A table can be added multiple times, but need be deleted only once.
24 @param client_index - opaque cookie to identify the sender
25 @param context - sender context, to match reply w/ request
26 @param is_ipv6 - V4 or V6 table
27 @param table_id - table ID associated with the route
28 This table ID will apply to both the unicats
30 @param name - A client provided name/tag for the table. If this is
31 not set by the client, then VPP will generate something
34 autoreply define ip_table_add_del
44 /** \brief Dump IP fib table
45 @param client_index - opaque cookie to identify the sender
54 @param sw_if_index - index of the interface
55 @param weight - The weight, for UCMP
56 @param preference - The preference of the path. lowest preference is prefered
57 @param is_local - local if non-zero, else remote
58 @param is_drop - Drop the packet
59 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
60 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
61 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
62 @param next_hop[16] - the next hop address
64 WARNING: this type is replicated, pending cleanup completion
66 typeonly manual_print manual_endian define fib_path
79 /** \brief IP FIB table response
80 @param table_id - IP fib table id
81 @address_length - mask length
83 @param count - the number of fib_path in path
84 @param path - array of of fib_path structures
86 manual_endian manual_print define ip_fib_details
94 vl_api_fib_path_t path[count];
97 /** \brief Dump IP6 fib table
98 @param client_index - opaque cookie to identify the sender
106 /** \brief IP6 FIB table entry response
107 @param table_id - IP6 fib table id
108 @param address_length - mask length
109 @param address - ip6 prefix
110 @param count - the number of fib_path in path
111 @param path - array of of fib_path structures
113 manual_endian manual_print define ip6_fib_details
121 vl_api_fib_path_t path[count];
124 /** \brief Dump IP neighboors
125 @param client_index - opaque cookie to identify the sender
126 @param context - sender context, to match reply w/ request
127 @param sw_if_index - the interface to dump neighboors
128 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
130 define ip_neighbor_dump
138 /** \brief IP neighboors dump response
139 @param context - sender context which was passed in the request
140 @param is_static - [1|0] to indicate if neighbor is statically configured
141 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
143 define ip_neighbor_details {
151 /** \brief IP neighbor add / del request
152 @param client_index - opaque cookie to identify the sender
153 @param context - sender context, to match reply w/ request
154 @param sw_if_index - interface used to reach neighbor
155 @param is_add - 1 to add neighbor, 0 to delete
156 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
157 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
158 @param is_static - A static neighbor Entry - there are not flushed
159 If the interface goes down.
160 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
161 table for the neighbor.
162 @param mac_address - l2 address of the neighbor
163 @param dst_address - ip4 or ip6 address of the neighbor
165 autoreply define ip_neighbor_add_del
170 /* 1 = add, 0 = delete */
179 /** \brief Set the ip flow hash config for a fib request
180 @param client_index - opaque cookie to identify the sender
181 @param context - sender context, to match reply w/ request
182 @param vrf_id - vrf/fib id
183 @param is_ipv6 - if non-zero the fib is ip6, else ip4
184 @param src - if non-zero include src in flow hash
185 @param dst - if non-zero include dst in flow hash
186 @param sport - if non-zero include sport in flow hash
187 @param dport - if non-zero include dport in flow hash
188 @param proto -if non-zero include proto in flow hash
189 @param reverse - if non-zero include reverse in flow hash
191 autoreply define set_ip_flow_hash
205 /** \brief IPv6 router advertisement config request
206 @param client_index - opaque cookie to identify the sender
207 @param context - sender context, to match reply w/ request
212 @param send_unicast -
215 @param default_router -
216 @param max_interval -
217 @param min_interval -
219 @param initial_count -
220 @param initial_interval -
222 autoreply define sw_interface_ip6nd_ra_config
239 u32 initial_interval;
242 /** \brief IPv6 router advertisement prefix config request
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param sw_if_index - The interface the RA prefix information is for
246 @param address[] - The prefix to advertise
247 @param address_length - the prefix length
248 @param use_default - Revert to default settings
249 @param no_advertise - Do not advertise this prefix
250 @param off_link - The prefix is off link (it is not configured on the interface)
251 Configures the L-flag, When set, indicates that this
252 prefix can be used for on-link determination.
253 @param no_autoconfig - Setting for the A-flag. When
254 set indicates that this prefix can be used for
255 stateless address configuration.
256 @param no_onlink - The prefix is not on link. Make sure this is consistent
257 with the off_link parameter else YMMV
258 @param is_no - add/delete
259 @param val_lifetime - The length of time in
260 seconds (relative to the time the packet is sent)
261 that the prefix is valid for the purpose of on-link
262 determination. A value of all one bits
263 (0xffffffff) represents infinity
264 @param pref_lifetime - The length of time in
265 seconds (relative to the time the packet is sent)
266 that addresses generated from the prefix via
267 stateless address autoconfiguration remain
268 preferred [ADDRCONF]. A value of all one bits
269 (0xffffffff) represents infinity.
271 autoreply define sw_interface_ip6nd_ra_prefix
288 /** \brief IPv6 ND proxy config
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
291 @param sw_if_index - The interface the host is on
292 @param address - The address of the host for which to proxy for
293 @param is_add - Adding or deleting
295 autoreply define ip6nd_proxy_add_del
304 /** \brief IPv6 ND proxy details returned after request
305 @param context - sender context, to match reply w/ request
306 @param retval - return code for the request
308 define ip6nd_proxy_details
316 /** \brief IPv6 ND proxy dump request
317 @param context - sender context, to match reply w/ request
318 @param retval - return code for the request
319 @param sw_if_index - The interface the host is on
320 @param address - The address of the host for which to proxy for
322 define ip6nd_proxy_dump
328 /** \brief IPv6 interface enable / disable request
329 @param client_index - opaque cookie to identify the sender
330 @param context - sender context, to match reply w/ request
331 @param sw_if_index - interface used to reach neighbor
332 @param enable - if non-zero enable ip6 on interface, else disable
334 autoreply define sw_interface_ip6_enable_disable
339 u8 enable; /* set to true if enable */
342 /** \brief IPv6 set link local address on interface request
343 @param client_index - opaque cookie to identify the sender
344 @param context - sender context, to match reply w/ request
345 @param sw_if_index - interface to set link local on
346 @param address[] - the new link local address
348 autoreply define sw_interface_ip6_set_link_local_address
356 /** \brief Add / del route request
357 @param client_index - opaque cookie to identify the sender
358 @param context - sender context, to match reply w/ request
359 @param sw_if_index - software index of the new vlan's parent interface
360 @param vrf_id - fib table /vrf associated with the route
361 @param lookup_in_vrf -
362 @param classify_table_index -
363 @param create_vrf_if_needed -
364 @param is_add - 1 if adding the route, 0 if deleting
365 @param is_drop - Drop the packet
366 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
367 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
368 @param is_ipv6 - 0 if an ip4 route, else ip6
371 @param is_multipath - Set to 1 if this is a multipath route, else 0
372 @param not_last - Is last or not last msg in group of multiple add/del msgs
373 @param next_hop_weight -
374 @param dst_address_length -
375 @param dst_address[16] -
376 @param next_hop_address[16] -
377 @param next_hop_n_out_labels - the number of labels in the label stack
378 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
379 @param next_hop_via_label - The next-hop is a resolved via a local label
381 autoreply define ip_add_del_route
385 u32 next_hop_sw_if_index;
387 u32 classify_table_index;
388 u32 next_hop_table_id;
389 u8 create_vrf_if_needed;
399 u8 is_resolve_attached;
400 /* Is last/not-last message in group of multiple add/del messages. */
403 u8 next_hop_preference;
404 u8 dst_address_length;
406 u8 next_hop_address[16];
407 u8 next_hop_n_out_labels;
408 u32 next_hop_via_label;
409 u32 next_hop_out_label_stack[next_hop_n_out_labels];
412 /** \brief Add / del route request
413 @param client_index - opaque cookie to identify the sender
414 @param context - sender context, to match reply w/ request
415 @param sw_if_index - software index of the new vlan's parent interface
416 @param vrf_id - fib table /vrf associated with the route
420 autoreply define ip_mroute_add_del
424 u32 next_hop_sw_if_index;
429 u16 grp_address_length;
430 u8 create_vrf_if_needed;
438 /** \brief Dump IP multicast fib table
439 @param client_index - opaque cookie to identify the sender
447 /** \brief IP Multicast FIB table response
448 @param table_id - IP fib table id
449 @address_length - mask length
450 @grp_address - Group address/prefix
451 @src_address - Source address
452 @param count - the number of fib_path in path
453 @param path - array of of fib_path structures
455 manual_endian manual_print define ip_mfib_details
465 vl_api_fib_path_t path[count];
468 /** \brief Dump IP6 multicast fib table
469 @param client_index - opaque cookie to identify the sender
477 /** \brief IP6 Multicast FIB table response
478 @param table_id - IP fib table id
479 @address_length - mask length
480 @grp_address - Group address/prefix
481 @src_address - Source address
482 @param count - the number of fib_path in path
483 @param path - array of of fib_path structures
485 manual_endian manual_print define ip6_mfib_details
493 vl_api_fib_path_t path[count];
496 define ip_address_details
506 define ip_address_dump
528 define mfib_signal_dump
534 define mfib_signal_details
544 u8 ip_packet_data[256];
549 * eval: (c-set-style "gnu")