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 define ip_neighbor_add_del
144 /* 1 = add, 0 = delete */
153 /** \brief Reply for IP Neighbor add / delete request
154 @param context - returned sender context, to match reply w/ request
155 @param retval - return code
157 define ip_neighbor_add_del_reply
163 /** \brief Set the ip flow hash config for a fib request
164 @param client_index - opaque cookie to identify the sender
165 @param context - sender context, to match reply w/ request
166 @param vrf_id - vrf/fib id
167 @param is_ipv6 - if non-zero the fib is ip6, else ip4
168 @param src - if non-zero include src in flow hash
169 @param dst - if non-zero include dst in flow hash
170 @param sport - if non-zero include sport in flow hash
171 @param dport - if non-zero include dport in flow hash
172 @param proto -if non-zero include proto in flow hash
173 @param reverse - if non-zero include reverse in flow hash
175 define set_ip_flow_hash
189 /** \brief Set the ip flow hash config for a fib response
190 @param context - sender context, to match reply w/ request
191 @param retval - return code for the request
193 define set_ip_flow_hash_reply
199 /** \brief IPv6 router advertisement config request
200 @param client_index - opaque cookie to identify the sender
201 @param context - sender context, to match reply w/ request
206 @param send_unicast -
209 @param default_router -
210 @param max_interval -
211 @param min_interval -
213 @param initial_count -
214 @param initial_interval -
216 define sw_interface_ip6nd_ra_config
233 u32 initial_interval;
236 /** \brief IPv6 router advertisement config response
237 @param context - sender context, to match reply w/ request
238 @param retval - return code for the request
240 define sw_interface_ip6nd_ra_config_reply
246 /** \brief IPv6 router advertisement prefix config request
247 @param client_index - opaque cookie to identify the sender
248 @param context - sender context, to match reply w/ request
249 @param sw_if_index - The interface the RA prefix information is for
250 @param address[] - The prefix to advertise
251 @param address_length - the prefix length
252 @param use_default - Revert to default settings
253 @param no_advertise - Do not advertise this prefix
254 @param off_link - The prefix is off link (it is not configured on the interface)
255 Configures the L-flag, When set, indicates that this
256 prefix can be used for on-link determination.
257 @param no_autoconfig - Setting for the A-flag. When
258 set indicates that this prefix can be used for
259 stateless address configuration.
260 @param no_onlink - The prefix is not on link. Make sure this is consistent
261 with the off_link parameter else YMMV
262 @param is_no - add/delete
263 @param val_lifetime - The length of time in
264 seconds (relative to the time the packet is sent)
265 that the prefix is valid for the purpose of on-link
266 determination. A value of all one bits
267 (0xffffffff) represents infinity
268 @param pref_lifetime - The length of time in
269 seconds (relative to the time the packet is sent)
270 that addresses generated from the prefix via
271 stateless address autoconfiguration remain
272 preferred [ADDRCONF]. A value of all one bits
273 (0xffffffff) represents infinity.
275 define sw_interface_ip6nd_ra_prefix
292 /** \brief IPv6 router advertisement prefix config response
293 @param context - sender context, to match reply w/ request
294 @param retval - return code for the request
296 define sw_interface_ip6nd_ra_prefix_reply
302 /** \brief IPv6 ND proxy config
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 - The interface the host is on
306 @param address - The address of the host for which to proxy for
307 @param is_add - Adding or deleting
309 define ip6nd_proxy_add_del
318 /** \brief IPv6 ND proxy response
319 @param context - sender context, to match reply w/ request
320 @param retval - return code for the request
322 define ip6nd_proxy_add_del_reply
328 /** \brief IPv6 ND proxy details returned after request
329 @param context - sender context, to match reply w/ request
330 @param retval - return code for the request
332 define ip6nd_proxy_details
340 /** \brief IPv6 ND proxy dump request
341 @param context - sender context, to match reply w/ request
342 @param retval - return code for the request
343 @param sw_if_index - The interface the host is on
344 @param address - The address of the host for which to proxy for
346 define ip6nd_proxy_dump
352 /** \brief IPv6 interface enable / disable request
353 @param client_index - opaque cookie to identify the sender
354 @param context - sender context, to match reply w/ request
355 @param sw_if_index - interface used to reach neighbor
356 @param enable - if non-zero enable ip6 on interface, else disable
358 define sw_interface_ip6_enable_disable
363 u8 enable; /* set to true if enable */
366 /** \brief IPv6 interface enable / disable response
367 @param context - sender context, to match reply w/ request
368 @param retval - return code for the request
370 define sw_interface_ip6_enable_disable_reply
376 /** \brief IPv6 set link local address on interface request
377 @param client_index - opaque cookie to identify the sender
378 @param context - sender context, to match reply w/ request
379 @param sw_if_index - interface to set link local on
380 @param address[] - the new link local address
382 define sw_interface_ip6_set_link_local_address
390 /** \brief IPv6 set link local address on interface response
391 @param context - sender context, to match reply w/ request
392 @param retval - error code for the request
394 define sw_interface_ip6_set_link_local_address_reply
400 /** \brief Add / del route request
401 @param client_index - opaque cookie to identify the sender
402 @param context - sender context, to match reply w/ request
403 @param sw_if_index - software index of the new vlan's parent interface
404 @param vrf_id - fib table /vrf associated with the route
405 @param lookup_in_vrf -
406 @param classify_table_index -
407 @param create_vrf_if_needed -
408 @param is_add - 1 if adding the route, 0 if deleting
409 @param is_drop - Drop the packet
410 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
411 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
412 @param is_ipv6 - 0 if an ip4 route, else ip6
415 @param is_multipath - Set to 1 if this is a multipath route, else 0
416 @param not_last - Is last or not last msg in group of multiple add/del msgs
417 @param next_hop_weight -
418 @param dst_address_length -
419 @param dst_address[16] -
420 @param next_hop_address[16] -
421 @param next_hop_n_out_labels - the number of labels in the label stack
422 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
423 @param next_hop_via_label - The next-hop is a resolved via a local label
425 define ip_add_del_route
429 u32 next_hop_sw_if_index;
431 u32 classify_table_index;
432 u32 next_hop_table_id;
433 u8 create_vrf_if_needed;
443 u8 is_resolve_attached;
444 /* Is last/not-last message in group of multiple add/del messages. */
447 u8 dst_address_length;
449 u8 next_hop_address[16];
450 u8 next_hop_n_out_labels;
451 u32 next_hop_via_label;
452 u32 next_hop_out_label_stack[next_hop_n_out_labels];
455 /** \brief Reply for add / del route request
456 @param context - returned sender context, to match reply w/ request
457 @param retval - return code
459 define ip_add_del_route_reply
465 /** \brief Add / del route request
466 @param client_index - opaque cookie to identify the sender
467 @param context - sender context, to match reply w/ request
468 @param sw_if_index - software index of the new vlan's parent interface
469 @param vrf_id - fib table /vrf associated with the route
473 define ip_mroute_add_del
477 u32 next_hop_sw_if_index;
481 u16 grp_address_length;
482 u8 create_vrf_if_needed;
490 /** \brief Reply for add / del mroute request
491 @param context - returned sender context, to match reply w/ request
492 @param retval - return code
494 define ip_mroute_add_del_reply
500 /** \brief Dump IP multicast fib table
501 @param client_index - opaque cookie to identify the sender
509 /** \brief IP Multicast FIB table response
510 @param table_id - IP fib table id
511 @address_length - mask length
512 @grp_address - Group address/prefix
513 @src_address - Source address
514 @param count - the number of fib_path in path
515 @param path - array of of fib_path structures
517 manual_endian manual_print define ip_mfib_details
525 vl_api_fib_path_t path[count];
528 /** \brief Dump IP6 multicast fib table
529 @param client_index - opaque cookie to identify the sender
537 /** \brief IP6 Multicast FIB table response
538 @param table_id - IP fib table id
539 @address_length - mask length
540 @grp_address - Group address/prefix
541 @src_address - Source address
542 @param count - the number of fib_path in path
543 @param path - array of of fib_path structures
545 manual_endian manual_print define ip6_mfib_details
553 vl_api_fib_path_t path[count];
556 define ip_address_details
566 define ip_address_dump
588 define mfib_signal_dump
594 define mfib_signal_details
604 u8 ip_packet_data[256];
609 * eval: (c-set-style "gnu")