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 vrf_id - vrf_id, only for IP4
129 @param sw_if_index - interface used to reach neighbor
130 @param is_add - 1 to add neighbor, 0 to delete
131 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
133 @param mac_address - l2 address of the neighbor
134 @param dst_address - ip4 or ip6 address of the neighbor
136 define ip_neighbor_add_del
140 u32 vrf_id; /* only makes sense for ip4 */
142 /* 1 = add, 0 = delete */
150 /** \brief Reply for IP Neighbor add / delete request
151 @param context - returned sender context, to match reply w/ request
152 @param retval - return code
154 define ip_neighbor_add_del_reply
160 /** \brief Set the ip flow hash config for a fib request
161 @param client_index - opaque cookie to identify the sender
162 @param context - sender context, to match reply w/ request
163 @param vrf_id - vrf/fib id
164 @param is_ipv6 - if non-zero the fib is ip6, else ip4
165 @param src - if non-zero include src in flow hash
166 @param dst - if non-zero include dst in flow hash
167 @param sport - if non-zero include sport in flow hash
168 @param dport - if non-zero include dport in flow hash
169 @param proto -if non-zero include proto in flow hash
170 @param reverse - if non-zero include reverse in flow hash
172 define set_ip_flow_hash
186 /** \brief Set the ip flow hash config for a fib response
187 @param context - sender context, to match reply w/ request
188 @param retval - return code for the request
190 define set_ip_flow_hash_reply
196 /** \brief IPv6 router advertisement config request
197 @param client_index - opaque cookie to identify the sender
198 @param context - sender context, to match reply w/ request
203 @param send_unicast -
206 @param default_router -
207 @param max_interval -
208 @param min_interval -
210 @param initial_count -
211 @param initial_interval -
213 define sw_interface_ip6nd_ra_config
230 u32 initial_interval;
233 /** \brief IPv6 router advertisement config response
234 @param context - sender context, to match reply w/ request
235 @param retval - return code for the request
237 define sw_interface_ip6nd_ra_config_reply
243 /** \brief IPv6 router advertisement prefix config request
244 @param client_index - opaque cookie to identify the sender
245 @param context - sender context, to match reply w/ request
248 @param address_length -
250 @param no_advertise -
252 @param no_autoconfig -
255 @param val_lifetime -
256 @param pref_lifetime -
258 define sw_interface_ip6nd_ra_prefix
275 /** \brief IPv6 router advertisement prefix config response
276 @param context - sender context, to match reply w/ request
277 @param retval - return code for the request
279 define sw_interface_ip6nd_ra_prefix_reply
285 /** \brief IPv6 interface enable / disable request
286 @param client_index - opaque cookie to identify the sender
287 @param context - sender context, to match reply w/ request
288 @param sw_if_index - interface used to reach neighbor
289 @param enable - if non-zero enable ip6 on interface, else disable
291 define sw_interface_ip6_enable_disable
296 u8 enable; /* set to true if enable */
299 /** \brief IPv6 interface enable / disable response
300 @param context - sender context, to match reply w/ request
301 @param retval - return code for the request
303 define sw_interface_ip6_enable_disable_reply
309 /** \brief IPv6 set link local address on interface request
310 @param client_index - opaque cookie to identify the sender
311 @param context - sender context, to match reply w/ request
312 @param sw_if_index - interface to set link local on
313 @param address[] - the new link local address
315 define sw_interface_ip6_set_link_local_address
323 /** \brief IPv6 set link local address on interface response
324 @param context - sender context, to match reply w/ request
325 @param retval - error code for the request
327 define sw_interface_ip6_set_link_local_address_reply
333 /** \brief Add / del route request
334 @param client_index - opaque cookie to identify the sender
335 @param context - sender context, to match reply w/ request
336 @param sw_if_index - software index of the new vlan's parent interface
337 @param vrf_id - fib table /vrf associated with the route
338 @param lookup_in_vrf -
339 @param classify_table_index -
340 @param create_vrf_if_needed -
341 @param is_add - 1 if adding the route, 0 if deleting
342 @param is_drop - Drop the packet
343 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
344 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
345 @param is_ipv6 - 0 if an ip4 route, else ip6
348 @param is_multipath - Set to 1 if this is a multipath route, else 0
349 @param not_last - Is last or not last msg in group of multiple add/del msgs
350 @param next_hop_weight -
351 @param dst_address_length -
352 @param dst_address[16] -
353 @param next_hop_address[16] -
354 @param next_hop_n_out_labels - the number of labels in the label stack
355 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
356 @param next_hop_via_label - The next-hop is a resolved via a local label
358 define ip_add_del_route
362 u32 next_hop_sw_if_index;
364 u32 classify_table_index;
365 u32 next_hop_table_id;
366 u8 create_vrf_if_needed;
376 u8 is_resolve_attached;
377 /* Is last/not-last message in group of multiple add/del messages. */
380 u8 dst_address_length;
382 u8 next_hop_address[16];
383 u8 next_hop_n_out_labels;
384 u32 next_hop_via_label;
385 u32 next_hop_out_label_stack[next_hop_n_out_labels];
388 /** \brief Reply for add / del route request
389 @param context - returned sender context, to match reply w/ request
390 @param retval - return code
392 define ip_add_del_route_reply
398 /** \brief Add / del route request
399 @param client_index - opaque cookie to identify the sender
400 @param context - sender context, to match reply w/ request
401 @param sw_if_index - software index of the new vlan's parent interface
402 @param vrf_id - fib table /vrf associated with the route
406 define ip_mroute_add_del
410 u32 next_hop_sw_if_index;
414 u16 grp_address_length;
415 u8 create_vrf_if_needed;
423 /** \brief Reply for add / del mroute request
424 @param context - returned sender context, to match reply w/ request
425 @param retval - return code
427 define ip_mroute_add_del_reply
433 /** \brief Dump IP multicast fib table
434 @param client_index - opaque cookie to identify the sender
442 /** \brief IP Multicast FIB table response
443 @param table_id - IP fib table id
444 @address_length - mask length
445 @grp_address - Group address/prefix
446 @src_address - Source address
447 @param count - the number of fib_path in path
448 @param path - array of of fib_path structures
450 manual_endian manual_print define ip_mfib_details
458 vl_api_fib_path_t path[count];
461 /** \brief Dump IP6 multicast fib table
462 @param client_index - opaque cookie to identify the sender
470 /** \brief IP6 Multicast FIB table response
471 @param table_id - IP fib table id
472 @address_length - mask length
473 @grp_address - Group address/prefix
474 @src_address - Source address
475 @param count - the number of fib_path in path
476 @param path - array of of fib_path structures
478 manual_endian manual_print define ip6_mfib_details
486 vl_api_fib_path_t path[count];
489 define ip_address_details
499 define ip_address_dump
521 define mfib_signal_dump
527 define mfib_signal_details
537 u8 ip_packet_data[256];
542 * eval: (c-set-style "gnu")