ip_neighbor.api File Reference

This file defines vpp IP neighbor control-plane API messages which are generally called through a shared memory interface. More...

Go to the source code of this file.

Data Structures
struct	vl_api_ip_neighbor_add_del_t
	IP neighbor add / del request. More...
struct	vl_api_ip_neighbor_add_del_reply_t
	IP neighbor add / del reply. More...
struct	vl_api_ip_neighbor_dump_t
	Dump IP neighbors. More...
struct	vl_api_ip_neighbor_details_t
	IP neighbors dump response. More...
struct	vl_api_ip_neighbor_config_t
	Enable/disable periodic IP neighbor scan. More...
struct	vl_api_ip_neighbor_replace_begin_t
	IP neighbour replace begin. More...
struct	vl_api_ip_neighbor_replace_end_t
	IP neighbour replace end. More...
struct	vl_api_ip_neighbor_flush_t
	IP neighbor flush request - removes all neighbours. More...
struct	vl_api_want_ip_neighbor_events_t
	Register for IP neighbour events creation. More...
struct	vl_api_ip_neighbor_event_t
	Tell client about an IP4 ARP resolution event or MAC/IP info from ARP requests in L2 BDs. More...
struct	vl_api_want_ip_neighbor_events_v2_t
	Register for IP neighbour events (creation or deletion) More...
struct	vl_api_ip_neighbor_event_v2_t
	Tell client about an IP4 ARP resolution event or MAC/IP info from ARP requests in L2 BDs. More...

Enumerations
enum	ip_neighbor_flags : u8 { IP_API_NEIGHBOR_FLAG_NONE = 0, IP_API_NEIGHBOR_FLAG_STATIC = 0x1, IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY = 0x2 }
	IP neighbor flags. More...
enum	ip_neighbor_event_flags { IP_NEIGHBOR_API_EVENT_FLAG_ADDED = 0x1, IP_NEIGHBOR_API_EVENT_FLAG_REMOVED = 0x2 }

Variables
option	version = "1.0.0"
import vnet ip ip_types	api
typedef	ip_neighbor
	IP neighbor. More...
vl_api_ip_neighbor_flags_t	flags
vl_api_mac_address_t	mac_address
vl_api_address_t	ip_address
	service

Detailed Description

This file defines vpp IP neighbor control-plane API messages which are generally called through a shared memory interface.

Definition in file ip_neighbor.api.

Enumeration Type Documentation

ip_neighbor_event_flags

enum ip_neighbor_event_flags

Enumerator
IP_NEIGHBOR_API_EVENT_FLAG_ADDED
IP_NEIGHBOR_API_EVENT_FLAG_REMOVED

Definition at line 239 of file ip_neighbor.api.

ip_neighbor_flags

enum ip_neighbor_flags : u8

IP neighbor flags.

Template Parameters

is_static	- A static neighbor Entry - there are not flushed If the interface goes down.
is_no_fib_entry	- Do not create a corresponding entry in the FIB table for the neighbor.

Enumerator
IP_API_NEIGHBOR_FLAG_NONE
IP_API_NEIGHBOR_FLAG_STATIC
IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY

Definition at line 35 of file ip_neighbor.api.

Variable Documentation

api

import vnet interface_types api

Definition at line 25 of file ip_neighbor.api.

flags

vl_api_ip_neighbor_flags_t flags

Definition at line 50 of file ip_neighbor.api.

ip_address

vl_api_address_t ip_address

Definition at line 52 of file ip_neighbor.api.

ip_neighbor

typedef ip_neighbor

Initial value:

{
  vl_api_interface_index_t sw_if_index

IP neighbor.

Template Parameters

sw_if_index	- interface used to reach neighbor
flags	- flags for the neighbor
mac_address	- l2 address of the neighbor
ip_address	- ip4 or ip6 address of the neighbor

Definition at line 48 of file ip_neighbor.api.

mac_address

vl_api_mac_address_t mac_address

Definition at line 51 of file ip_neighbor.api.

service

service

Initial value:

{
  rpc want_ip_neighbor_events returns want_ip_neighbor_events_reply
    events ip_neighbor_event

Definition at line 215 of file ip_neighbor.api.

version

option version = "1.0.0"

Definition at line 23 of file ip_neighbor.api.