src/vnet/l2/l2.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2016 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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 option version = "3.1.0";
  18
  19 import "vnet/ip/ip_types.api";
  20 import "vnet/ethernet/ethernet_types.api";
  21 import "vnet/interface_types.api";
  22
  23 /** \brief Reply to l2_xconnect_dump
  24     @param context - sender context which was passed in the request
  25     @param rx_sw_if_index - Receive interface index
  26     @param tx_sw_if_index - Transmit interface index
  27  */
  28 define l2_xconnect_details
  29 {
  30   u32 context;
  31   vl_api_interface_index_t rx_sw_if_index;
  32   vl_api_interface_index_t tx_sw_if_index;
  33 };
  34
  35 /** \brief Dump L2 XConnects
  36     @param client_index - opaque cookie to identify the sender
  37     @param context - sender context, to match reply w/ request
  38 */
  39 define l2_xconnect_dump
  40 {
  41   u32 client_index;
  42   u32 context;
  43 };
  44
  45 /** \brief l2 fib table details structure
  46     @param bd_id - the l2 fib / bridge domain table id
  47     @param mac - the entry's mac address
  48     @param sw_if_index - index of the interface
  49     @param static_mac - the entry is statically configured.
  50     @param filter_mac - the entry is a mac filter entry.
  51     @param bvi_mac - the mac address is a bridge virtual interface
  52 */
  53 define l2_fib_table_details
  54 {
  55   u32 context;
  56   u32 bd_id;
  57   vl_api_mac_address_t mac;
  58   vl_api_interface_index_t sw_if_index;
  59   bool static_mac;
  60   bool filter_mac;
  61   bool bvi_mac;
  62 };
  63
  64 /** \brief Dump l2 fib (aka bridge domain) table
  65     @param client_index - opaque cookie to identify the sender
  66     @param bd_id - the l2 fib / bridge domain table identifier
  67 */
  68 define l2_fib_table_dump
  69 {
  70   u32 client_index;
  71   u32 context;
  72   u32 bd_id;
  73 };
  74
  75 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
  76     @param client_index - opaque cookie to identify the sender
  77     @param context - sender context, to match reply w/ request
  78 */
  79 autoreply define l2_fib_clear_table
  80 {
  81   u32 client_index;
  82   u32 context;
  83 };
  84
  85 /** \brief L2 FIB flush all  entries
  86     @param client_index - opaque cookie to identify the sender
  87     @param context - sender context, to match reply w/ request
  88 */
  89 autoreply define l2fib_flush_all
  90 {
  91   u32 client_index;
  92   u32 context;
  93 };
  94
  95 /** \brief L2 FIB flush bridge domain entries
  96     @param client_index - opaque cookie to identify the sender
  97     @param context - sender context, to match reply w/ request
  98     @param bd_id - the entry's bridge domain id
  99 */
 100 autoreply define l2fib_flush_bd
 101 {
 102   u32 client_index;
 103   u32 context;
 104   u32 bd_id;
 105 };
 106
 107 /** \brief L2 FIB flush interface entries
 108     @param client_index - opaque cookie to identify the sender
 109     @param context - sender context, to match reply w/ request
 110     @param bd_id - the entry's bridge domain id
 111 */
 112 autoreply define l2fib_flush_int
 113 {
 114   u32 client_index;
 115   u32 context;
 116   vl_api_interface_index_t sw_if_index;
 117 };
 118
 119 /** \brief L2 FIB add entry request
 120     @param client_index - opaque cookie to identify the sender
 121     @param context - sender context, to match reply w/ request
 122     @param mac - the entry's mac address
 123     @param bd_id - the entry's bridge domain id
 124     @param sw_if_index - the interface
 125     @param is_add - If non zero add the entry, else delete it
 126     @param static_mac -
 127     @param filter_mac -
 128     @param bvi_mac -
 129 */
 130 autoreply define l2fib_add_del
 131 {
 132   u32 client_index;
 133   u32 context;
 134   vl_api_mac_address_t mac;
 135   u32 bd_id;
 136   vl_api_interface_index_t sw_if_index;
 137   bool is_add [default=true];
 138   bool static_mac;
 139   bool filter_mac;
 140   bool bvi_mac;
 141 };
 142
 143 /** \brief Register to receive L2 MAC events for learned and aged MAC
 144     @param client_index - opaque cookie to identify the sender
 145     @param context - sender context, to match reply w/ request
 146     @param learn_limit - MAC learn limit
 147     @param scan_delay - event scan delay in 10 msec unit
 148     @param max_macs_in_event - in units of 10 mac entries
 149     @param enable_disable - 1 => register for MAC events, 0 => cancel registration
 150     @param pid - sender's pid
 151 */
 152 autoreply define want_l2_macs_events
 153 {
 154   option deprecated;
 155   u32 client_index;
 156   u32 context;
 157   u32 learn_limit [default=1000];
 158   u8  scan_delay [default=10];
 159   u8  max_macs_in_event [default=10];
 160   bool enable_disable [default=true];
 161   u32 pid;
 162 };
 163
 164 /** \brief Register to receive L2 MAC events for learned and aged MAC
 165     @param client_index - opaque cookie to identify the sender
 166     @param context - sender context, to match reply w/ request
 167     @param max_macs_in_event - in units of 10 mac entries
 168     @param enable_disable - 1 => register for MAC events, 0 => cancel registration
 169     @param pid - sender's pid
 170 */
 171 autoreply define want_l2_macs_events2
 172 {
 173   u32 client_index;
 174   u32 context;
 175   u8  max_macs_in_event [default=10];
 176   bool enable_disable [default=true];
 177   u32 pid;
 178 };
 179
 180 /** \brief set l2 table scan delay
 181     @param client_index - opaque cookie to identify the sender
 182     @param context - sender context, to match reply w/ request
 183     @param scan_delay - event scan delay in 10 msec unit
 184 */
 185 autoreply define l2fib_set_scan_delay
 186 {
 187   u32 client_index;
 188   u32 context;
 189   u16 scan_delay [default=10];
 190 };
 191
 192
 193 enum mac_event_action
 194 {
 195         MAC_EVENT_ACTION_API_ADD = 0,
 196         MAC_EVENT_ACTION_API_DELETE = 1,
 197         MAC_EVENT_ACTION_API_MOVE = 2,
 198 };
 199
 200 /** \brief Entry for learned or aged MAC in L2 MAC Events
 201     @param sw_if_index - sw_if_index in the domain
 202     @param mac_addr - mac_address
 203     @param action - 0 => newly learned MAC, 1 => MAC deleted by ager
 204                     2 => MAC move (sw_if_index changed)
 205     @param flags - flag bits to provide other info, not yet used
 206 */
 207 typedef mac_entry
 208 {
 209   vl_api_interface_index_t sw_if_index;
 210   vl_api_mac_address_t mac_addr;
 211   vl_api_mac_event_action_t action;
 212   u8 flags;
 213 };
 214
 215 /** \brief L2 MAC event for a list of learned or aged MACs
 216     @param client_index - opaque cookie to identify the sender
 217     @param pid - client pid registered to receive notification
 218     @param n_macs - number of learned/aged MAC entries
 219     @param mac - array of learned/aged MAC entries
 220 */
 221 define l2_macs_event
 222 {
 223   u32 client_index;
 224   u32 pid;
 225   u32 n_macs;
 226   vl_api_mac_entry_t mac[n_macs];
 227 };
 228
 229 service {
 230   rpc want_l2_macs_events returns want_l2_macs_events_reply
 231     events l2_macs_event;
 232 };
 233
 234 /** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD,
 235     L2_FLOOD, L2_UU_FLOOD, or L2_ARP_TERM bits). This can be used
 236     to disable one or more of the features represented by the
 237     flag bits on an interface to override what is set as default
 238     for all interfaces in the bridge domain
 239     @param client_index - opaque cookie to identify the sender
 240     @param context - sender context, to match reply w/ request
 241     @param sw_if_index - interface
 242     @param is_set - if non-zero, set the bits, else clear them
 243     @param feature_bitmap - non-zero bits (as above) to set or clear
 244 */
 245 define l2_flags
 246 {
 247   u32 client_index;
 248   u32 context;
 249   vl_api_interface_index_t sw_if_index;
 250   bool is_set;
 251   u32 feature_bitmap;
 252 };
 253
 254 /** \brief Set interface L2 flags response
 255     @param context - sender context, to match reply w/ request
 256     @param retval - return code for the set l2 bits request
 257     @param resulting_feature_bitmap - the internal l2 feature bitmap after the request is implemented
 258 */
 259 define l2_flags_reply
 260 {
 261   u32 context;
 262   i32 retval;
 263   u32 resulting_feature_bitmap;
 264 };
 265
 266 /** \brief L2 bridge domain set mac age
 267     @param client_index - opaque cookie to identify the sender
 268     @param context - sender context, to match reply w/ request
 269     @param bd_id - the bridge domain to create
 270     @param mac_age - mac aging time in min, 0 for disabled
 271 */
 272 autoreply define bridge_domain_set_mac_age
 273 {
 274   u32 client_index;
 275   u32 context;
 276   u32 bd_id;
 277   u8 mac_age;
 278 };
 279
 280 /** \brief L2 bridge domain set default learn limit
 281     @param client_index - opaque cookie to identify the sender
 282     @param context - sender context, to match reply w/ request
 283     @param learn limit - maximum number of entries by default for bridge domains
 284 */
 285 autoreply define bridge_domain_set_default_learn_limit
 286 {
 287   u32 client_index;
 288   u32 context;
 289   u32 learn_limit;
 290 };
 291
 292
 293 /** \brief L2 bridge domain set learn limit
 294     @param client_index - opaque cookie to identify the sender
 295     @param context - sender context, to match reply w/ request
 296     @param bd_id - the bridge domain idenntifier
 297     @param learn limit - maximum number of entries for this bd
 298 */
 299 autoreply define bridge_domain_set_learn_limit
 300 {
 301   u32 client_index;
 302   u32 context;
 303   u32 bd_id;
 304   u32 learn_limit;
 305 };
 306
 307 /** \brief L2 bridge domain add or delete request
 308     @param client_index - opaque cookie to identify the sender
 309     @param context - sender context, to match reply w/ request
 310     @param bd_id - the bridge domain to create
 311     @param flood - enable/disable bcast/mcast flooding in the bd
 312     @param uu_flood - enable/disable unknown unicast flood in the bd
 313     @param forward - enable/disable forwarding on all interfaces in the bd
 314     @param learn - enable/disable learning on all interfaces in the bd
 315     @param arp_term - enable/disable arp termination in the bd
 316     @param arp_ufwd - enable/disable arp unicast forwarding in the bd
 317     @param mac_age - mac aging time in min, 0 for disabled
 318     @param is_add - add or delete flag
 319 */
 320 autoreply define bridge_domain_add_del
 321 {
 322   u32 client_index;
 323   u32 context;
 324   u32 bd_id;
 325   bool flood;
 326   bool uu_flood;
 327   bool forward;
 328   bool learn;
 329   bool arp_term;
 330   bool arp_ufwd;
 331   u8 mac_age;
 332   string bd_tag[64];
 333   bool is_add [default=true];
 334 };
 335
 336 /** \brief L2 bridge domain request operational state details
 337     @param client_index - opaque cookie to identify the sender
 338     @param context - sender context, to match reply w/ request
 339     @param bd_id - the bridge domain id desired or ~0 to request all bds
 340     @param sw_if_index - filter by sw_if_index UNIMPLEMENTED
 341 */
 342 define bridge_domain_dump
 343 {
 344   u32 client_index;
 345   u32 context;
 346   u32 bd_id [default=0xffffffff];
 347   vl_api_interface_index_t sw_if_index [default=0xffffffff];
 348 };
 349
 350 /** \brief L2 bridge domain sw interface operational state response
 351     @param bd_id - the bridge domain id
 352     @param sw_if_index - sw_if_index in the domain
 353     @param shg - split horizon group for the interface
 354 */
 355 typedef bridge_domain_sw_if
 356 {
 357   u32 context;
 358   vl_api_interface_index_t sw_if_index;
 359   /* FIXME: set_int_l2_mode() u32/ api u8 */
 360   u8 shg;
 361 };
 362
 363 /** \brief L2 bridge domain operational state response
 364     @param bd_id - the bridge domain id
 365     @param flood - bcast/mcast flooding state on all interfaces in the bd
 366     @param uu_flood - unknown unicast flooding state on all interfaces in the bd
 367     @param forward - forwarding state on all interfaces in the bd
 368     @param learn - learning state on all interfaces in the bd
 369     @param arp_term - arp termination state on all interfaces in the bd
 370     @param arp_ufwd - arp unicast forwarding state on all interfaces in the bd
 371     @param mac_age - mac aging time in min, 0 for disabled
 372     @param bd_tag - optional textual tag for the bridge domain
 373     @param n_sw_ifs - number of sw_if_index's in the domain
 374 */
 375 define bridge_domain_details
 376 {
 377   u32 context;
 378   u32 bd_id;
 379   bool flood;
 380   bool uu_flood;
 381   bool forward;
 382   bool learn;
 383   bool arp_term;
 384   bool arp_ufwd;
 385   u8 mac_age;
 386   string bd_tag[64];
 387   vl_api_interface_index_t bvi_sw_if_index;
 388   vl_api_interface_index_t uu_fwd_sw_if_index;
 389   u32 n_sw_ifs;
 390   vl_api_bridge_domain_sw_if_t sw_if_details[n_sw_ifs];
 391 };
 392
 393 /** \brief Flags that can be changed on a bridge domain */
 394 enum bd_flags
 395 {
 396   BRIDGE_API_FLAG_NONE = 0x0,
 397   BRIDGE_API_FLAG_LEARN = 0x1,
 398   BRIDGE_API_FLAG_FWD = 0x2,
 399   BRIDGE_API_FLAG_FLOOD = 0x4,
 400   BRIDGE_API_FLAG_UU_FLOOD = 0x8,
 401   BRIDGE_API_FLAG_ARP_TERM = 0x10,
 402   BRIDGE_API_FLAG_ARP_UFWD = 0x20,
 403 };
 404
 405 /** \brief Set bridge flags request
 406     @param client_index - opaque cookie to identify the sender
 407     @param context - sender context, to match reply w/ request
 408     @param bd_id - the bridge domain to set the flags for
 409     @param is_set - if non-zero, set the flags, else clear them
 410     @param flags - flags that are non-zero to set or clear
 411 */
 412 define bridge_flags
 413 {
 414   u32 client_index;
 415   u32 context;
 416   u32 bd_id;
 417   bool is_set;
 418   vl_api_bd_flags_t flags;
 419 };
 420
 421 /** \brief Set bridge flags response
 422     @param context - sender context, to match reply w/ request
 423     @param retval - return code for the set bridge flags request
 424     @param resulting_feature_bitmap - the internal L2 feature bitmap after the request is implemented
 425 */
 426 define bridge_flags_reply
 427 {
 428   u32 context;
 429   i32 retval;
 430   u32 resulting_feature_bitmap;
 431 };
 432
 433 /** \brief L2 interface vlan tag rewrite configure request
 434     @param client_index - opaque cookie to identify the sender
 435     @param context - sender context, to match reply w/ request
 436     @param sw_if_index - interface the operation is applied to
 437     @param vtr_op - Choose from l2_vtr_op_t enum values
 438     @param push_dot1q - first pushed flag dot1q id set, else dot1ad
 439     @param tag1 - Needed for any push or translate vtr op
 440     @param tag2 - Needed for any push 2 or translate x-2 vtr ops
 441 */
 442 autoreply define l2_interface_vlan_tag_rewrite
 443 {
 444   u32 client_index;
 445   u32 context;
 446   vl_api_interface_index_t sw_if_index;
 447   u32 vtr_op;
 448   u32 push_dot1q;               // ethertype of first pushed tag is dot1q/dot1ad
 449   u32 tag1;                     // first pushed tag
 450   u32 tag2;                     // second pushed tag
 451 };
 452
 453 /** \brief L2 interface pbb tag rewrite configure request
 454     @param client_index - opaque cookie to identify the sender
 455     @param context - sender context, to match reply w/ request
 456     @param sw_if_index - interface the operation is applied to
 457     @param vtr_op - Choose from l2_vtr_op_t enum values
 458     @param inner_tag - needed for translate_qinq vtr op only
 459     @param outer_tag - needed for translate_qinq vtr op only
 460     @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
 461     @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
 462     @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
 463     @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
 464 */
 465 autoreply define l2_interface_pbb_tag_rewrite
 466 {
 467   u32 client_index;
 468   u32 context;
 469   vl_api_interface_index_t sw_if_index;
 470   u32 vtr_op;
 471   u16 outer_tag;
 472   vl_api_mac_address_t b_dmac;
 473   vl_api_mac_address_t b_smac;
 474   u16 b_vlanid;
 475   u32 i_sid;
 476 };
 477
 478 /** \brief L2 interface patch add / del request
 479     @param client_index - opaque cookie to identify the sender
 480     @param context - sender context, to match reply w/ request
 481     @param rx_sw_if_index - receive side interface
 482     @param tx_sw_if_index - transmit side interface
 483     @param is_add - if non-zero set up the interface patch, else remove it
 484 */
 485 autoreply define l2_patch_add_del
 486 {
 487   u32 client_index;
 488   u32 context;
 489   vl_api_interface_index_t rx_sw_if_index;
 490   vl_api_interface_index_t tx_sw_if_index;
 491   bool is_add [default=true];
 492 };
 493
 494 /** \brief Set L2 XConnect between two interfaces request
 495     @param client_index - opaque cookie to identify the sender
 496     @param context - sender context, to match reply w/ request
 497     @param rx_sw_if_index - Receive interface index
 498     @param tx_sw_if_index - Transmit interface index
 499     @param enable - enable xconnect if not 0, else set to L3 mode
 500 */
 501 autoreply define sw_interface_set_l2_xconnect
 502 {
 503   u32 client_index;
 504   u32 context;
 505   vl_api_interface_index_t rx_sw_if_index;
 506   vl_api_interface_index_t tx_sw_if_index;
 507   bool enable [default=true];
 508 };
 509
 510 /**
 511  * @brief An enumeration of the type of ports that can be added
 512  *        to a bridge domain
 513  */
 514 enum l2_port_type
 515 {
 516   /* a 'normal' interface, i.e. not BVI or UU-Flood */
 517   L2_API_PORT_TYPE_NORMAL = 0,
 518   /* a BVI interface in the BD */
 519   L2_API_PORT_TYPE_BVI = 1,
 520   /* The interface on which to forward unknown unicast packets
 521    * If this is not set for a BD then UU is flooded */
 522   L2_API_PORT_TYPE_UU_FWD = 2,
 523 };
 524
 525 /** \brief Interface bridge mode request
 526     @param client_index - opaque cookie to identify the sender
 527     @param context - sender context, to match reply w/ request
 528     @param rx_sw_if_index - the interface
 529     @param bd_id - bridge domain id
 530     @param port_type - port_mode, see #l2_port_type
 531     @param shg - Split horizon group, for bridge mode only
 532     @param enable - Enable beige mode if not 0, else set to L3 mode
 533 */
 534
 535 autoreply define sw_interface_set_l2_bridge
 536 {
 537   u32 client_index;
 538   u32 context;
 539   vl_api_interface_index_t rx_sw_if_index;
 540   u32 bd_id;
 541   vl_api_l2_port_type_t port_type;
 542   u8 shg;
 543   bool enable [default=true];
 544 };
 545
 546 /** \brief Set bridge domain ip to mac entry request
 547     @param client_index - opaque cookie to identify the sender
 548     @param context - sender context, to match reply w/ request
 549     @param bd_id - the bridge domain to set the flags for
 550     @param is_add - if non-zero, add the entry, else clear it
 551     @param ip - ipv4 or ipv6 address
 552     @param mac - MAC address
 553 */
 554
 555 typedef bd_ip_mac
 556 {
 557   u32 bd_id;
 558   vl_api_address_t ip;
 559   vl_api_mac_address_t mac;
 560 };
 561
 562 autoreply define bd_ip_mac_add_del
 563 {
 564   u32 client_index;
 565   u32 context;
 566   bool is_add [default=true];
 567   vl_api_bd_ip_mac_t entry;
 568 };
 569
 570 /** \brief Flush bridge domain IP to MAC entries
 571     @param client_index - opaque cookie to identify the sender
 572     @param bd_id - bridge domain identifier
 573 */
 574 autoreply define bd_ip_mac_flush
 575 {
 576   u32 client_index;
 577   u32 context;
 578   u32 bd_id;
 579 };
 580
 581 /** \brief bridge domain IP to MAC entry details structure
 582     @param bd_id - bridge domain table id
 583     @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
 584     @param ip_address - ipv4 or ipv6 address
 585     @param mac_address - MAC address
 586 */
 587 define bd_ip_mac_details
 588 {
 589   u32 context;
 590   vl_api_bd_ip_mac_t entry;
 591 };
 592
 593 /** \brief Dump bridge domain IP to MAC entries
 594     @param client_index - opaque cookie to identify the sender
 595     @param bd_id - bridge domain identifier
 596 */
 597 define bd_ip_mac_dump
 598 {
 599   u32 client_index;
 600   u32 context;
 601   u32 bd_id;
 602 };
 603
 604 /** \brief L2 interface ethernet flow point filtering enable/disable request
 605     @param client_index - opaque cookie to identify the sender
 606     @param context - sender context, to match reply w/ request
 607     @param sw_if_index - interface to enable/disable filtering on
 608     @param enable_disable - if non-zero enable filtering, else disable
 609 */
 610 autoreply define l2_interface_efp_filter
 611 {
 612   u32 client_index;
 613   u32 context;
 614   vl_api_interface_index_t sw_if_index;
 615   bool enable_disable [default=true];
 616 };
 617
 618 /** \brief Interface set vpath request
 619     @param client_index - opaque cookie to identify the sender
 620     @param context - sender context, to match reply w/ request
 621     @param sw_if_index - interface used to reach neighbor
 622     @param enable - if non-zero enable, else disable
 623 */
 624 autoreply define sw_interface_set_vpath
 625 {
 626   u32 client_index;
 627   u32 context;
 628   vl_api_interface_index_t sw_if_index;
 629   bool enable [default=0xffffffff];
 630 };
 631
 632 /** \brief Create BVI interface instance request
 633     @param client_index - opaque cookie to identify the sender
 634     @param context - sender context, to match reply w/ request
 635     @param mac_address - mac addr to assign to the interface if none-zero
 636     @param user_instance - requested instance, ~0 => dynamically allocate
 637 */
 638 define bvi_create
 639 {
 640   u32 client_index;
 641   u32 context;
 642   vl_api_mac_address_t mac;
 643   u32 user_instance [default=0xffffffff];
 644 };
 645
 646 /** \brief Create BVI interface instance response
 647     @param context - sender context, to match reply w/ request
 648     @param sw_if_index - sw index of the interface that was created
 649     @param retval - return code for the request
 650 */
 651 define bvi_create_reply
 652 {
 653   u32 context;
 654   i32 retval;
 655   vl_api_interface_index_t sw_if_index;
 656 };
 657
 658 /** \brief Delete BVI interface request
 659     @param client_index - opaque cookie to identify the sender
 660     @param context - sender context, to match reply w/ request
 661     @param sw_if_index - sw index of the interface that was created
 662 */
 663 autoreply define bvi_delete
 664 {
 665   u32 client_index;
 666   u32 context;
 667   vl_api_interface_index_t sw_if_index;
 668 };
 669
 670 /** \brief Register for IP4 ARP resolution event on receiving ARP reply or
 671            MAC/IP info from ARP requests in L2 BDs
 672     @param client_index - opaque cookie to identify the sender
 673     @param context - sender context, to match reply w/ request
 674     @param enable - 1 => register for events, 0 => cancel registration
 675     @param pid - sender's pid
 676 */
 677 autoreply define want_l2_arp_term_events
 678 {
 679   u32 client_index;
 680   u32 context;
 681   bool enable;
 682   u32 pid;
 683 };
 684
 685 /** \brief Tell client about an IP4 ARP resolution event or
 686            MAC/IP info from ARP requests in L2 BDs
 687     @param client_index - opaque cookie to identify the sender
 688     @param pid - client pid registered to receive notification
 689     @param ip - IP address of new ARP term entry
 690     @param sw_if_index - interface of new ARP term entry
 691     @param mac - MAC address of new ARP term entry
 692 */
 693 define l2_arp_term_event
 694 {
 695   u32 client_index;
 696   u32 pid;
 697   vl_api_address_t ip;
 698   vl_api_interface_index_t sw_if_index;
 699   vl_api_mac_address_t mac;
 700 };
 701
 702 service {
 703   rpc want_l2_arp_term_events returns want_l2_arp_term_events_reply
 704     events l2_arp_term_event;
 705 };
 706
 707 /*
 708  * Local Variables:
 709  * eval: (c-set-style "gnu")
 710  * End:
 711  */