2 * Copyright (c) 2015-2016 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.
16 option version = "2.0.0";
18 import "vnet/interface_types.api";
19 import "vnet/ip/ip_types.api";
22 BFD_STATE_API_ADMIN_DOWN = 0,
23 BFD_STATE_API_DOWN = 1,
24 BFD_STATE_API_INIT = 2,
28 /** \brief Set BFD echo source
29 @param client_index - opaque cookie to identify the sender
30 @param context - sender context, to match reply w/ request
31 @param sw_if_index - interface to use as echo source
33 autoreply define bfd_udp_set_echo_source
37 vl_api_interface_index_t sw_if_index;
40 /** \brief Delete BFD echo source
41 @param client_index - opaque cookie to identify the sender
42 @param context - sender context, to match reply w/ request
44 autoreply define bfd_udp_del_echo_source
50 /** \brief Get BFD echo source
51 @param client_index - opaque cookie to identify the sender
52 @param context - sender context, to match reply w/ request
54 define bfd_udp_get_echo_source
60 /** \brief Get BFD echo source reply
61 @param context - sender context, to match reply w/ request
62 @param retval - return code
63 @param sw_if_index - interface to use as echo source
64 @param is_set - non-zero if set
65 @param have_usable_ip4 - non-zero if have usable IPv4 address
66 @param ip4_addr - IPv4 address
67 @param have_usable_ip6 - non-zero if have usable IPv6 address
68 @param ip6_addr - IPv6 address
70 define bfd_udp_get_echo_source_reply
74 vl_api_interface_index_t sw_if_index;
77 vl_api_ip4_address_t ip4_addr;
79 vl_api_ip6_address_t ip6_addr;
82 /** \brief Add UDP BFD session on interface
83 @param client_index - opaque cookie to identify the sender
84 @param context - sender context, to match reply w/ request
85 @param sw_if_index - sw index of the interface
86 @param desired_min_tx - desired min transmit interval (microseconds)
87 @param required_min_rx - required min receive interval (microseconds)
88 @param local_addr - local address
89 @param peer_addr - peer address
90 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
91 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
92 @param is_authenticated - non-zero if authentication is required
93 @param bfd_key_id - key id sent out in BFD packets (if is_authenticated)
94 @param conf_key_id - id of already configured key (if is_authenticated)
96 autoreply define bfd_udp_add
100 vl_api_interface_index_t sw_if_index;
103 vl_api_address_t local_addr;
104 vl_api_address_t peer_addr;
106 bool is_authenticated;
114 vl_api_interface_index_t sw_if_index;
117 vl_api_address_t local_addr;
118 vl_api_address_t peer_addr;
120 bool is_authenticated;
124 define bfd_udp_upd_reply
131 /** \brief Modify UDP BFD session on interface
132 @param client_index - opaque cookie to identify the sender
133 @param context - sender context, to match reply w/ request
134 @param sw_if_index - sw index of the interface
135 @param desired_min_tx - desired min transmit interval (microseconds)
136 @param required_min_rx - required min receive interval (microseconds)
137 @param local_addr - local address
138 @param peer_addr - peer address
139 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
140 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
142 autoreply define bfd_udp_mod
146 vl_api_interface_index_t sw_if_index;
149 vl_api_address_t local_addr;
150 vl_api_address_t peer_addr;
154 /** \brief Delete UDP BFD session on interface
155 @param client_index - opaque cookie to identify the sender
156 @param context - sender context, to match reply w/ request
157 @param sw_if_index - sw index of the interface
158 @param local_addr - local address
159 @param peer_addr - peer address
160 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
162 autoreply define bfd_udp_del
166 vl_api_interface_index_t sw_if_index;
167 vl_api_address_t local_addr;
168 vl_api_address_t peer_addr;
171 /** \brief Get all BFD sessions
172 @param client_index - opaque cookie to identify the sender
173 @param context - sender context, to match reply w/ request
175 define bfd_udp_session_dump
181 /** \brief BFD session details structure
182 @param context - sender context, to match reply w/ request
183 @param sw_if_index - sw index of the interface
184 @param local_addr - local address
185 @param peer_addr - peer address
186 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
187 @param state - session state
188 @param is_authenticated - non-zero if authentication in-use, zero otherwise
189 @param bfd_key_id - ID of key currently in-use if auth is on
190 @param conf_key_id - configured key ID for this session
191 @param required_min_rx - required min receive interval (microseconds)
192 @param desired_min_tx - desired min transmit interval (microseconds)
193 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
195 define bfd_udp_session_details
198 vl_api_interface_index_t sw_if_index;
199 vl_api_address_t local_addr;
200 vl_api_address_t peer_addr;
201 vl_api_bfd_state_t state;
202 bool is_authenticated;
210 /** \brief Set flags of BFD UDP session
211 @param client_index - opaque cookie to identify the sender
212 @param context - sender context, to match reply w/ request
213 @param sw_if_index - sw index of the interface
214 @param local_addr - local address
215 @param peer_addr - peer address
216 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
217 @param flags - set the admin state, 1 = up, 0 = down
219 autoreply define bfd_udp_session_set_flags
223 vl_api_interface_index_t sw_if_index;
224 vl_api_address_t local_addr;
225 vl_api_address_t peer_addr;
226 vl_api_if_status_flags_t flags;
230 rpc want_bfd_events returns want_bfd_events_reply
231 events bfd_udp_session_event;
234 /** \brief Register for BFD events
235 @param client_index - opaque cookie to identify the sender
236 @param context - sender context, to match reply w/ request
237 @param enable_disable - 1 => register for events, 0 => cancel registration
238 @param pid - sender's pid
240 autoreply define want_bfd_events
248 define bfd_udp_session_event
252 vl_api_interface_index_t sw_if_index;
253 vl_api_address_t local_addr;
254 vl_api_address_t peer_addr;
255 vl_api_bfd_state_t state;
256 bool is_authenticated;
264 /** \brief BFD UDP - add/replace key to configuration
265 @param client_index - opaque cookie to identify the sender
266 @param context - sender context, to match reply w/ request
267 @param conf_key_id - key ID to add/replace/delete
268 @param key_len - length of key (must be non-zero)
269 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
270 @param key - key data
272 autoreply define bfd_auth_set_key
282 /** \brief BFD UDP - delete key from configuration
283 @param client_index - opaque cookie to identify the sender
284 @param context - sender context, to match reply w/ request
285 @param conf_key_id - key ID to add/replace/delete
286 @param key_len - length of key (must be non-zero)
287 @param key - key data
289 autoreply define bfd_auth_del_key
296 /** \brief Get a list of configured authentication keys
297 @param client_index - opaque cookie to identify the sender
298 @param context - sender context, to match reply w/ request
300 define bfd_auth_keys_dump
306 /** \brief BFD authentication key details
307 @param context - sender context, to match reply w/ request
308 @param conf_key_id - configured key ID
309 @param use_count - how many BFD sessions currently use this key
310 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
312 define bfd_auth_keys_details
320 /** \brief BFD UDP - activate/change authentication
321 @param client_index - opaque cookie to identify the sender
322 @param context - sender context, to match reply w/ request
323 @param sw_if_index - sw index of the interface
324 @param local_addr - local address
325 @param peer_addr - peer address
326 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
327 @param is_delayed - change is applied once peer applies the change (on first received packet with this auth)
328 @param bfd_key_id - key id sent out in BFD packets
329 @param conf_key_id - id of already configured key
331 autoreply define bfd_udp_auth_activate
335 vl_api_interface_index_t sw_if_index;
336 vl_api_address_t local_addr;
337 vl_api_address_t peer_addr;
343 /** \brief BFD UDP - deactivate authentication
344 @param client_index - opaque cookie to identify the sender
345 @param context - sender context, to match reply w/ request
346 @param sw_if_index - sw index of the interface
347 @param local_addr - local address
348 @param peer_addr - peer address
349 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
350 @param is_delayed - change is applied once peer applies the change (on first received non-authenticated packet)
352 autoreply define bfd_udp_auth_deactivate
356 vl_api_interface_index_t sw_if_index;
357 vl_api_address_t local_addr;
358 vl_api_address_t peer_addr;
364 * eval: (c-set-style "gnu")