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 Dump IP fib table
23 @param client_index - opaque cookie to identify the sender
32 @param sw_if_index - index of the interface
33 @param weight - The weight, for UCMP
34 @param is_local - local if non-zero, else remote
35 @param is_drop - Drop the packet
36 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
37 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
38 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
39 @param next_hop[16] - the next hop address
41 WARNING: this type is replicated, pending cleanup completion
43 typeonly manual_print manual_endian define fib_path
55 /** \brief IP FIB table response
56 @param table_id - IP fib table id
57 @address_length - mask length
59 @param count - the number of fib_path in path
60 @param path - array of of fib_path structures
62 manual_endian manual_print define ip_fib_details
69 vl_api_fib_path_t path[count];
72 /** \brief Dump IP6 fib table
73 @param client_index - opaque cookie to identify the sender
81 /** \brief IP6 FIB table response
82 @param table_id - IP6 fib table id
83 @address_length - mask length
85 @param count - the number of fib_path in path
86 @param path - array of of fib_path structures
88 manual_endian manual_print define ip6_fib_details
95 vl_api_fib_path_t path[count];
98 /** \brief Dump IP neighboors
99 @param client_index - opaque cookie to identify the sender
100 @param context - sender context, to match reply w/ request
101 @param sw_if_index - the interface to dump neighboors
102 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
104 define ip_neighbor_dump
112 /** \brief IP neighboors dump response
113 @param context - sender context which was passed in the request
114 @param is_static - [1|0] to indicate if neighbor is statically configured
115 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
117 define ip_neighbor_details {
125 /** \brief IP neighbor add / del request
126 @param client_index - opaque cookie to identify the sender
127 @param context - sender context, to match reply w/ request
128 @param sw_if_index - interface used to reach neighbor
129 @param is_add - 1 to add neighbor, 0 to delete
130 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
131 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
132 @param is_static - A static neighbor Entry - there are not flushed
133 If the interface goes down.
134 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
135 table for the neighbor.
136 @param mac_address - l2 address of the neighbor
137 @param dst_address - ip4 or ip6 address of the neighbor
139 autoreply define ip_neighbor_add_del
144 /* 1 = add, 0 = delete */
153 /** \brief Set the ip flow hash config for a fib request
154 @param client_index - opaque cookie to identify the sender
155 @param context - sender context, to match reply w/ request
156 @param vrf_id - vrf/fib id
157 @param is_ipv6 - if non-zero the fib is ip6, else ip4
158 @param src - if non-zero include src in flow hash
159 @param dst - if non-zero include dst in flow hash
160 @param sport - if non-zero include sport in flow hash
161 @param dport - if non-zero include dport in flow hash
162 @param proto -if non-zero include proto in flow hash
163 @param reverse - if non-zero include reverse in flow hash
165 autoreply define set_ip_flow_hash
179 /** \brief IPv6 router advertisement config request
180 @param client_index - opaque cookie to identify the sender
181 @param context - sender context, to match reply w/ request
186 @param send_unicast -
189 @param default_router -
190 @param max_interval -
191 @param min_interval -
193 @param initial_count -
194 @param initial_interval -
196 autoreply define sw_interface_ip6nd_ra_config
213 u32 initial_interval;
216 /** \brief IPv6 router advertisement prefix config request
217 @param client_index - opaque cookie to identify the sender
218 @param context - sender context, to match reply w/ request
219 @param sw_if_index - The interface the RA prefix information is for
220 @param address[] - The prefix to advertise
221 @param address_length - the prefix length
222 @param use_default - Revert to default settings
223 @param no_advertise - Do not advertise this prefix
224 @param off_link - The prefix is off link (it is not configured on the interface)
225 Configures the L-flag, When set, indicates that this
226 prefix can be used for on-link determination.
227 @param no_autoconfig - Setting for the A-flag. When
228 set indicates that this prefix can be used for
229 stateless address configuration.
230 @param no_onlink - The prefix is not on link. Make sure this is consistent
231 with the off_link parameter else YMMV
232 @param is_no - add/delete
233 @param val_lifetime - The length of time in
234 seconds (relative to the time the packet is sent)
235 that the prefix is valid for the purpose of on-link
236 determination. A value of all one bits
237 (0xffffffff) represents infinity
238 @param pref_lifetime - The length of time in
239 seconds (relative to the time the packet is sent)
240 that addresses generated from the prefix via
241 stateless address autoconfiguration remain
242 preferred [ADDRCONF]. A value of all one bits
243 (0xffffffff) represents infinity.
245 autoreply define sw_interface_ip6nd_ra_prefix
262 /** \brief IPv6 ND proxy config
263 @param client_index - opaque cookie to identify the sender
264 @param context - sender context, to match reply w/ request
265 @param sw_if_index - The interface the host is on
266 @param address - The address of the host for which to proxy for
267 @param is_add - Adding or deleting
269 autoreply define ip6nd_proxy_add_del
278 /** \brief IPv6 ND proxy details returned after request
279 @param context - sender context, to match reply w/ request
280 @param retval - return code for the request
282 define ip6nd_proxy_details
290 /** \brief IPv6 ND proxy dump request
291 @param context - sender context, to match reply w/ request
292 @param retval - return code for the request
293 @param sw_if_index - The interface the host is on
294 @param address - The address of the host for which to proxy for
296 define ip6nd_proxy_dump
302 /** \brief IPv6 interface enable / disable request
303 @param client_index - opaque cookie to identify the sender
304 @param context - sender context, to match reply w/ request
305 @param sw_if_index - interface used to reach neighbor
306 @param enable - if non-zero enable ip6 on interface, else disable
308 autoreply define sw_interface_ip6_enable_disable
313 u8 enable; /* set to true if enable */
316 /** \brief IPv6 set link local address on interface request
317 @param client_index - opaque cookie to identify the sender
318 @param context - sender context, to match reply w/ request
319 @param sw_if_index - interface to set link local on
320 @param address[] - the new link local address
322 autoreply define sw_interface_ip6_set_link_local_address
330 /** \brief Add / del route request
331 @param client_index - opaque cookie to identify the sender
332 @param context - sender context, to match reply w/ request
333 @param sw_if_index - software index of the new vlan's parent interface
334 @param vrf_id - fib table /vrf associated with the route
335 @param lookup_in_vrf -
336 @param classify_table_index -
337 @param create_vrf_if_needed -
338 @param is_add - 1 if adding the route, 0 if deleting
339 @param is_drop - Drop the packet
340 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
341 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
342 @param is_ipv6 - 0 if an ip4 route, else ip6
345 @param is_multipath - Set to 1 if this is a multipath route, else 0
346 @param not_last - Is last or not last msg in group of multiple add/del msgs
347 @param next_hop_weight -
348 @param dst_address_length -
349 @param dst_address[16] -
350 @param next_hop_address[16] -
351 @param next_hop_n_out_labels - the number of labels in the label stack
352 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
353 @param next_hop_via_label - The next-hop is a resolved via a local label
355 autoreply define ip_add_del_route
359 u32 next_hop_sw_if_index;
361 u32 classify_table_index;
362 u32 next_hop_table_id;
363 u8 create_vrf_if_needed;
373 u8 is_resolve_attached;
374 /* Is last/not-last message in group of multiple add/del messages. */
377 u8 dst_address_length;
379 u8 next_hop_address[16];
380 u8 next_hop_n_out_labels;
381 u32 next_hop_via_label;
382 u32 next_hop_out_label_stack[next_hop_n_out_labels];
385 /** \brief Add / del route request
386 @param client_index - opaque cookie to identify the sender
387 @param context - sender context, to match reply w/ request
388 @param sw_if_index - software index of the new vlan's parent interface
389 @param vrf_id - fib table /vrf associated with the route
393 autoreply define ip_mroute_add_del
397 u32 next_hop_sw_if_index;
402 u16 grp_address_length;
403 u8 create_vrf_if_needed;
411 /** \brief Dump IP multicast fib table
412 @param client_index - opaque cookie to identify the sender
420 /** \brief IP Multicast FIB table response
421 @param table_id - IP fib table id
422 @address_length - mask length
423 @grp_address - Group address/prefix
424 @src_address - Source address
425 @param count - the number of fib_path in path
426 @param path - array of of fib_path structures
428 manual_endian manual_print define ip_mfib_details
438 vl_api_fib_path_t path[count];
441 /** \brief Dump IP6 multicast fib table
442 @param client_index - opaque cookie to identify the sender
450 /** \brief IP6 Multicast FIB table response
451 @param table_id - IP fib table id
452 @address_length - mask length
453 @grp_address - Group address/prefix
454 @src_address - Source address
455 @param count - the number of fib_path in path
456 @param path - array of of fib_path structures
458 manual_endian manual_print define ip6_mfib_details
466 vl_api_fib_path_t path[count];
469 define ip_address_details
479 define ip_address_dump
501 define mfib_signal_dump
507 define mfib_signal_details
517 u8 ip_packet_data[256];
522 * eval: (c-set-style "gnu")