1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 This file defines vpp IP neighbor control-plane API messages which are generally
20 called through a shared memory interface.
23 option version = "1.0.1";
25 import "vnet/ip/ip_types.api";
26 import "vnet/ethernet/ethernet_types.api";
27 import "vnet/interface_types.api";
29 /** \brief IP neighbor flags
30 @param is_static - A static neighbor Entry - there are not flushed
31 If the interface goes down.
32 @param is_no_fib_entry - Do not create a corresponding entry in the FIB
33 table for the neighbor.
35 enum ip_neighbor_flags: u8
37 IP_API_NEIGHBOR_FLAG_NONE = 0,
38 IP_API_NEIGHBOR_FLAG_STATIC = 0x1,
39 IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY = 0x2,
42 /** \brief IP neighbor
43 @param sw_if_index - interface used to reach neighbor
44 @param flags - flags for the neighbor
45 @param mac_address - l2 address of the neighbor
46 @param ip_address - ip4 or ip6 address of the neighbor
49 vl_api_interface_index_t sw_if_index;
50 vl_api_ip_neighbor_flags_t flags;
51 vl_api_mac_address_t mac_address;
52 vl_api_address_t ip_address;
55 /** \brief IP neighbor add / del request
56 @param client_index - opaque cookie to identify the sender
57 @param context - sender context, to match reply w/ request
58 @param is_add - 1 to add neighbor, 0 to delete
59 @param neighbor - the neighbor to add/remove
61 define ip_neighbor_add_del
65 /* 1 = add, 0 = delete */
67 vl_api_ip_neighbor_t neighbor;
69 /** \brief IP neighbor add / del reply
70 @param client_index - opaque cookie to identify the sender
71 @param context - sender context, to match reply w/ request
72 @param retval - return value
73 @param stats_index - the index to use for this neighbor in the stats segment
75 define ip_neighbor_add_del_reply
82 /** \brief Dump IP neighbors
83 @param client_index - opaque cookie to identify the sender
84 @param context - sender context, to match reply w/ request
85 @param sw_if_index - the interface to dump neighbors, ~0 == all
86 @param af - address family is ipv[6|4]
88 define ip_neighbor_dump
92 vl_api_interface_index_t sw_if_index [default=0xffffffff];
93 vl_api_address_family_t af;
96 /** \brief IP neighbors dump response
97 @param context - sender context which was passed in the request
98 @param age - time between last update and sending this message, in seconds
99 @param neighbour - the neighbor
101 define ip_neighbor_details {
104 vl_api_ip_neighbor_t neighbor;
107 /** \brief Enable/disable periodic IP neighbor scan
108 @param client_index - opaque cookie to identify the sender
109 @param context - sender context, to match reply w/ request
110 @param af - Address family v4/v6
111 @param max_number - The maximum number of neighbours that will be created.
113 @param max_age - The maximum age (in seconds) before an inactive neighbour
116 @param recycle - If max_number of neighbours is reached and new ones need
117 to be created should the oldest neighbour be 'recycled'.
119 autoreply define ip_neighbor_config
123 vl_api_address_family_t af;
129 /** \brief Get neighbor database configuration per AF
130 @param client_index - opaque cookie to identify the sender
131 @param context - sender context, to match reply w/ request
132 @param af - Address family (v4/v6)
134 define ip_neighbor_config_get
139 vl_api_address_family_t af;
142 /** \brief Neighbor database configuration reply
143 @param context - sender context, to match reply w/ request
144 @param retval - error (0 is "no error")
145 @param af - Address family (v4/v6)
146 @param max_number - The maximum number of neighbours that will be created
147 @param max_age - The maximum age (in seconds) before an inactive neighbour
149 @param recycle - If max_number of neighbours is reached and new ones need
150 to be created, should the oldest neighbour be 'recycled'
152 define ip_neighbor_config_get_reply
157 vl_api_address_family_t af;
163 /** \brief IP neighbour replace begin
165 The use-case is that, for some unspecified reason, the control plane
166 has a different set of neighbours it than VPP
167 currently has. The CP would thus like to 'replace' VPP's set
168 only by specifying what the new set shall be, i.e. it is not
169 going to delete anything that already exists, rather, it wants any
170 unspecified neighbors deleted implicitly.
171 The CP declares the start of this procedure with this replace_begin
172 API Call, and when it has populated all neighbours it wants, it calls
173 the below replace_end API. From this point on it is of course free
174 to add and delete neighbours as usual.
175 The underlying mechanism by which VPP implements this replace is
176 intentionally left unspecified.
178 @param client_index - opaque cookie to identify the sender
179 @param context - sender context, to match reply w/ request
181 autoreply define ip_neighbor_replace_begin
187 /** \brief IP neighbour replace end
189 see ip_neighbor_replace_begin description.
191 @param client_index - opaque cookie to identify the sender
192 @param context - sender context, to match reply w/ request
194 autoreply define ip_neighbor_replace_end
200 /** \brief IP neighbor flush request - removes *all* neighbours.
201 dynamic and static from API/CLI and dynamic from data-plane.
203 @param client_index - opaque cookie to identify the sender
204 @param context - sender context, to match reply w/ request
205 @param af - Flush neighbours of this address family
206 @param sw_if_index - Flush on this interface (~0 => all interfaces)
208 autoreply define ip_neighbor_flush
212 vl_api_address_family_t af;
213 vl_api_interface_index_t sw_if_index [default=0xffffffff];
216 /** \brief Register for IP neighbour events creation
217 @param client_index - opaque cookie to identify the sender
218 @param context - sender context, to match reply w/ request
219 @param enable - 1 => register for events, 0 => cancel registration
220 @param pid - sender's pid
221 @param ip - exact IP address of interested neighbor resolution event
222 @param sw_if_index - interface on which the IP address is present.
224 autoreply define want_ip_neighbor_events
232 vl_api_interface_index_t sw_if_index [default=0xffffffff];
235 /** \brief Tell client about an IP4 ARP resolution event or
236 MAC/IP info from ARP requests in L2 BDs
237 @param client_index - opaque cookie to identify the sender
238 @param pid - client pid registered to receive notification
239 @param neighbor - new neighbor created
241 define ip_neighbor_event
246 vl_api_ip_neighbor_t neighbor;
250 rpc want_ip_neighbor_events returns want_ip_neighbor_events_reply
251 events ip_neighbor_event;
255 /** \brief Register for IP neighbour events (creation or deletion)
256 @param client_index - opaque cookie to identify the sender
257 @param context - sender context, to match reply w/ request
258 @param enable - 1 => register for events, 0 => cancel registration
259 @param pid - sender's pid
260 @param ip - exact IP address of interested neighbor resolution event
261 @param sw_if_index - interface on which the IP address is present.
263 autoreply define want_ip_neighbor_events_v2
270 vl_api_interface_index_t sw_if_index [default=0xffffffff];
273 enum ip_neighbor_event_flags
275 /* The neighbor has been added/learned */
276 IP_NEIGHBOR_API_EVENT_FLAG_ADDED = 0x1,
277 /* The neighbor has been removed/expired */
278 IP_NEIGHBOR_API_EVENT_FLAG_REMOVED = 0x2,
281 /** \brief Tell client about an IP4 ARP resolution event or
282 MAC/IP info from ARP requests in L2 BDs
283 @param client_index - opaque cookie to identify the sender
284 @param pid - client pid registered to receive notification
286 @param neighbor - neighbor
288 define ip_neighbor_event_v2
292 vl_api_ip_neighbor_event_flags_t flags;
293 vl_api_ip_neighbor_t neighbor;
297 rpc want_ip_neighbor_events_v2 returns want_ip_neighbor_events_v2_reply
298 events ip_neighbor_event_v2;
301 counters ip4_neighbor {
306 description "ARP requests throttled";
312 description "ARP requests resolved";
318 description "ARP requests out of buffer";
324 description "ARP requests sent";
330 description "ARPs to non-ARP adjacencies";
336 description "no source address for ARP request";
340 counters ip6_neighbor {
345 description "throttled";
351 description "address overflow drops";
357 description "neighbor solicitations sent";
363 description "no source address for ND solicitation";
369 description "no buffers";
374 "/err/ip4-arp" "ip4_neighbor";
375 "/err/ip4-glean" "ip4_neighbor";
376 "/err/ip6-arp" "ip6_neighbor";
377 "/err/ip6-glean" "ip6_neighbor";
382 * eval: (c-set-style "gnu")