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
31 autoreply define ip_table_add_del
40 /** \brief Dump IP fib table
41 @param client_index - opaque cookie to identify the sender
50 @param sw_if_index - index of the interface
51 @param weight - The weight, for UCMP
52 @param preference - The preference of the path. lowest preference is prefered
53 @param is_local - local if non-zero, else remote
54 @param is_drop - Drop the packet
55 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
56 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
57 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
58 @param next_hop[16] - the next hop address
60 WARNING: this type is replicated, pending cleanup completion
62 typeonly manual_print manual_endian define fib_path
75 /** \brief IP FIB table response
76 @param table_id - IP fib table id
77 @address_length - mask length
79 @param count - the number of fib_path in path
80 @param path - array of of fib_path structures
82 manual_endian manual_print define ip_fib_details
89 vl_api_fib_path_t path[count];
92 /** \brief Dump IP6 fib table
93 @param client_index - opaque cookie to identify the sender
101 /** \brief IP6 FIB table response
102 @param table_id - IP6 fib table id
103 @address_length - mask length
104 @address - ip6 prefix
105 @param count - the number of fib_path in path
106 @param path - array of of fib_path structures
108 manual_endian manual_print define ip6_fib_details
115 vl_api_fib_path_t path[count];
118 /** \brief Dump IP neighboors
119 @param client_index - opaque cookie to identify the sender
120 @param context - sender context, to match reply w/ request
121 @param sw_if_index - the interface to dump neighboors
122 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
124 define ip_neighbor_dump
132 /** \brief IP neighboors dump response
133 @param context - sender context which was passed in the request
134 @param is_static - [1|0] to indicate if neighbor is statically configured
135 @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
137 define ip_neighbor_details {
145 /** \brief IP neighbor add / del request
146 @param client_index - opaque cookie to identify the sender
147 @param context - sender context, to match reply w/ request
148 @param sw_if_index - interface used to reach neighbor
149 @param is_add - 1 to add neighbor, 0 to delete
150 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
151 @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
152 @param is_static - A static neighbor Entry - there are not flushed
153 If the interface goes down.
154 @param is_no_adj_fib - Do not create a corresponding entry in the FIB
155 table for the neighbor.
156 @param mac_address - l2 address of the neighbor
157 @param dst_address - ip4 or ip6 address of the neighbor
159 autoreply define ip_neighbor_add_del
164 /* 1 = add, 0 = delete */
173 /** \brief Set the ip flow hash config for a fib request
174 @param client_index - opaque cookie to identify the sender
175 @param context - sender context, to match reply w/ request
176 @param vrf_id - vrf/fib id
177 @param is_ipv6 - if non-zero the fib is ip6, else ip4
178 @param src - if non-zero include src in flow hash
179 @param dst - if non-zero include dst in flow hash
180 @param sport - if non-zero include sport in flow hash
181 @param dport - if non-zero include dport in flow hash
182 @param proto -if non-zero include proto in flow hash
183 @param reverse - if non-zero include reverse in flow hash
185 autoreply define set_ip_flow_hash
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 autoreply define sw_interface_ip6nd_ra_config
233 u32 initial_interval;
236 /** \brief IPv6 router advertisement prefix config request
237 @param client_index - opaque cookie to identify the sender
238 @param context - sender context, to match reply w/ request
239 @param sw_if_index - The interface the RA prefix information is for
240 @param address[] - The prefix to advertise
241 @param address_length - the prefix length
242 @param use_default - Revert to default settings
243 @param no_advertise - Do not advertise this prefix
244 @param off_link - The prefix is off link (it is not configured on the interface)
245 Configures the L-flag, When set, indicates that this
246 prefix can be used for on-link determination.
247 @param no_autoconfig - Setting for the A-flag. When
248 set indicates that this prefix can be used for
249 stateless address configuration.
250 @param no_onlink - The prefix is not on link. Make sure this is consistent
251 with the off_link parameter else YMMV
252 @param is_no - add/delete
253 @param val_lifetime - The length of time in
254 seconds (relative to the time the packet is sent)
255 that the prefix is valid for the purpose of on-link
256 determination. A value of all one bits
257 (0xffffffff) represents infinity
258 @param pref_lifetime - The length of time in
259 seconds (relative to the time the packet is sent)
260 that addresses generated from the prefix via
261 stateless address autoconfiguration remain
262 preferred [ADDRCONF]. A value of all one bits
263 (0xffffffff) represents infinity.
265 autoreply define sw_interface_ip6nd_ra_prefix
282 /** \brief IPv6 ND proxy config
283 @param client_index - opaque cookie to identify the sender
284 @param context - sender context, to match reply w/ request
285 @param sw_if_index - The interface the host is on
286 @param address - The address of the host for which to proxy for
287 @param is_add - Adding or deleting
289 autoreply define ip6nd_proxy_add_del
298 /** \brief IPv6 ND proxy details returned after request
299 @param context - sender context, to match reply w/ request
300 @param retval - return code for the request
302 define ip6nd_proxy_details
310 /** \brief IPv6 ND proxy dump request
311 @param context - sender context, to match reply w/ request
312 @param retval - return code for the request
313 @param sw_if_index - The interface the host is on
314 @param address - The address of the host for which to proxy for
316 define ip6nd_proxy_dump
322 /** \brief IPv6 interface enable / disable request
323 @param client_index - opaque cookie to identify the sender
324 @param context - sender context, to match reply w/ request
325 @param sw_if_index - interface used to reach neighbor
326 @param enable - if non-zero enable ip6 on interface, else disable
328 autoreply define sw_interface_ip6_enable_disable
333 u8 enable; /* set to true if enable */
336 /** \brief IPv6 set link local address on interface request
337 @param client_index - opaque cookie to identify the sender
338 @param context - sender context, to match reply w/ request
339 @param sw_if_index - interface to set link local on
340 @param address[] - the new link local address
342 autoreply define sw_interface_ip6_set_link_local_address
350 /** \brief Add / del route request
351 @param client_index - opaque cookie to identify the sender
352 @param context - sender context, to match reply w/ request
353 @param sw_if_index - software index of the new vlan's parent interface
354 @param vrf_id - fib table /vrf associated with the route
355 @param lookup_in_vrf -
356 @param classify_table_index -
357 @param create_vrf_if_needed -
358 @param is_add - 1 if adding the route, 0 if deleting
359 @param is_drop - Drop the packet
360 @param is_unreach - Drop the packet and rate limit send ICMP unreachable
361 @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
362 @param is_ipv6 - 0 if an ip4 route, else ip6
365 @param is_multipath - Set to 1 if this is a multipath route, else 0
366 @param not_last - Is last or not last msg in group of multiple add/del msgs
367 @param next_hop_weight -
368 @param dst_address_length -
369 @param dst_address[16] -
370 @param next_hop_address[16] -
371 @param next_hop_n_out_labels - the number of labels in the label stack
372 @param next_hop_out_label_stack - the next-hop output label stack, outer most first
373 @param next_hop_via_label - The next-hop is a resolved via a local label
375 autoreply define ip_add_del_route
379 u32 next_hop_sw_if_index;
381 u32 classify_table_index;
382 u32 next_hop_table_id;
383 u8 create_vrf_if_needed;
393 u8 is_resolve_attached;
394 /* Is last/not-last message in group of multiple add/del messages. */
397 u8 next_hop_preference;
398 u8 dst_address_length;
400 u8 next_hop_address[16];
401 u8 next_hop_n_out_labels;
402 u32 next_hop_via_label;
403 u32 next_hop_out_label_stack[next_hop_n_out_labels];
406 /** \brief Add / del route request
407 @param client_index - opaque cookie to identify the sender
408 @param context - sender context, to match reply w/ request
409 @param sw_if_index - software index of the new vlan's parent interface
410 @param vrf_id - fib table /vrf associated with the route
414 autoreply define ip_mroute_add_del
418 u32 next_hop_sw_if_index;
423 u16 grp_address_length;
424 u8 create_vrf_if_needed;
432 /** \brief Dump IP multicast fib table
433 @param client_index - opaque cookie to identify the sender
441 /** \brief IP Multicast FIB table response
442 @param table_id - IP fib table id
443 @address_length - mask length
444 @grp_address - Group address/prefix
445 @src_address - Source address
446 @param count - the number of fib_path in path
447 @param path - array of of fib_path structures
449 manual_endian manual_print define ip_mfib_details
459 vl_api_fib_path_t path[count];
462 /** \brief Dump IP6 multicast fib table
463 @param client_index - opaque cookie to identify the sender
471 /** \brief IP6 Multicast FIB table response
472 @param table_id - IP fib table id
473 @address_length - mask length
474 @grp_address - Group address/prefix
475 @src_address - Source address
476 @param count - the number of fib_path in path
477 @param path - array of of fib_path structures
479 manual_endian manual_print define ip6_mfib_details
487 vl_api_fib_path_t path[count];
490 define ip_address_details
500 define ip_address_dump
522 define mfib_signal_dump
528 define mfib_signal_details
538 u8 ip_packet_data[256];
543 * eval: (c-set-style "gnu")