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 /** \brief Configure BFD feature
17 @param client_index - opaque cookie to identify the sender
18 @param context - sender context, to match reply w/ request
19 @param slow_timer - slow timer (seconds)
20 @param min_tx - desired min tx interval
21 @param min_rx - desired min rx interval
22 @param detect_mult - desired detection multiplier
34 /** \brief Configure BFD feature response
35 @param context - sender context, to match reply w/ request
36 @param retval - return code for the request
38 define bfd_set_config_reply
44 /** \brief Get BFD configuration
52 /** \brief Get BFD configuration response
53 @param context - sender context, to match reply w/ request
54 @param retval - return code for the request
55 @param slow_timer - slow timer (seconds)
56 @param min_tx - desired min tx interval
57 @param min_rx - desired min rx interval
58 @param detect_mult - desired detection multiplier
60 define bfd_get_config_reply
70 /** \brief Add UDP BFD session on interface
71 @param client_index - opaque cookie to identify the sender
72 @param context - sender context, to match reply w/ request
73 @param sw_if_index - sw index of the interface
74 @param desired_min_tx - desired min transmit interval (microseconds)
75 @param required_min_rx - required min receive interval (microseconds)
76 @param local_addr - local address
77 @param peer_addr - peer address
78 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
79 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
80 @param is_authenticated - non-zero if authentication is required
81 @param bfd_key_id - key id sent out in BFD packets (if is_authenticated)
82 @param conf_key_id - id of already configured key (if is_authenticated)
100 /** \brief Add UDP BFD session response
101 @param context - sender context, to match reply w/ request
102 @param retval - return code for the request
104 define bfd_udp_add_reply
110 /** \brief Modify UDP BFD session on interface
111 @param client_index - opaque cookie to identify the sender
112 @param context - sender context, to match reply w/ request
113 @param sw_if_index - sw index of the interface
114 @param desired_min_tx - desired min transmit interval (microseconds)
115 @param required_min_rx - required min receive interval (microseconds)
116 @param local_addr - local address
117 @param peer_addr - peer address
118 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
119 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
134 /** \brief Modify UDP BFD session response
135 @param context - sender context, to match reply w/ request
136 @param retval - return code for the request
138 define bfd_udp_mod_reply
144 /** \brief Delete UDP BFD session on interface
145 @param client_index - opaque cookie to identify the sender
146 @param context - sender context, to match reply w/ request
147 @param sw_if_index - sw index of the interface
148 @param local_addr - local address
149 @param peer_addr - peer address
150 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
162 /** \brief Delete UDP BFD session response
163 @param context - sender context, to match reply w/ request
164 @param retval - return code for the request
166 define bfd_udp_del_reply
172 /** \brief Get all BFD sessions
173 @param client_index - opaque cookie to identify the sender
174 @param context - sender context, to match reply w/ request
176 define bfd_udp_session_dump
182 /** \brief BFD session details structure
183 @param context - sender context, to match reply w/ request
184 @param sw_if_index - sw index of the interface
185 @param local_addr - local address
186 @param peer_addr - peer address
187 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
188 @param state - session state
189 @param is_authenticated - non-zero if authentication in-use, zero otherwise
190 @param bfd_key_id - ID of key currently in-use if auth is on
191 @param conf_key_id - configured key ID for this session
192 @param required_min_rx - required min receive interval (microseconds)
193 @param desired_min_tx - desired min transmit interval (microseconds)
194 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
196 define bfd_udp_session_details
212 /** \brief Set flags of BFD UDP session
213 @param client_index - opaque cookie to identify the sender
214 @param context - sender context, to match reply w/ request
215 @param sw_if_index - sw index of the interface
216 @param local_addr - local address
217 @param peer_addr - peer address
218 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
219 @param admin_up_down - set the admin state, 1 = up, 0 = down
221 define bfd_udp_session_set_flags
232 /** \brief Reply to bfd_udp_session_set_flags
233 @param context - sender context which was passed in the request
234 @param retval - return code of the set flags request
236 define bfd_udp_session_set_flags_reply
242 /** \brief Register for BFD events
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param enable_disable - 1 => register for events, 0 => cancel registration
246 @param pid - sender's pid
248 define want_bfd_events
256 /** \brief Reply for BFD events registration
257 @param context - returned sender context, to match reply w/ request
258 @param retval - return code
260 define want_bfd_events_reply
266 /** \brief BFD UDP - add/replace key to configuration
267 @param client_index - opaque cookie to identify the sender
268 @param context - sender context, to match reply w/ request
269 @param conf_key_id - key ID to add/replace/delete
270 @param key_len - length of key (must be non-zero)
271 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
272 @param key - key data
274 define bfd_auth_set_key
284 /** \brief BFD UDP - add/replace key reply
285 @param context - returned sender context, to match reply w/ request
286 @param retval - return code
288 define bfd_auth_set_key_reply
294 /** \brief BFD UDP - delete key from configuration
295 @param client_index - opaque cookie to identify the sender
296 @param context - sender context, to match reply w/ request
297 @param conf_key_id - key ID to add/replace/delete
298 @param key_len - length of key (must be non-zero)
299 @param key - key data
301 define bfd_auth_del_key
308 /** \brief BFD UDP - delete key reply
309 @param context - returned sender context, to match reply w/ request
310 @param retval - return code
312 define bfd_auth_del_key_reply
318 /** \brief Get a list of configured authentication keys
319 @param client_index - opaque cookie to identify the sender
320 @param context - sender context, to match reply w/ request
322 define bfd_auth_keys_dump
328 /** \brief BFD authentication key details
329 @param context - sender context, to match reply w/ request
330 @param conf_key_id - configured key ID
331 @param use_count - how many BFD sessions currently use this key
332 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
334 define bfd_auth_keys_details
342 /** \brief BFD UDP - activate/change authentication
343 @param client_index - opaque cookie to identify the sender
344 @param context - sender context, to match reply w/ request
345 @param sw_if_index - sw index of the interface
346 @param local_addr - local address
347 @param peer_addr - peer address
348 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
349 @param is_delayed - change is applied once peer applies the change (on first received packet with this auth)
350 @param bfd_key_id - key id sent out in BFD packets
351 @param conf_key_id - id of already configured key
353 define bfd_udp_auth_activate
366 /** \brief BFD UDP - activate/change authentication reply
367 @param context - returned sender context, to match reply w/ request
368 @param retval - return code
370 define bfd_udp_auth_activate_reply
376 /** \brief BFD UDP - deactivate authentication
377 @param client_index - opaque cookie to identify the sender
378 @param context - sender context, to match reply w/ request
379 @param sw_if_index - sw index of the interface
380 @param local_addr - local address
381 @param peer_addr - peer address
382 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
383 @param is_delayed - change is applied once peer applies the change (on first received non-authenticated packet)
385 define bfd_udp_auth_deactivate
396 /** \brief BFD UDP - deactivate authentication reply
397 @param context - returned sender context, to match reply w/ request
398 @param retval - return code
400 define bfd_udp_auth_deactivate_reply
408 * eval: (c-set-style "gnu")