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 = "1.0.0";
24 /** \brief Initialize a new bond interface with the given paramters
25 @param client_index - opaque cookie to identify the sender
26 @param context - sender context, to match reply w/ request
27 @param id - if non-~0, specifies a custom interface ID
28 @param use_custom_mac - if set, mac_address is valid
29 @param mac_address - mac addr to assign to the interface if use_custom_mac is set
30 @param mode - mode, required (1=round-robin, 2=active-backup, 3=xor, 4=broadcastcast, 5=lacp)
31 @param lb - load balance, optional (0=l2, 1=l34, 2=l23) valid for xor and lacp modes. Otherwise ignored
44 /** \brief Reply for bond create reply
45 @param context - returned sender context, to match reply w/ request
46 @param retval - return code
47 @param sw_if_index - software index allocated for the new tap interface
49 define bond_create_reply
56 /** \brief Delete bond interface
57 @param client_index - opaque cookie to identify the sender
58 @param context - sender context, to match reply w/ request
59 @param sw_if_index - interface index of slave interface
61 autoreply define bond_delete
68 /** \brief Initialize a new bond interface with the given paramters
69 @param client_index - opaque cookie to identify the sender
70 @param context - sender context, to match reply w/ request
71 @param sw_if_index - slave sw_if_index
72 @param bond_sw_if_index - bond sw_if_index
73 @param is_passive - interface does not initiate the lacp protocol, remote must be active speaker
74 @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
86 /** \brief Reply for bond enslave reply
87 @param context - returned sender context, to match reply w/ request
88 @param retval - return code
90 define bond_enslave_reply
96 /** \brief bond detach slave
97 @param client_index - opaque cookie to identify the sender
98 @param context - sender context, to match reply w/ request
99 @param sw_if_index - interface index of slave interface
101 autoreply define bond_detach_slave
108 /** \brief Dump bond interfaces request */
109 define sw_interface_bond_dump
115 /** \brief Reply for bond dump request
116 @param sw_if_index - software index of bond interface
117 @param id - ID of interface
118 @param interface_name - name of interface
119 @param mode - bonding mode
120 @param lb - load balance algo
121 @param active_slaves - active slaves count
122 @param slaves - config slave count
124 define sw_interface_bond_details
129 u8 interface_name[64];
136 /** \brief bond slave dump
137 @param client_index - opaque cookie to identify the sender
138 @param context - sender context, to match reply w/ request
139 @param sw_if_index - interface index of bond interface
141 define sw_interface_slave_dump
148 /** \brief Reply for slave dump request
149 @param sw_if_index - software index of slave interface
150 @param interface_name - name of interface
151 @param is_passve - interface does not initiate the lacp protocol, remote must be active speaker
152 @param is_long_timeout - 90 seconds vs default 3 seconds neighbor timeout
154 define sw_interface_slave_details
158 u8 interface_name[64];
165 * eval: (c-set-style "gnu")