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.0.0";
19 /** \brief Reply to l2_xconnect_dump
20 @param context - sender context which was passed in the request
21 @param rx_sw_if_index - Receive interface index
22 @param tx_sw_if_index - Transmit interface index
24 define l2_xconnect_details
31 /** \brief Dump L2 XConnects
32 @param client_index - opaque cookie to identify the sender
33 @param context - sender context, to match reply w/ request
35 define l2_xconnect_dump
41 /** \brief l2 fib table details structure
42 @param bd_id - the l2 fib / bridge domain table id
43 @param mac - the entry's mac address
44 @param sw_if_index - index of the interface
45 @param static_mac - the entry is statically configured.
46 @param filter_mac - the entry is a mac filter entry.
47 @param bvi_mac - the mac address is a bridge virtual interface
49 define l2_fib_table_details
60 /** \brief Dump l2 fib (aka bridge domain) table
61 @param client_index - opaque cookie to identify the sender
62 @param bd_id - the l2 fib / bridge domain table identifier
64 define l2_fib_table_dump
71 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
72 @param client_index - opaque cookie to identify the sender
73 @param context - sender context, to match reply w/ request
75 autoreply define l2_fib_clear_table
81 /** \brief L2 FIB flush all entries
82 @param client_index - opaque cookie to identify the sender
83 @param context - sender context, to match reply w/ request
85 autoreply define l2fib_flush_all
91 /** \brief L2 FIB flush bridge domain entries
92 @param client_index - opaque cookie to identify the sender
93 @param context - sender context, to match reply w/ request
94 @param bd_id - the entry's bridge domain id
96 autoreply define l2fib_flush_bd
103 /** \brief L2 FIB flush interface entries
104 @param client_index - opaque cookie to identify the sender
105 @param context - sender context, to match reply w/ request
106 @param bd_id - the entry's bridge domain id
108 autoreply define l2fib_flush_int
115 /** \brief L2 FIB add entry request
116 @param client_index - opaque cookie to identify the sender
117 @param context - sender context, to match reply w/ request
118 @param mac - the entry's mac address
119 @param bd_id - the entry's bridge domain id
120 @param sw_if_index - the interface
121 @param is_add - If non zero add the entry, else delete it
125 autoreply define l2fib_add_del
138 /** \brief Register to recive L2 MAC events for leanred and aged MAC
139 @param client_index - opaque cookie to identify the sender
140 @param context - sender context, to match reply w/ request
141 @param learn_limit - MAC learn limit, 0 => default to 1000
142 @param scan_delay - event scan delay in 10 msec unit, 0 => default to 100 msec
143 @param max_macs_in_event - in units of 10 mac entries, 0 => default to 100 entries
144 @param enable_disable - 1 => register for MAC events, 0 => cancel registration
145 @param pid - sender's pid
147 autoreply define want_l2_macs_events
153 u8 max_macs_in_event;
158 /** \brief Entry for learned or aged MAC in L2 MAC Events
159 @param sw_if_index - sw_if_index in the domain
160 @param mac_addr - mac_address
161 @is_del - 0 => newly learned MAC, 1 => aged out MAC
163 typeonly define mac_entry
171 /** \brief L2 MAC event for a list of learned or aged MACs
172 @param client_index - opaque cookie to identify the sender
173 @param pid - client pid registered to receive notification
174 @param n_macs - number of learned/aged MAC enntries
175 @param mac - array of learned/aged MAC entries
182 vl_api_mac_entry_t mac[n_macs];
185 /** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD,
186 L2_FLOOD, L2_UU_FLOOD, or L2_ARP_TERM bits). This can be used
187 to disable one or more of the features represented by the
188 flag bits on an interface to override what is set as default
189 for all interfaces in the bridge domain
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
192 @param sw_if_index - interface
193 @param is_set - if non-zero, set the bits, else clear them
194 @param feature_bitmap - non-zero bits (as above) to set or clear
205 /** \brief Set interface L2 flags response
206 @param context - sender context, to match reply w/ request
207 @param retval - return code for the set l2 bits request
208 @param resulting_feature_bitmap - the internal l2 feature bitmap after the request is implemented
210 define l2_flags_reply
214 u32 resulting_feature_bitmap;
217 /** \brief L2 bridge domain set mac age
218 @param client_index - opaque cookie to identify the sender
219 @param context - sender context, to match reply w/ request
220 @param bd_id - the bridge domain to create
221 @param mac_age - mac aging time in min, 0 for disabled
223 autoreply define bridge_domain_set_mac_age
231 /** \brief L2 bridge domain add or delete request
232 @param client_index - opaque cookie to identify the sender
233 @param context - sender context, to match reply w/ request
234 @param bd_id - the bridge domain to create
235 @param flood - enable/disable bcast/mcast flooding in the bd
236 @param uu_flood - enable/disable uknown unicast flood in the bd
237 @param forward - enable/disable forwarding on all interfaces in the bd
238 @param learn - enable/disable learning on all interfaces in the bd
239 @param arp_term - enable/disable arp termination in the bd
240 @param mac_age - mac aging time in min, 0 for disabled
241 @param is_add - add or delete flag
243 autoreply define bridge_domain_add_del
258 /** \brief L2 bridge domain request operational state details
259 @param client_index - opaque cookie to identify the sender
260 @param context - sender context, to match reply w/ request
261 @param bd_id - the bridge domain id desired or ~0 to request all bds
263 define bridge_domain_dump
270 /** \brief L2 bridge domain sw interface operational state response
271 @param bd_id - the bridge domain id
272 @param sw_if_index - sw_if_index in the domain
273 @param shg - split horizon group for the interface
275 typeonly manual_print manual_endian define bridge_domain_sw_if
282 /** \brief L2 bridge domain operational state response
283 @param bd_id - the bridge domain id
284 @param flood - bcast/mcast flooding state on all interfaces in the bd
285 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
286 @param forward - forwarding state on all interfaces in the bd
287 @param learn - learning state on all interfaces in the bd
288 @param arp_term - arp termination state on all interfaces in the bd
289 @param mac_age - mac aging time in min, 0 for disabled
290 @param bd_tag - optional textual tag for the bridge domain
291 @param n_sw_ifs - number of sw_if_index's in the domain
293 manual_print manual_endian define bridge_domain_details
306 vl_api_bridge_domain_sw_if_t sw_if_details[n_sw_ifs];
309 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
310 L2_UU_FLOOD, or L2_ARP_TERM bits) request
311 @param client_index - opaque cookie to identify the sender
312 @param context - sender context, to match reply w/ request
313 @param bd_id - the bridge domain to set the flags for
314 @param is_set - if non-zero, set the flags, else clear them
315 @param feature_bitmap - bits (as above) that are non-zero to set or clear
326 /** \brief Set bridge flags response
327 @param context - sender context, to match reply w/ request
328 @param retval - return code for the set bridge flags request
329 @param resulting_feature_bitmap - the internal L2 feature bitmap after the request is implemented
331 define bridge_flags_reply
335 u32 resulting_feature_bitmap;
338 /** \brief L2 interface vlan tag rewrite configure request
339 @param client_index - opaque cookie to identify the sender
340 @param context - sender context, to match reply w/ request
341 @param sw_if_index - interface the operation is applied to
342 @param vtr_op - Choose from l2_vtr_op_t enum values
343 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
344 @param tag1 - Needed for any push or translate vtr op
345 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
347 autoreply define l2_interface_vlan_tag_rewrite
353 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
354 u32 tag1; // first pushed tag
355 u32 tag2; // second pushed tag
358 /** \brief L2 interface pbb tag rewrite configure request
359 @param client_index - opaque cookie to identify the sender
360 @param context - sender context, to match reply w/ request
361 @param sw_if_index - interface the operation is applied to
362 @param vtr_op - Choose from l2_vtr_op_t enum values
363 @param inner_tag - needed for translate_qinq vtr op only
364 @param outer_tag - needed for translate_qinq vtr op only
365 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
366 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
367 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
368 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
370 autoreply define l2_interface_pbb_tag_rewrite
383 /** \brief L2 interface patch add / del request
384 @param client_index - opaque cookie to identify the sender
385 @param context - sender context, to match reply w/ request
386 @param rx_sw_if_index - receive side interface
387 @param tx_sw_if_index - transmit side interface
388 @param is_add - if non-zero set up the interface patch, else remove it
390 autoreply define l2_patch_add_del
399 /** \brief Set L2 XConnect between two interfaces request
400 @param client_index - opaque cookie to identify the sender
401 @param context - sender context, to match reply w/ request
402 @param rx_sw_if_index - Receive interface index
403 @param tx_sw_if_index - Transmit interface index
404 @param enable - enable xconnect if not 0, else set to L3 mode
406 autoreply define sw_interface_set_l2_xconnect
415 /** \brief Interface bridge mode request
416 @param client_index - opaque cookie to identify the sender
417 @param context - sender context, to match reply w/ request
418 @param rx_sw_if_index - the interface
419 @param bd_id - bridge domain id
420 @param bvi - Setup interface as a bvi, bridge mode only
421 @param shg - Shared horizon group, for bridge mode only
422 @param enable - Enable beige mode if not 0, else set to L3 mode
424 autoreply define sw_interface_set_l2_bridge
435 /** \brief Set bridge domain ip to mac entry request
436 @param client_index - opaque cookie to identify the sender
437 @param context - sender context, to match reply w/ request
438 @param bd_id - the bridge domain to set the flags for
439 @param is_add - if non-zero, add the entry, else clear it
440 @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
441 @param mac_address - MAC address
444 autoreply define bd_ip_mac_add_del
455 /** \brief L2 interface ethernet flow point filtering enable/disable request
456 @param client_index - opaque cookie to identify the sender
457 @param context - sender context, to match reply w/ request
458 @param sw_if_index - interface to enable/disable filtering on
459 @param enable_disable - if non-zero enable filtering, else disable
461 autoreply define l2_interface_efp_filter
469 /** \brief Interface set vpath request
470 @param client_index - opaque cookie to identify the sender
471 @param context - sender context, to match reply w/ request
472 @param sw_if_index - interface used to reach neighbor
473 @param enable - if non-zero enable, else disable
475 autoreply define sw_interface_set_vpath
485 * eval: (c-set-style "gnu")