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.
18 /** \brief Set BFD echo source
19 @param client_index - opaque cookie to identify the sender
20 @param context - sender context, to match reply w/ request
21 @param sw_if_index - interface to use as echo source
23 autoreply define bfd_udp_set_echo_source
30 /** \brief Delete BFD echo source
31 @param client_index - opaque cookie to identify the sender
32 @param context - sender context, to match reply w/ request
34 autoreply define bfd_udp_del_echo_source
40 /** \brief Add UDP BFD session on interface
41 @param client_index - opaque cookie to identify the sender
42 @param context - sender context, to match reply w/ request
43 @param sw_if_index - sw index of the interface
44 @param desired_min_tx - desired min transmit interval (microseconds)
45 @param required_min_rx - required min receive interval (microseconds)
46 @param local_addr - local address
47 @param peer_addr - peer address
48 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
49 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
50 @param is_authenticated - non-zero if authentication is required
51 @param bfd_key_id - key id sent out in BFD packets (if is_authenticated)
52 @param conf_key_id - id of already configured key (if is_authenticated)
54 autoreply define bfd_udp_add
70 /** \brief Modify 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)
81 autoreply define bfd_udp_mod
94 /** \brief Delete UDP BFD session on interface
95 @param client_index - opaque cookie to identify the sender
96 @param context - sender context, to match reply w/ request
97 @param sw_if_index - sw index of the interface
98 @param local_addr - local address
99 @param peer_addr - peer address
100 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
102 autoreply define bfd_udp_del
112 /** \brief Get all BFD sessions
113 @param client_index - opaque cookie to identify the sender
114 @param context - sender context, to match reply w/ request
116 define bfd_udp_session_dump
122 /** \brief BFD session details structure
123 @param context - sender context, to match reply w/ request
124 @param sw_if_index - sw index of the interface
125 @param local_addr - local address
126 @param peer_addr - peer address
127 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
128 @param state - session state
129 @param is_authenticated - non-zero if authentication in-use, zero otherwise
130 @param bfd_key_id - ID of key currently in-use if auth is on
131 @param conf_key_id - configured key ID for this session
132 @param required_min_rx - required min receive interval (microseconds)
133 @param desired_min_tx - desired min transmit interval (microseconds)
134 @param detect_mult - detect multiplier (# of packets missed before connection goes down)
136 define bfd_udp_session_details
152 /** \brief Set flags of BFD UDP session
153 @param client_index - opaque cookie to identify the sender
154 @param context - sender context, to match reply w/ request
155 @param sw_if_index - sw index of the interface
156 @param local_addr - local address
157 @param peer_addr - peer address
158 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
159 @param admin_up_down - set the admin state, 1 = up, 0 = down
161 autoreply define bfd_udp_session_set_flags
172 /** \brief Register for BFD events
173 @param client_index - opaque cookie to identify the sender
174 @param context - sender context, to match reply w/ request
175 @param enable_disable - 1 => register for events, 0 => cancel registration
176 @param pid - sender's pid
178 autoreply define want_bfd_events
186 /** \brief BFD UDP - add/replace key to configuration
187 @param client_index - opaque cookie to identify the sender
188 @param context - sender context, to match reply w/ request
189 @param conf_key_id - key ID to add/replace/delete
190 @param key_len - length of key (must be non-zero)
191 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
192 @param key - key data
194 autoreply define bfd_auth_set_key
204 /** \brief BFD UDP - delete key from configuration
205 @param client_index - opaque cookie to identify the sender
206 @param context - sender context, to match reply w/ request
207 @param conf_key_id - key ID to add/replace/delete
208 @param key_len - length of key (must be non-zero)
209 @param key - key data
211 autoreply define bfd_auth_del_key
218 /** \brief Get a list of configured authentication keys
219 @param client_index - opaque cookie to identify the sender
220 @param context - sender context, to match reply w/ request
222 define bfd_auth_keys_dump
228 /** \brief BFD authentication key details
229 @param context - sender context, to match reply w/ request
230 @param conf_key_id - configured key ID
231 @param use_count - how many BFD sessions currently use this key
232 @param auth_type - authentication type (RFC 5880/4.1/Auth Type)
234 define bfd_auth_keys_details
242 /** \brief BFD UDP - activate/change authentication
243 @param client_index - opaque cookie to identify the sender
244 @param context - sender context, to match reply w/ request
245 @param sw_if_index - sw index of the interface
246 @param local_addr - local address
247 @param peer_addr - peer address
248 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
249 @param is_delayed - change is applied once peer applies the change (on first received packet with this auth)
250 @param bfd_key_id - key id sent out in BFD packets
251 @param conf_key_id - id of already configured key
253 autoreply define bfd_udp_auth_activate
266 /** \brief BFD UDP - deactivate authentication
267 @param client_index - opaque cookie to identify the sender
268 @param context - sender context, to match reply w/ request
269 @param sw_if_index - sw index of the interface
270 @param local_addr - local address
271 @param peer_addr - peer address
272 @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4
273 @param is_delayed - change is applied once peer applies the change (on first received non-authenticated packet)
275 autoreply define bfd_udp_auth_deactivate
288 * eval: (c-set-style "gnu")