2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 This file defines vpe control-plane API messages for
19 the bonding device driver
22 option version = "2.1.0";
24 import "vnet/interface_types.api";
25 import "vnet/ethernet/ethernet_types.api";
29 BOND_API_MODE_ROUND_ROBIN = 1,
30 BOND_API_MODE_ACTIVE_BACKUP = 2,
31 BOND_API_MODE_XOR = 3,
32 BOND_API_MODE_BROADCAST = 4,
33 BOND_API_MODE_LACP = 5,
38 BOND_API_LB_ALGO_L2 = 0,
39 BOND_API_LB_ALGO_L34 = 1,
40 BOND_API_LB_ALGO_L23 = 2,
41 BOND_API_LB_ALGO_RR = 3,
42 BOND_API_LB_ALGO_BC = 4,
43 BOND_API_LB_ALGO_AB = 5,
46 /** \brief Initialize a new bond interface with the given paramters
47 @param client_index - opaque cookie to identify the sender
48 @param context - sender context, to match reply w/ request
49 @param id - if non-~0, specifies a custom interface ID
50 @param use_custom_mac - if set, mac_address is valid
51 @param mac_address - mac addr to assign to the interface if use_custom_mac is set
52 @param mode - mode, required (1=round-robin, 2=active-backup, 3=xor, 4=broadcast, 5=lacp)
53 @param lb - load balance, optional (0=l2, 1=l34, 2=l23) valid for xor and lacp modes. Otherwise ignored
54 @param numa_only - if numa_only is set, pkts will be transmitted by LAG members on local numa node only if have at least one, otherwise it works as usual.
60 u32 id [default=0xFFFFFFFF];
62 vl_api_mac_address_t mac_address;
63 vl_api_bond_mode_t mode;
64 vl_api_bond_lb_algo_t lb;
68 /** \brief Reply for bond create reply
69 @param context - returned sender context, to match reply w/ request
70 @param retval - return code
71 @param sw_if_index - software index allocated for the new tap interface
73 define bond_create_reply
77 vl_api_interface_index_t sw_if_index;
80 /** \brief Delete bond interface
81 @param client_index - opaque cookie to identify the sender
82 @param context - sender context, to match reply w/ request
83 @param sw_if_index - interface index of member interface
85 autoreply define bond_delete
89 vl_api_interface_index_t sw_if_index;
92 /** \brief Initialize a new bond interface with the given paramters
93 @param client_index - opaque cookie to identify the sender
94 @param context - sender context, to match reply w/ request
95 @param sw_if_index - slave sw_if_index
96 @param bond_sw_if_index - bond sw_if_index
97 @param is_passive - interface does not initiate the lacp protocol, remote must be active speaker
98 @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
102 option deprecated="20.06";
105 vl_api_interface_index_t sw_if_index;
106 vl_api_interface_index_t bond_sw_if_index;
108 bool is_long_timeout;
111 /** \brief Reply for bond enslave reply
112 @param context - returned sender context, to match reply w/ request
113 @param retval - return code
115 define bond_enslave_reply
121 /** \brief Initialize a new bond interface with the given paramters
122 @param client_index - opaque cookie to identify the sender
123 @param context - sender context, to match reply w/ request
124 @param sw_if_index - member sw_if_index
125 @param bond_sw_if_index - bond sw_if_index
126 @param is_passive - interface does not initiate the lacp protocol, remote must be active speaker
127 @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
129 define bond_add_member
133 vl_api_interface_index_t sw_if_index;
134 vl_api_interface_index_t bond_sw_if_index;
136 bool is_long_timeout;
139 /** \brief Reply for bond add_member reply
140 @param context - returned sender context, to match reply w/ request
141 @param retval - return code
143 define bond_add_member_reply
149 /** \brief bond detach slave
150 @param client_index - opaque cookie to identify the sender
151 @param context - sender context, to match reply w/ request
152 @param sw_if_index - interface index of member interface
154 autoreply define bond_detach_slave
156 option deprecated="20.06";
159 vl_api_interface_index_t sw_if_index;
162 /** \brief bond detach member
163 @param client_index - opaque cookie to identify the sender
164 @param context - sender context, to match reply w/ request
165 @param sw_if_index - interface index of member interface
167 autoreply define bond_detach_member
171 vl_api_interface_index_t sw_if_index;
174 /** \brief Dump bond interfaces request */
175 define sw_interface_bond_dump
177 option deprecated="20.06";
182 /** \brief Reply for bond dump request
183 @param sw_if_index - software index of bond interface
184 @param id - ID of interface
185 @param interface_name - name of interface
186 @param mode - bonding mode
187 @param lb - load balance algo
188 @param numa_only - enable local numa TX for lacp mode
189 @param active_slaves - active member count
190 @param slaves - config member count
192 define sw_interface_bond_details
195 vl_api_interface_index_t sw_if_index;
197 vl_api_bond_mode_t mode;
198 vl_api_bond_lb_algo_t lb;
202 string interface_name[64];
205 /** \brief Dump bond interfaces request */
206 define sw_bond_interface_dump
210 vl_api_interface_index_t sw_if_index [default=0xffffffff];
213 /** \brief Reply for bond dump request
214 @param sw_if_index - software index of bond interface
215 @param id - ID of interface
216 @param mode - bonding mode
217 @param lb - load balance algo
218 @param numa_only - enable local numa TX for lacp mode
219 @param active_members - active members count
220 @param members - config member count
221 @param interface_name - name of interface
223 define sw_bond_interface_details
226 vl_api_interface_index_t sw_if_index;
228 vl_api_bond_mode_t mode;
229 vl_api_bond_lb_algo_t lb;
233 string interface_name[64];
236 /** \brief bond slave dump
237 @param client_index - opaque cookie to identify the sender
238 @param context - sender context, to match reply w/ request
239 @param sw_if_index - interface index of bond interface
241 define sw_interface_slave_dump
243 option deprecated="20.06";
246 vl_api_interface_index_t sw_if_index;
249 /** \brief Reply for slave dump request
250 @param sw_if_index - software index of slave interface
251 @param interface_name - name of interface
252 @param is_passve - interface does not initiate the lacp protocol, remote must be active speaker
253 @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
254 @param is_local_numa - the slave interface is local numa
255 @param weight - the weight for the slave interface (active-backup mode only)
257 define sw_interface_slave_details
260 vl_api_interface_index_t sw_if_index;
261 string interface_name[64];
263 bool is_long_timeout;
268 /** \brief bond member dump
269 @param client_index - opaque cookie to identify the sender
270 @param context - sender context, to match reply w/ request
271 @param sw_if_index - interface index of bond interface
273 define sw_member_interface_dump
277 vl_api_interface_index_t sw_if_index;
280 /** \brief Reply for member dump request
281 @param sw_if_index - software index of member interface
282 @param interface_name - name of interface
283 @param is_passve - interface does not initiate the lacp protocol, remote must be active speaker
284 @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
285 @param is_local_numa - the member interface is local numa
286 @param weight - the weight for the member interface (active-backup mode only)
288 define sw_member_interface_details
291 vl_api_interface_index_t sw_if_index;
292 string interface_name[64];
294 bool is_long_timeout;
299 /** \brief Interface set bond weight
300 @param client_index - opaque cookie to identify the sender
301 @param context - sender context, to match reply w/ request
302 @param sw_if_index - member interface for which to set the weight
303 @param weight - weight value to be set for the member interface
305 autoreply define sw_interface_set_bond_weight
309 vl_api_interface_index_t sw_if_index;
315 * eval: (c-set-style "gnu")