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;
111 /** \brief Modify UDP BFD session on interface
112 @param client_index - opaque cookie to identify the sender
113 @param context - sender context, to match reply w/ request
114 @param sw_if_index - sw index of the interface
115 @param desired_min_tx - desired min transmit interval (microseconds)
116 @param required_min_rx - required min receive interval (microseconds)
117 @param local_addr - local address
118 @param peer_addr - peer address
119 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
120 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
122 autoreply define bfd_udp_mod
126 vl_api_interface_index_t sw_if_index;
129 vl_api_address_t local_addr;
130 vl_api_address_t peer_addr;
134 /** \brief Delete UDP BFD session on interface
135 @param client_index - opaque cookie to identify the sender
136 @param context - sender context, to match reply w/ request
137 @param sw_if_index - sw index of the interface
138 @param local_addr - local address
139 @param peer_addr - peer address
140 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
142 autoreply define bfd_udp_del
146 vl_api_interface_index_t sw_if_index;
147 vl_api_address_t local_addr;
148 vl_api_address_t peer_addr;
151 /** \brief Get all BFD sessions
152 @param client_index - opaque cookie to identify the sender
153 @param context - sender context, to match reply w/ request
155 define bfd_udp_session_dump
161 /** \brief BFD session details structure
162 @param context - sender context, to match reply w/ request
163 @param sw_if_index - sw index of the interface
164 @param local_addr - local address
165 @param peer_addr - peer address
166 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
167 @param state - session state
168 @param is_authenticated - non-zero if authentication in-use, zero otherwise
169 @param bfd_key_id - ID of key currently in-use if auth is on
170 @param conf_key_id - configured key ID for this session
171 @param required_min_rx - required min receive interval (microseconds)
172 @param desired_min_tx - desired min transmit interval (microseconds)
173 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
175 define bfd_udp_session_details
178 vl_api_interface_index_t sw_if_index;
179 vl_api_address_t local_addr;
180 vl_api_address_t peer_addr;
181 vl_api_bfd_state_t state;
182 bool is_authenticated;
190 /** \brief Set flags of BFD UDP session
191 @param client_index - opaque cookie to identify the sender
192 @param context - sender context, to match reply w/ request
193 @param sw_if_index - sw index of the interface
194 @param local_addr - local address
195 @param peer_addr - peer address
196 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
197 @param flags - set the admin state, 1 = up, 0 = down
199 autoreply define bfd_udp_session_set_flags
203 vl_api_interface_index_t sw_if_index;
204 vl_api_address_t local_addr;
205 vl_api_address_t peer_addr;
206 vl_api_if_status_flags_t flags;
210 rpc want_bfd_events returns want_bfd_events_reply
211 events bfd_udp_session_event;
214 /** \brief Register for BFD events
215 @param client_index - opaque cookie to identify the sender
216 @param context - sender context, to match reply w/ request
217 @param enable_disable - 1 => register for events, 0 => cancel registration
218 @param pid - sender's pid
220 autoreply define want_bfd_events
228 define bfd_udp_session_event
232 vl_api_interface_index_t sw_if_index;
233 vl_api_address_t local_addr;
234 vl_api_address_t peer_addr;
235 vl_api_bfd_state_t state;
236 bool is_authenticated;
244 /** \brief BFD UDP - add/replace key to configuration
245 @param client_index - opaque cookie to identify the sender
246 @param context - sender context, to match reply w/ request
247 @param conf_key_id - key ID to add/replace/delete
248 @param key_len - length of key (must be non-zero)
249 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
250 @param key - key data
252 autoreply define bfd_auth_set_key
262 /** \brief BFD UDP - delete key from configuration
263 @param client_index - opaque cookie to identify the sender
264 @param context - sender context, to match reply w/ request
265 @param conf_key_id - key ID to add/replace/delete
266 @param key_len - length of key (must be non-zero)
267 @param key - key data
269 autoreply define bfd_auth_del_key
276 /** \brief Get a list of configured authentication keys
277 @param client_index - opaque cookie to identify the sender
278 @param context - sender context, to match reply w/ request
280 define bfd_auth_keys_dump
286 /** \brief BFD authentication key details
287 @param context - sender context, to match reply w/ request
288 @param conf_key_id - configured key ID
289 @param use_count - how many BFD sessions currently use this key
290 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
292 define bfd_auth_keys_details
300 /** \brief BFD UDP - activate/change authentication
301 @param client_index - opaque cookie to identify the sender
302 @param context - sender context, to match reply w/ request
303 @param sw_if_index - sw index of the interface
304 @param local_addr - local address
305 @param peer_addr - peer address
306 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
307 @param is_delayed - change is applied once peer applies the change (on first received packet with this auth)
308 @param bfd_key_id - key id sent out in BFD packets
309 @param conf_key_id - id of already configured key
311 autoreply define bfd_udp_auth_activate
315 vl_api_interface_index_t sw_if_index;
316 vl_api_address_t local_addr;
317 vl_api_address_t peer_addr;
323 /** \brief BFD UDP - deactivate authentication
324 @param client_index - opaque cookie to identify the sender
325 @param context - sender context, to match reply w/ request
326 @param sw_if_index - sw index of the interface
327 @param local_addr - local address
328 @param peer_addr - peer address
329 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
330 @param is_delayed - change is applied once peer applies the change (on first received non-authenticated packet)
332 autoreply define bfd_udp_auth_deactivate
336 vl_api_interface_index_t sw_if_index;
337 vl_api_address_t local_addr;
338 vl_api_address_t peer_addr;
344 * eval: (c-set-style "gnu")