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 Set BFD echo source
17 @param client_index - opaque cookie to identify the sender
18 @param context - sender context, to match reply w/ request
19 @param sw_if_index - interface to use as echo source
21 define bfd_udp_set_echo_source
28 /** \brief Set BFD feature response
29 @param context - sender context, to match reply w/ request
30 @param retval - return code for the request
32 define bfd_udp_set_echo_source_reply
38 /** \brief Delete BFD echo source
39 @param client_index - opaque cookie to identify the sender
40 @param context - sender context, to match reply w/ request
42 define bfd_udp_del_echo_source
48 /** \brief Delete BFD feature response
49 @param context - sender context, to match reply w/ request
50 @param retval - return code for the request
52 define bfd_udp_del_echo_source_reply
58 /** \brief Get BFD configuration
66 /** \brief Get BFD configuration response
67 @param context - sender context, to match reply w/ request
68 @param retval - return code for the request
69 @param slow_timer - slow timer (seconds)
70 @param min_tx - desired min tx interval
71 @param min_rx - desired min rx interval
72 @param detect_mult - desired detection multiplier
74 define bfd_get_config_reply
84 /** \brief Add UDP BFD session on interface
85 @param client_index - opaque cookie to identify the sender
86 @param context - sender context, to match reply w/ request
87 @param sw_if_index - sw index of the interface
88 @param desired_min_tx - desired min transmit interval (microseconds)
89 @param required_min_rx - required min receive interval (microseconds)
90 @param local_addr - local address
91 @param peer_addr - peer address
92 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
93 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
94 @param is_authenticated - non-zero if authentication is required
95 @param bfd_key_id - key id sent out in BFD packets (if is_authenticated)
96 @param conf_key_id - id of already configured key (if is_authenticated)
114 /** \brief Add UDP BFD session response
115 @param context - sender context, to match reply w/ request
116 @param retval - return code for the request
118 define bfd_udp_add_reply
124 /** \brief Modify UDP BFD session on interface
125 @param client_index - opaque cookie to identify the sender
126 @param context - sender context, to match reply w/ request
127 @param sw_if_index - sw index of the interface
128 @param desired_min_tx - desired min transmit interval (microseconds)
129 @param required_min_rx - required min receive interval (microseconds)
130 @param local_addr - local address
131 @param peer_addr - peer address
132 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
133 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
148 /** \brief Modify UDP BFD session response
149 @param context - sender context, to match reply w/ request
150 @param retval - return code for the request
152 define bfd_udp_mod_reply
158 /** \brief Delete UDP BFD session on interface
159 @param client_index - opaque cookie to identify the sender
160 @param context - sender context, to match reply w/ request
161 @param sw_if_index - sw index of the interface
162 @param local_addr - local address
163 @param peer_addr - peer address
164 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
176 /** \brief Delete UDP BFD session response
177 @param context - sender context, to match reply w/ request
178 @param retval - return code for the request
180 define bfd_udp_del_reply
186 /** \brief Get all BFD sessions
187 @param client_index - opaque cookie to identify the sender
188 @param context - sender context, to match reply w/ request
190 define bfd_udp_session_dump
196 /** \brief BFD session details structure
197 @param context - sender context, to match reply w/ request
198 @param sw_if_index - sw index of the interface
199 @param local_addr - local address
200 @param peer_addr - peer address
201 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
202 @param state - session state
203 @param is_authenticated - non-zero if authentication in-use, zero otherwise
204 @param bfd_key_id - ID of key currently in-use if auth is on
205 @param conf_key_id - configured key ID for this session
206 @param required_min_rx - required min receive interval (microseconds)
207 @param desired_min_tx - desired min transmit interval (microseconds)
208 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
210 define bfd_udp_session_details
226 /** \brief Set flags of BFD UDP session
227 @param client_index - opaque cookie to identify the sender
228 @param context - sender context, to match reply w/ request
229 @param sw_if_index - sw index of the interface
230 @param local_addr - local address
231 @param peer_addr - peer address
232 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
233 @param admin_up_down - set the admin state, 1 = up, 0 = down
235 define bfd_udp_session_set_flags
246 /** \brief Reply to bfd_udp_session_set_flags
247 @param context - sender context which was passed in the request
248 @param retval - return code of the set flags request
250 define bfd_udp_session_set_flags_reply
256 /** \brief Register for BFD events
257 @param client_index - opaque cookie to identify the sender
258 @param context - sender context, to match reply w/ request
259 @param enable_disable - 1 => register for events, 0 => cancel registration
260 @param pid - sender's pid
262 define want_bfd_events
270 /** \brief Reply for BFD events registration
271 @param context - returned sender context, to match reply w/ request
272 @param retval - return code
274 define want_bfd_events_reply
280 /** \brief BFD UDP - add/replace key to configuration
281 @param client_index - opaque cookie to identify the sender
282 @param context - sender context, to match reply w/ request
283 @param conf_key_id - key ID to add/replace/delete
284 @param key_len - length of key (must be non-zero)
285 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
286 @param key - key data
288 define bfd_auth_set_key
298 /** \brief BFD UDP - add/replace key reply
299 @param context - returned sender context, to match reply w/ request
300 @param retval - return code
302 define bfd_auth_set_key_reply
308 /** \brief BFD UDP - delete key from configuration
309 @param client_index - opaque cookie to identify the sender
310 @param context - sender context, to match reply w/ request
311 @param conf_key_id - key ID to add/replace/delete
312 @param key_len - length of key (must be non-zero)
313 @param key - key data
315 define bfd_auth_del_key
322 /** \brief BFD UDP - delete key reply
323 @param context - returned sender context, to match reply w/ request
324 @param retval - return code
326 define bfd_auth_del_key_reply
332 /** \brief Get a list of configured authentication keys
333 @param client_index - opaque cookie to identify the sender
334 @param context - sender context, to match reply w/ request
336 define bfd_auth_keys_dump
342 /** \brief BFD authentication key details
343 @param context - sender context, to match reply w/ request
344 @param conf_key_id - configured key ID
345 @param use_count - how many BFD sessions currently use this key
346 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
348 define bfd_auth_keys_details
356 /** \brief BFD UDP - activate/change authentication
357 @param client_index - opaque cookie to identify the sender
358 @param context - sender context, to match reply w/ request
359 @param sw_if_index - sw index of the interface
360 @param local_addr - local address
361 @param peer_addr - peer address
362 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
363 @param is_delayed - change is applied once peer applies the change (on first received packet with this auth)
364 @param bfd_key_id - key id sent out in BFD packets
365 @param conf_key_id - id of already configured key
367 define bfd_udp_auth_activate
380 /** \brief BFD UDP - activate/change authentication reply
381 @param context - returned sender context, to match reply w/ request
382 @param retval - return code
384 define bfd_udp_auth_activate_reply
390 /** \brief BFD UDP - deactivate authentication
391 @param client_index - opaque cookie to identify the sender
392 @param context - sender context, to match reply w/ request
393 @param sw_if_index - sw index of the interface
394 @param local_addr - local address
395 @param peer_addr - peer address
396 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
397 @param is_delayed - change is applied once peer applies the change (on first received non-authenticated packet)
399 define bfd_udp_auth_deactivate
410 /** \brief BFD UDP - deactivate authentication reply
411 @param context - returned sender context, to match reply w/ request
412 @param retval - return code
414 define bfd_udp_auth_deactivate_reply
422 * eval: (c-set-style "gnu")