/** \brief IP neighbor
@param sw_if_index - interface used to reach neighbor
- @param flags - flags for the nieghbor
+ @param flags - flags for the neighbor
@param mac_address - l2 address of the neighbor
@param ip_address - ip4 or ip6 address of the neighbor
*/
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_add - 1 to add neighbor, 0 to delete
- @param neighbor - the neighor to add/remove
+ @param neighbor - the neighbor to add/remove
*/
define ip_neighbor_add_del
{
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param retval - return value
- @param stats_index - the index to use for this neighbor in the stats segement
+ @param stats_index - the index to use for this neighbor in the stats segment
*/
define ip_neighbor_add_del_reply
{
u32 stats_index;
};
-/** \brief Dump IP neighboors
+/** \brief Dump IP neighbors
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - the interface to dump neighboors, ~0 == all
+ @param sw_if_index - the interface to dump neighbors, ~0 == all
@param af - address family is ipv[6|4]
*/
define ip_neighbor_dump
vl_api_address_family_t af;
};
-/** \brief IP neighboors dump response
+/** \brief IP neighbors dump response
@param context - sender context which was passed in the request
+ @param age - time between last update and sending this message, in seconds
@param neighbour - the neighbor
*/
define ip_neighbor_details {
bool recycle;
};
-/** \brief Register for IP4 ARP resolution event on receing ARP reply or
+/** \brief IP neighbour replace begin
+
+ The use-case is that, for some unspecified reason, the control plane
+ has a different set of neighbours it than VPP
+ currently has. The CP would thus like to 'replace' VPP's set
+ only by specifying what the new set shall be, i.e. it is not
+ going to delete anything that already exists, rather, it wants any
+ unspecified neighbors deleted implicitly.
+ The CP declares the start of this procedure with this replace_begin
+ API Call, and when it has populated all neighbours it wants, it calls
+ the below replace_end API. From this point on it is of course free
+ to add and delete neighbours as usual.
+ The underlying mechanism by which VPP implements this replace is
+ intentionally left unspecified.
+
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+autoreply define ip_neighbor_replace_begin
+{
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief IP neighbour replace end
+
+ see ip_neighbor_replace_begin description.
+
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+*/
+autoreply define ip_neighbor_replace_end
+{
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief IP neighbor flush request - removes *all* neighbours.
+ dynamic and static from API/CLI and dynamic from data-plane.
+
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param af - Flush neighbours of this address family
+ @param sw_if_index - Flush on this interface (~0 => all interfaces)
+*/
+autoreply define ip_neighbor_flush
+{
+ u32 client_index;
+ u32 context;
+ vl_api_address_family_t af;
+ vl_api_interface_index_t sw_if_index [default=0xffffffff];
+};
+
+/** \brief Register for IP4 ARP resolution event on receiving ARP reply or
MAC/IP info from ARP requests in L2 BDs
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
Code Review / vpp.git / blobdiff