| /* |
| * Copyright (c) 2015-2016 Cisco and/or its affiliates. |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at: |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| /** \brief Set BFD echo source |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - interface to use as echo source |
| */ |
| autoreply define bfd_udp_set_echo_source |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| }; |
| |
| /** \brief Delete BFD echo source |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| */ |
| autoreply define bfd_udp_del_echo_source |
| { |
| u32 client_index; |
| u32 context; |
| }; |
| |
| /** \brief Add UDP BFD session on interface |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param desired_min_tx - desired min transmit interval (microseconds) |
| @param required_min_rx - required min receive interval (microseconds) |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| @param detect_mult - detect multiplier (# of packets missed before connection goes down) |
| @param is_authenticated - non-zero if authentication is required |
| @param bfd_key_id - key id sent out in BFD packets (if is_authenticated) |
| @param conf_key_id - id of already configured key (if is_authenticated) |
| */ |
| autoreply define bfd_udp_add |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| u32 desired_min_tx; |
| u32 required_min_rx; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| u8 detect_mult; |
| u8 is_authenticated; |
| u8 bfd_key_id; |
| u32 conf_key_id; |
| }; |
| |
| /** \brief Modify UDP BFD session on interface |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param desired_min_tx - desired min transmit interval (microseconds) |
| @param required_min_rx - required min receive interval (microseconds) |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| @param detect_mult - detect multiplier (# of packets missed before connection goes down) |
| */ |
| autoreply define bfd_udp_mod |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| u32 desired_min_tx; |
| u32 required_min_rx; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| u8 detect_mult; |
| }; |
| |
| /** \brief Delete UDP BFD session on interface |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| */ |
| autoreply define bfd_udp_del |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| }; |
| |
| /** \brief Get all BFD sessions |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| */ |
| define bfd_udp_session_dump |
| { |
| u32 client_index; |
| u32 context; |
| }; |
| |
| /** \brief BFD session details structure |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| @param state - session state |
| @param is_authenticated - non-zero if authentication in-use, zero otherwise |
| @param bfd_key_id - ID of key currently in-use if auth is on |
| @param conf_key_id - configured key ID for this session |
| @param required_min_rx - required min receive interval (microseconds) |
| @param desired_min_tx - desired min transmit interval (microseconds) |
| @param detect_mult - detect multiplier (# of packets missed before connection goes down) |
| */ |
| define bfd_udp_session_details |
| { |
| u32 context; |
| u32 sw_if_index; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| u8 state; |
| u8 is_authenticated; |
| u8 bfd_key_id; |
| u32 conf_key_id; |
| u32 required_min_rx; |
| u32 desired_min_tx; |
| u8 detect_mult; |
| }; |
| |
| /** \brief Set flags of BFD UDP session |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| @param admin_up_down - set the admin state, 1 = up, 0 = down |
| */ |
| autoreply define bfd_udp_session_set_flags |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| u8 admin_up_down; |
| }; |
| |
| /** \brief Register for BFD events |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param enable_disable - 1 => register for events, 0 => cancel registration |
| @param pid - sender's pid |
| */ |
| autoreply define want_bfd_events |
| { |
| u32 client_index; |
| u32 context; |
| u32 enable_disable; |
| u32 pid; |
| }; |
| |
| /** \brief BFD UDP - add/replace key to configuration |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param conf_key_id - key ID to add/replace/delete |
| @param key_len - length of key (must be non-zero) |
| @param auth_type - authentication type (RFC 5880/4.1/Auth Type) |
| @param key - key data |
| */ |
| autoreply define bfd_auth_set_key |
| { |
| u32 client_index; |
| u32 context; |
| u32 conf_key_id; |
| u8 key_len; |
| u8 auth_type; |
| u8 key[20]; |
| }; |
| |
| /** \brief BFD UDP - delete key from configuration |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param conf_key_id - key ID to add/replace/delete |
| @param key_len - length of key (must be non-zero) |
| @param key - key data |
| */ |
| autoreply define bfd_auth_del_key |
| { |
| u32 client_index; |
| u32 context; |
| u32 conf_key_id; |
| }; |
| |
| /** \brief Get a list of configured authentication keys |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| */ |
| define bfd_auth_keys_dump |
| { |
| u32 client_index; |
| u32 context; |
| }; |
| |
| /** \brief BFD authentication key details |
| @param context - sender context, to match reply w/ request |
| @param conf_key_id - configured key ID |
| @param use_count - how many BFD sessions currently use this key |
| @param auth_type - authentication type (RFC 5880/4.1/Auth Type) |
| */ |
| define bfd_auth_keys_details |
| { |
| u32 context; |
| u32 conf_key_id; |
| u32 use_count; |
| u8 auth_type; |
| }; |
| |
| /** \brief BFD UDP - activate/change authentication |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| @param is_delayed - change is applied once peer applies the change (on first received packet with this auth) |
| @param bfd_key_id - key id sent out in BFD packets |
| @param conf_key_id - id of already configured key |
| */ |
| autoreply define bfd_udp_auth_activate |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| u8 is_delayed; |
| u8 bfd_key_id; |
| u32 conf_key_id; |
| }; |
| |
| /** \brief BFD UDP - deactivate authentication |
| @param client_index - opaque cookie to identify the sender |
| @param context - sender context, to match reply w/ request |
| @param sw_if_index - sw index of the interface |
| @param local_addr - local address |
| @param peer_addr - peer address |
| @param is_ipv6 - local_addr, peer_addr are IPv6 if non-zero, otherwise IPv4 |
| @param is_delayed - change is applied once peer applies the change (on first received non-authenticated packet) |
| */ |
| autoreply define bfd_udp_auth_deactivate |
| { |
| u32 client_index; |
| u32 context; |
| u32 sw_if_index; |
| u8 local_addr[16]; |
| u8 peer_addr[16]; |
| u8 is_ipv6; |
| u8 is_delayed; |
| }; |
| |
| /* |
| * Local Variables: |
| * eval: (c-set-style "gnu") |
| * End: |
| */ |