1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2019 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.
18 This file defines the vpp control-plane API messages
19 used to control the ABF plugin
22 option version = "1.0.0";
24 import "vnet/ip/ip_types.api";
25 import "vnet/ethernet/ethernet_types.api";
26 import "vnet/interface_types.api";
28 /** \brief Proxy ARP configuration type
29 @param table_id - VRF / Fib table ID
30 @param low - Low address of the Proxy ARP range
31 @param hi - High address of the Proxy ARP range
36 vl_api_ip4_address_t low;
37 vl_api_ip4_address_t hi;
40 /** \brief Proxy ARP add / del request
41 @param client_index - opaque cookie to identify the sender
42 @param context - sender context, to match reply w/ request
43 @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
44 @param proxy - Proxy configuration
46 autoreply define proxy_arp_add_del
51 vl_api_proxy_arp_t proxy;
54 /** \brief Proxy ARP dump request
62 /** \brief Proxy ARP dump details reply
63 * @param proxy - Same data as used to configure
65 define proxy_arp_details
68 vl_api_proxy_arp_t proxy;
71 /** \brief Proxy ARP add / del interface request
72 @param client_index - opaque cookie to identify the sender
73 @param context - sender context, to match reply w/ request
74 @param sw_if_index - Which interface to enable / disable Proxy Arp on
75 @param enable - 1 to enable Proxy ARP on interface, 0 to disable
77 autoreply define proxy_arp_intfc_enable_disable
81 vl_api_interface_index_t sw_if_index;
85 /** \brief Proxy ARP interface dump request
87 define proxy_arp_intfc_dump
93 /** \brief Proxy ARP interface dump details reply
94 * @param sw_if_index The interface on which ARP proxy is enabled.
96 define proxy_arp_intfc_details
107 description "ARP replies sent";
113 description "ARP Disabled";
115 l2_type_not_ethernet {
119 description "L2 type not ethernet";
125 description "L3 type not IP4";
127 l3_src_address_not_local {
131 description "IP4 source address not local to subnet";
133 l3_dst_address_not_local {
137 description "IP4 destination address not local to subnet";
139 l3_dst_address_unset {
143 description "IP4 destination address is unset";
145 l3_src_address_is_local {
149 description "IP4 source address matches local interface";
151 l3_src_address_learned {
155 description "ARP request IP4 source address learned";
161 description "ARP replies received";
167 description "ARP opcode not request";
169 proxy_arp_replies_sent {
173 description "Proxy ARP replies sent";
175 l2_address_mismatch {
179 description "ARP hw addr does not match L2 frame src addr";
185 description "ARP probe or announcement dropped";
191 description "Interface is not mapped to an IP table";
193 interface_not_ip_enabled {
197 description "Interface is not IP enabled";
199 unnumbered_mismatch {
203 description "RX interface is unnumbered to different subnet";
208 "/err/arp-reply" "arp";
209 "/err/arp-disabled" "arp";
210 "/err/arp-input" "arp";
211 "/err/arp-proxy" "arp";
216 * eval: (c-set-style "gnu")