FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
bond.api
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 /** \file
17 
18  This file defines vpe control-plane API messages for
19  the bonding device driver
20 */
21 
22 option version = "2.0.0";
23 
24 import "vnet/interface_types.api";
25 import "vnet/ethernet/ethernet_types.api";
26 
28 {
34 };
35 
37 {
44 };
45 
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=broadcastcast, 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.
55 */
56 define bond_create
57 {
62  vl_api_mac_address_t mac_address;
63  vl_api_bond_mode_t mode;
64  vl_api_bond_lb_algo_t lb;
65  bool numa_only;
66 };
67 
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
72 */
73 define bond_create_reply
74 {
77  vl_api_interface_index_t sw_if_index;
78 };
79 
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 slave interface
84 */
85 autoreply define bond_delete
86 {
89  vl_api_interface_index_t sw_if_index;
90 };
91 
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
99 */
101 {
104  vl_api_interface_index_t sw_if_index;
105  vl_api_interface_index_t bond_sw_if_index;
108 };
109 
110 /** \brief Reply for bond enslave reply
111  @param context - returned sender context, to match reply w/ request
112  @param retval - return code
113 */
114 define bond_enslave_reply
115 {
118 };
119 
120 /** \brief bond detach slave
121  @param client_index - opaque cookie to identify the sender
122  @param context - sender context, to match reply w/ request
123  @param sw_if_index - interface index of slave interface
124 */
125 autoreply define bond_detach_slave
126 {
129  vl_api_interface_index_t sw_if_index;
130 };
131 
132 /** \brief Dump bond interfaces request */
133 define sw_interface_bond_dump
134 {
137 };
138 
139 /** \brief Reply for bond dump request
140  @param sw_if_index - software index of bond interface
141  @param id - ID of interface
142  @param mode - bonding mode
143  @param lb - load balance algo
144  @param numa_only - enable local numa TX for lacp mode
145  @param active_slaves - active slaves count
146  @param slaves - config slave count
147  @param interface_name - name of interface
148 */
149 define sw_interface_bond_details
150 {
152  vl_api_interface_index_t sw_if_index;
154  vl_api_bond_mode_t mode;
155  vl_api_bond_lb_algo_t lb;
156  bool numa_only;
159  string interface_name[64];
160 };
161 
162 /** \brief bond slave dump
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 bond interface
166 */
167 define sw_interface_slave_dump
168 {
171  vl_api_interface_index_t sw_if_index;
172 };
173 
174 /** \brief Reply for slave dump request
175  @param sw_if_index - software index of slave interface
176  @param interface_name - name of interface
177  @param is_passve - interface does not initiate the lacp protocol, remote must be active speaker
178  @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
179  @param is_local_numa - the slave interface is local numa
180  @param weight - the weight for the slave interface (active-backup mode only)
181 */
182 define sw_interface_slave_details
183 {
185  vl_api_interface_index_t sw_if_index;
186  string interface_name[64];
191 };
192 
193 /** \brief Interface set bond weight
194  @param client_index - opaque cookie to identify the sender
195  @param context - sender context, to match reply w/ request
196  @param sw_if_index - slave interface for which to set the weight
197  @param weight - weight value to be set for the slave interface
198 */
199 autoreply define sw_interface_set_bond_weight
200 {
203  vl_api_interface_index_t sw_if_index;
205 };
206 
207 /*
208  * Local Variables:
209  * eval: (c-set-style "gnu")
210  * End:
211  */
vl_api_bond_mode_t mode
Definition: bond.api:63
vl_api_mac_address_t mac_address
Definition: bond.api:62
vl_api_bond_lb_algo_t lb
Definition: bond.api:155
vl_api_interface_index_t sw_if_index
Definition: bond.api:89
vl_api_interface_index_t sw_if_index
Definition: bond.api:171
void bond_enslave(vlib_main_t *vm, bond_enslave_args_t *args)
Definition: cli.c:598
bond_mode
Definition: bond.api:27
unsigned int u32
Definition: types.h:88
vl_api_interface_index_t sw_if_index
Definition: bond.api:77
vl_api_interface_index_t sw_if_index
Definition: bond.api:104
vl_api_bond_mode_t mode
Definition: bond.api:154
void bond_detach_slave(vlib_main_t *vm, bond_detach_slave_args_t *args)
Definition: cli.c:827
vl_api_interface_index_t sw_if_index
Definition: bond.api:129
signed int i32
Definition: types.h:77
vl_api_bond_lb_algo_t lb
Definition: bond.api:64
option version
Definition: bond.api:22
vl_api_interface_index_t sw_if_index
Definition: bond.api:152
vl_api_interface_index_t bond_sw_if_index
Definition: bond.api:105
bond_lb_algo
Definition: bond.api:36
vl_api_interface_index_t sw_if_index
Definition: bond.api:203
vl_api_interface_index_t sw_if_index
Definition: bond.api:185