1 /* Hey Emacs use -*- mode: C -*- */
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:
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.
17 option version = "2.2.2";
19 import "vnet/ip/ip_types.api";
20 import "vnet/ethernet/ethernet_types.api";
21 import "vnet/interface_types.api";
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
28 define l2_xconnect_details
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
39 define l2_xconnect_dump
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
53 define l2_fib_table_details
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
68 define l2_fib_table_dump
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
79 autoreply define l2_fib_clear_table
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
89 autoreply define l2fib_flush_all
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
100 autoreply define l2fib_flush_bd
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
112 autoreply define l2fib_flush_int
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
129 autoreply define l2fib_add_del
142 /** \brief Register to receive L2 MAC events for learned and aged MAC
143 @param client_index - opaque cookie to identify the sender
144 @param context - sender context, to match reply w/ request
145 @param learn_limit - MAC learn limit, 0 => default to 1000
146 @param scan_delay - event scan delay in 10 msec unit, 0 => default to 100 msec
147 @param max_macs_in_event - in units of 10 mac entries, 0 => default to 100 entries
148 @param enable_disable - 1 => register for MAC events, 0 => cancel registration
149 @param pid - sender's pid
151 autoreply define want_l2_macs_events
157 u8 max_macs_in_event;
162 /** \brief Entry for learned or aged MAC in L2 MAC Events
163 @param sw_if_index - sw_if_index in the domain
164 @param mac_addr - mac_address
165 @param action - 0 => newly learned MAC, 1 => MAC deleted by ager
166 3 => MAC move (sw_if_index changed)
167 @param flags - flag bits to provide other info, not yet used
177 /** \brief L2 MAC event for a list of learned or aged MACs
178 @param client_index - opaque cookie to identify the sender
179 @param pid - client pid registered to receive notification
180 @param n_macs - number of learned/aged MAC entries
181 @param mac - array of learned/aged MAC entries
188 vl_api_mac_entry_t mac[n_macs];
192 rpc want_l2_macs_events returns want_l2_macs_events_reply
193 events l2_macs_event;
196 /** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD,
197 L2_FLOOD, L2_UU_FLOOD, or L2_ARP_TERM bits). This can be used
198 to disable one or more of the features represented by the
199 flag bits on an interface to override what is set as default
200 for all interfaces in the bridge domain
201 @param client_index - opaque cookie to identify the sender
202 @param context - sender context, to match reply w/ request
203 @param sw_if_index - interface
204 @param is_set - if non-zero, set the bits, else clear them
205 @param feature_bitmap - non-zero bits (as above) to set or clear
216 /** \brief Set interface L2 flags response
217 @param context - sender context, to match reply w/ request
218 @param retval - return code for the set l2 bits request
219 @param resulting_feature_bitmap - the internal l2 feature bitmap after the request is implemented
221 define l2_flags_reply
225 u32 resulting_feature_bitmap;
228 /** \brief L2 bridge domain set mac age
229 @param client_index - opaque cookie to identify the sender
230 @param context - sender context, to match reply w/ request
231 @param bd_id - the bridge domain to create
232 @param mac_age - mac aging time in min, 0 for disabled
234 autoreply define bridge_domain_set_mac_age
242 /** \brief L2 bridge domain add or delete request
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param bd_id - the bridge domain to create
246 @param flood - enable/disable bcast/mcast flooding in the bd
247 @param uu_flood - enable/disable unknown unicast flood in the bd
248 @param forward - enable/disable forwarding on all interfaces in the bd
249 @param learn - enable/disable learning on all interfaces in the bd
250 @param arp_term - enable/disable arp termination in the bd
251 @param arp_ufwd - enable/disable arp unicast forwarding in the bd
252 @param mac_age - mac aging time in min, 0 for disabled
253 @param is_add - add or delete flag
255 autoreply define bridge_domain_add_del
271 /** \brief L2 bridge domain request operational state details
272 @param client_index - opaque cookie to identify the sender
273 @param context - sender context, to match reply w/ request
274 @param bd_id - the bridge domain id desired or ~0 to request all bds
276 define bridge_domain_dump
283 /** \brief L2 bridge domain sw interface operational state response
284 @param bd_id - the bridge domain id
285 @param sw_if_index - sw_if_index in the domain
286 @param shg - split horizon group for the interface
288 typedef bridge_domain_sw_if
295 /** \brief L2 bridge domain operational state response
296 @param bd_id - the bridge domain id
297 @param flood - bcast/mcast flooding state on all interfaces in the bd
298 @param uu_flood - unknown unicast flooding state on all interfaces in the bd
299 @param forward - forwarding state on all interfaces in the bd
300 @param learn - learning state on all interfaces in the bd
301 @param arp_term - arp termination state on all interfaces in the bd
302 @param arp_ufwd - arp unicast forwarding state on all interfaces in the bd
303 @param mac_age - mac aging time in min, 0 for disabled
304 @param bd_tag - optional textual tag for the bridge domain
305 @param n_sw_ifs - number of sw_if_index's in the domain
307 manual_print manual_endian define bridge_domain_details
320 u32 uu_fwd_sw_if_index;
322 vl_api_bridge_domain_sw_if_t sw_if_details[n_sw_ifs];
325 /** \brief Flags that can be changed on a bridge domain */
328 BRIDGE_API_FLAG_NONE = 0x0,
329 BRIDGE_API_FLAG_LEARN = 0x1,
330 BRIDGE_API_FLAG_FWD = 0x2,
331 BRIDGE_API_FLAG_FLOOD = 0x4,
332 BRIDGE_API_FLAG_UU_FLOOD = 0x8,
333 BRIDGE_API_FLAG_ARP_TERM = 0x10,
334 BRIDGE_API_FLAG_ARP_UFWD = 0x20,
337 /** \brief Set bridge flags request
338 @param client_index - opaque cookie to identify the sender
339 @param context - sender context, to match reply w/ request
340 @param bd_id - the bridge domain to set the flags for
341 @param is_set - if non-zero, set the flags, else clear them
342 @param flags - flags that are non-zero to set or clear
350 vl_api_bd_flags_t flags;
353 /** \brief Set bridge flags response
354 @param context - sender context, to match reply w/ request
355 @param retval - return code for the set bridge flags request
356 @param resulting_feature_bitmap - the internal L2 feature bitmap after the request is implemented
358 define bridge_flags_reply
362 u32 resulting_feature_bitmap;
365 /** \brief L2 interface vlan tag rewrite configure request
366 @param client_index - opaque cookie to identify the sender
367 @param context - sender context, to match reply w/ request
368 @param sw_if_index - interface the operation is applied to
369 @param vtr_op - Choose from l2_vtr_op_t enum values
370 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
371 @param tag1 - Needed for any push or translate vtr op
372 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
374 autoreply define l2_interface_vlan_tag_rewrite
380 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
381 u32 tag1; // first pushed tag
382 u32 tag2; // second pushed tag
385 /** \brief L2 interface pbb tag rewrite configure request
386 @param client_index - opaque cookie to identify the sender
387 @param context - sender context, to match reply w/ request
388 @param sw_if_index - interface the operation is applied to
389 @param vtr_op - Choose from l2_vtr_op_t enum values
390 @param inner_tag - needed for translate_qinq vtr op only
391 @param outer_tag - needed for translate_qinq vtr op only
392 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
393 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
394 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
395 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
397 autoreply define l2_interface_pbb_tag_rewrite
410 /** \brief L2 interface patch add / del request
411 @param client_index - opaque cookie to identify the sender
412 @param context - sender context, to match reply w/ request
413 @param rx_sw_if_index - receive side interface
414 @param tx_sw_if_index - transmit side interface
415 @param is_add - if non-zero set up the interface patch, else remove it
417 autoreply define l2_patch_add_del
426 /** \brief Set L2 XConnect between two interfaces request
427 @param client_index - opaque cookie to identify the sender
428 @param context - sender context, to match reply w/ request
429 @param rx_sw_if_index - Receive interface index
430 @param tx_sw_if_index - Transmit interface index
431 @param enable - enable xconnect if not 0, else set to L3 mode
433 autoreply define sw_interface_set_l2_xconnect
443 * @brief An enumeration of the type of ports that can be added
448 /* a 'normal' interface, i.e. not BVI or UU-Flood */
449 L2_API_PORT_TYPE_NORMAL = 0,
450 /* a BVI interface in the BD */
451 L2_API_PORT_TYPE_BVI = 1,
452 /* The interface on which to forward unknown unicast packets
453 * If this is not set for a BD then UU is flooded */
454 L2_API_PORT_TYPE_UU_FWD = 2,
457 /** \brief Interface bridge mode request
458 @param client_index - opaque cookie to identify the sender
459 @param context - sender context, to match reply w/ request
460 @param rx_sw_if_index - the interface
461 @param bd_id - bridge domain id
462 @param port_type - port_mode, see #l2_port_type
463 @param shg - Split horizon group, for bridge mode only
464 @param enable - Enable beige mode if not 0, else set to L3 mode
467 autoreply define sw_interface_set_l2_bridge
473 vl_api_l2_port_type_t port_type;
478 /** \brief Set bridge domain ip to mac entry request
479 @param client_index - opaque cookie to identify the sender
480 @param context - sender context, to match reply w/ request
481 @param bd_id - the bridge domain to set the flags for
482 @param is_add - if non-zero, add the entry, else clear it
483 @param ip - ipv4 or ipv6 address
484 @param mac - MAC address
491 vl_api_mac_address_t mac;
494 autoreply define bd_ip_mac_add_del
499 vl_api_bd_ip_mac_t entry;
502 /** \brief Flush bridge domain IP to MAC entries
503 @param client_index - opaque cookie to identify the sender
504 @param bd_id - bridge domain identifier
506 autoreply define bd_ip_mac_flush
513 /** \brief bridge domain IP to MAC entry details structure
514 @param bd_id - bridge domain table id
515 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
516 @param ip_address - ipv4 or ipv6 address
517 @param mac_address - MAC address
519 define bd_ip_mac_details
522 vl_api_bd_ip_mac_t entry;
525 /** \brief Dump bridge domain IP to MAC entries
526 @param client_index - opaque cookie to identify the sender
527 @param bd_id - bridge domain identifier
529 define bd_ip_mac_dump
536 /** \brief L2 interface ethernet flow point filtering enable/disable request
537 @param client_index - opaque cookie to identify the sender
538 @param context - sender context, to match reply w/ request
539 @param sw_if_index - interface to enable/disable filtering on
540 @param enable_disable - if non-zero enable filtering, else disable
542 autoreply define l2_interface_efp_filter
550 /** \brief Interface set vpath request
551 @param client_index - opaque cookie to identify the sender
552 @param context - sender context, to match reply w/ request
553 @param sw_if_index - interface used to reach neighbor
554 @param enable - if non-zero enable, else disable
556 autoreply define sw_interface_set_vpath
564 /** \brief Create BVI interface instance request
565 @param client_index - opaque cookie to identify the sender
566 @param context - sender context, to match reply w/ request
567 @param mac_address - mac addr to assign to the interface if none-zero
568 @param user_instance - requested instance, ~0 => dynamically allocate
574 vl_api_mac_address_t mac;
578 /** \brief Create BVI interface instance response
579 @param context - sender context, to match reply w/ request
580 @param sw_if_index - sw index of the interface that was created
581 @param retval - return code for the request
583 define bvi_create_reply
590 /** \brief Delete BVI interface request
591 @param client_index - opaque cookie to identify the sender
592 @param context - sender context, to match reply w/ request
593 @param sw_if_index - sw index of the interface that was created
595 autoreply define bvi_delete
602 /** \brief Register for IP4 ARP resolution event on receing ARP reply or
603 MAC/IP info from ARP requests in L2 BDs
604 @param client_index - opaque cookie to identify the sender
605 @param context - sender context, to match reply w/ request
606 @param enable - 1 => register for events, 0 => cancel registration
607 @param pid - sender's pid
609 autoreply define want_l2_arp_term_events
617 /** \brief Tell client about an IP4 ARP resolution event or
618 MAC/IP info from ARP requests in L2 BDs
619 @param client_index - opaque cookie to identify the sender
620 @param pid - client pid registered to receive notification
621 @param ip - IP address of new ARP term entry
622 @param sw_if_index - interface of new ARP term entry
623 @param mac - MAC address of new ARP term entry
625 define l2_arp_term_event
630 vl_api_interface_index_t sw_if_index;
631 vl_api_mac_address_t mac;
635 rpc want_l2_arp_term_events returns want_l2_arp_term_events_reply
636 events l2_arp_term_event;
641 * eval: (c-set-style "gnu")