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
132 @param mac_address - l2 address of the neighbor
133 @param dst_address - ip4 or ip6 address of the neighbor
135 define ip_neighbor_add_del
140 /* 1 = add, 0 = delete */
148 /** \brief Reply for IP Neighbor add / delete request
149 @param context - returned sender context, to match reply w/ request
150 @param retval - return code
152 define ip_neighbor_add_del_reply
158 /** \brief Set the ip flow hash config for a fib request
159 @param client_index - opaque cookie to identify the sender
160 @param context - sender context, to match reply w/ request
161 @param vrf_id - vrf/fib id
162 @param is_ipv6 - if non-zero the fib is ip6, else ip4
163 @param src - if non-zero include src in flow hash
164 @param dst - if non-zero include dst in flow hash
165 @param sport - if non-zero include sport in flow hash
166 @param dport - if non-zero include dport in flow hash
167 @param proto -if non-zero include proto in flow hash
168 @param reverse - if non-zero include reverse in flow hash
170 define set_ip_flow_hash
184 /** \brief Set the ip flow hash config for a fib response
185 @param context - sender context, to match reply w/ request
186 @param retval - return code for the request
188 define set_ip_flow_hash_reply
194 /** \brief IPv6 router advertisement config request
195 @param client_index - opaque cookie to identify the sender
196 @param context - sender context, to match reply w/ request
201 @param send_unicast -
204 @param default_router -
205 @param max_interval -
206 @param min_interval -
208 @param initial_count -
209 @param initial_interval -
211 define sw_interface_ip6nd_ra_config
228 u32 initial_interval;
231 /** \brief IPv6 router advertisement config response
232 @param context - sender context, to match reply w/ request
233 @param retval - return code for the request
235 define sw_interface_ip6nd_ra_config_reply
241 /** \brief IPv6 router advertisement prefix config request
242 @param client_index - opaque cookie to identify the sender
243 @param context - sender context, to match reply w/ request
244 @param sw_if_index - The interface the RA prefix information is for
245 @param address[] - The prefix to advertise
246 @param address_length - the prefix length
247 @param use_default - Revert to default settings
248 @param no_advertise - Do not advertise this prefix
249 @param off_link - The prefix is off link (it is not configured on the interface)
250 Configures the L-flag, When set, indicates that this
251 prefix can be used for on-link determination.
252 @param no_autoconfig - Setting for the A-flag. When
253 set indicates that this prefix can be used for
254 stateless address configuration.
255 @param no_onlink - The prefix is not on link. Make sure this is consistent
256 with the off_link parameter else YMMV
257 @param is_no - add/delete
258 @param val_lifetime - The length of time in
259 seconds (relative to the time the packet is sent)
260 that the prefix is valid for the purpose of on-link
261 determination. A value of all one bits
262 (0xffffffff) represents infinity
263 @param pref_lifetime - The length of time in
264 seconds (relative to the time the packet is sent)
265 that addresses generated from the prefix via
266 stateless address autoconfiguration remain
267 preferred [ADDRCONF]. A value of all one bits
268 (0xffffffff) represents infinity.
270 define sw_interface_ip6nd_ra_prefix
287 /** \brief IPv6 router advertisement prefix config response
288 @param context - sender context, to match reply w/ request
289 @param retval - return code for the request
291 define sw_interface_ip6nd_ra_prefix_reply
297 /** \brief IPv6 interface enable / disable request
298 @param client_index - opaque cookie to identify the sender
299 @param context - sender context, to match reply w/ request
300 @param sw_if_index - interface used to reach neighbor
301 @param enable - if non-zero enable ip6 on interface, else disable
303 define sw_interface_ip6_enable_disable
308 u8 enable; /* set to true if enable */
311 /** \brief IPv6 interface enable / disable response
312 @param context - sender context, to match reply w/ request
313 @param retval - return code for the request
315 define sw_interface_ip6_enable_disable_reply
321 /** \brief IPv6 set link local address on interface request
322 @param client_index - opaque cookie to identify the sender
323 @param context - sender context, to match reply w/ request
324 @param sw_if_index - interface to set link local on
325 @param address[] - the new link local address
327 define sw_interface_ip6_set_link_local_address
335 /** \brief IPv6 set link local address on interface response
336 @param context - sender context, to match reply w/ request
337 @param retval - error code for the request
339 define sw_interface_ip6_set_link_local_address_reply
345 /** \brief Add / del route request
346 @param client_index - opaque cookie to identify the sender
347 @param context - sender context, to match reply w/ request
348 @param sw_if_index - software index of the new vlan's parent interface
349 @param vrf_id - fib table /vrf associated with the route
350 @param lookup_in_vrf -
351 @param classify_table_index -
352 @param create_vrf_if_needed -
353 @param is_add - 1 if adding the route, 0 if deleting
354 @param is_drop - Drop the packet
355 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
356 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
357 @param is_ipv6 - 0 if an ip4 route, else ip6
360 @param is_multipath - Set to 1 if this is a multipath route, else 0
361 @param not_last - Is last or not last msg in group of multiple add/del msgs
362 @param next_hop_weight -
363 @param dst_address_length -
364 @param dst_address[16] -
365 @param next_hop_address[16] -
366 @param next_hop_n_out_labels - the number of labels in the label stack
367 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
368 @param next_hop_via_label - The next-hop is a resolved via a local label
370 define ip_add_del_route
374 u32 next_hop_sw_if_index;
376 u32 classify_table_index;
377 u32 next_hop_table_id;
378 u8 create_vrf_if_needed;
388 u8 is_resolve_attached;
389 /* Is last/not-last message in group of multiple add/del messages. */
392 u8 dst_address_length;
394 u8 next_hop_address[16];
395 u8 next_hop_n_out_labels;
396 u32 next_hop_via_label;
397 u32 next_hop_out_label_stack[next_hop_n_out_labels];
400 /** \brief Reply for add / del route request
401 @param context - returned sender context, to match reply w/ request
402 @param retval - return code
404 define ip_add_del_route_reply
410 /** \brief Add / del route request
411 @param client_index - opaque cookie to identify the sender
412 @param context - sender context, to match reply w/ request
413 @param sw_if_index - software index of the new vlan's parent interface
414 @param vrf_id - fib table /vrf associated with the route
418 define ip_mroute_add_del
422 u32 next_hop_sw_if_index;
426 u16 grp_address_length;
427 u8 create_vrf_if_needed;
435 /** \brief Reply for add / del mroute request
436 @param context - returned sender context, to match reply w/ request
437 @param retval - return code
439 define ip_mroute_add_del_reply
445 /** \brief Dump IP multicast fib table
446 @param client_index - opaque cookie to identify the sender
454 /** \brief IP Multicast FIB table response
455 @param table_id - IP fib table id
456 @address_length - mask length
457 @grp_address - Group address/prefix
458 @src_address - Source address
459 @param count - the number of fib_path in path
460 @param path - array of of fib_path structures
462 manual_endian manual_print define ip_mfib_details
470 vl_api_fib_path_t path[count];
473 /** \brief Dump IP6 multicast fib table
474 @param client_index - opaque cookie to identify the sender
482 /** \brief IP6 Multicast FIB table response
483 @param table_id - IP fib table id
484 @address_length - mask length
485 @grp_address - Group address/prefix
486 @src_address - Source address
487 @param count - the number of fib_path in path
488 @param path - array of of fib_path structures
490 manual_endian manual_print define ip6_mfib_details
498 vl_api_fib_path_t path[count];
501 define ip_address_details
511 define ip_address_dump
533 define mfib_signal_dump
539 define mfib_signal_details
549 u8 ip_packet_data[256];
554 * eval: (c-set-style "gnu")