bfdd/bfdd_nb.h

   1 /*
   2  * BFD daemon northbound implementation.
   3  *
   4  * Copyright (C) 2019 Network Device Education Foundation, Inc. ("NetDEF")
   5  *                    Rafael Zalamena
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20  * 02110-1301 USA.
  21  */
  22
  23 #ifndef _FRR_BFDD_NB_H_
  24 #define _FRR_BFDD_NB_H_
  25
  26 extern const struct frr_yang_module_info frr_bfdd_info;
  27
  28 /* Mandatory callbacks. */
  29 int bfdd_bfd_create(struct nb_cb_create_args *args);
  30 int bfdd_bfd_destroy(struct nb_cb_destroy_args *args);
  31 int bfdd_bfd_profile_create(struct nb_cb_create_args *args);
  32 int bfdd_bfd_profile_destroy(struct nb_cb_destroy_args *args);
  33 int bfdd_bfd_profile_detection_multiplier_modify(
  34         struct nb_cb_modify_args *args);
  35 int bfdd_bfd_profile_desired_transmission_interval_modify(
  36         struct nb_cb_modify_args *args);
  37 int bfdd_bfd_profile_required_receive_interval_modify(
  38         struct nb_cb_modify_args *args);
  39 int bfdd_bfd_profile_administrative_down_modify(struct nb_cb_modify_args *args);
  40 int bfdd_bfd_profile_passive_mode_modify(struct nb_cb_modify_args *args);
  41 int bfdd_bfd_profile_minimum_ttl_modify(struct nb_cb_modify_args *args);
  42 int bfdd_bfd_profile_minimum_ttl_destroy(struct nb_cb_destroy_args *args);
  43 int bfdd_bfd_profile_echo_mode_modify(struct nb_cb_modify_args *args);
  44 int bfdd_bfd_profile_desired_echo_transmission_interval_modify(
  45         struct nb_cb_modify_args *args);
  46 int bfdd_bfd_profile_required_echo_receive_interval_modify(
  47         struct nb_cb_modify_args *args);
  48 int bfdd_bfd_sessions_single_hop_create(struct nb_cb_create_args *args);
  49 int bfdd_bfd_sessions_single_hop_destroy(struct nb_cb_destroy_args *args);
  50 const void *
  51 bfdd_bfd_sessions_single_hop_get_next(struct nb_cb_get_next_args *args);
  52 int bfdd_bfd_sessions_single_hop_get_keys(struct nb_cb_get_keys_args *args);
  53 const void *
  54 bfdd_bfd_sessions_single_hop_lookup_entry(struct nb_cb_lookup_entry_args *args);
  55 int bfdd_bfd_sessions_single_hop_source_addr_modify(
  56         struct nb_cb_modify_args *args);
  57 int bfdd_bfd_sessions_single_hop_source_addr_destroy(
  58         struct nb_cb_destroy_args *args);
  59 int bfdd_bfd_sessions_single_hop_profile_modify(struct nb_cb_modify_args *args);
  60 int bfdd_bfd_sessions_single_hop_profile_destroy(
  61         struct nb_cb_destroy_args *args);
  62 int bfdd_bfd_sessions_single_hop_detection_multiplier_modify(
  63         struct nb_cb_modify_args *args);
  64 int bfdd_bfd_sessions_single_hop_desired_transmission_interval_modify(
  65         struct nb_cb_modify_args *args);
  66 int bfdd_bfd_sessions_single_hop_required_receive_interval_modify(
  67         struct nb_cb_modify_args *args);
  68 int bfdd_bfd_sessions_single_hop_administrative_down_modify(
  69         struct nb_cb_modify_args *args);
  70 int bfdd_bfd_sessions_single_hop_passive_mode_modify(
  71         struct nb_cb_modify_args *args);
  72 int bfdd_bfd_sessions_single_hop_echo_mode_modify(
  73         struct nb_cb_modify_args *args);
  74 int bfdd_bfd_sessions_single_hop_desired_echo_transmission_interval_modify(
  75         struct nb_cb_modify_args *args);
  76 int bfdd_bfd_sessions_single_hop_required_echo_receive_interval_modify(
  77         struct nb_cb_modify_args *args);
  78 struct yang_data *
  79 bfdd_bfd_sessions_single_hop_stats_local_discriminator_get_elem(
  80         struct nb_cb_get_elem_args *args);
  81 struct yang_data *bfdd_bfd_sessions_single_hop_stats_local_state_get_elem(
  82         struct nb_cb_get_elem_args *args);
  83 struct yang_data *bfdd_bfd_sessions_single_hop_stats_local_diagnostic_get_elem(
  84         struct nb_cb_get_elem_args *args);
  85 struct yang_data *bfdd_bfd_sessions_single_hop_stats_local_multiplier_get_elem(
  86         struct nb_cb_get_elem_args *args);
  87 struct yang_data *
  88 bfdd_bfd_sessions_single_hop_stats_remote_discriminator_get_elem(
  89         struct nb_cb_get_elem_args *args);
  90 struct yang_data *bfdd_bfd_sessions_single_hop_stats_remote_state_get_elem(
  91         struct nb_cb_get_elem_args *args);
  92 struct yang_data *bfdd_bfd_sessions_single_hop_stats_remote_diagnostic_get_elem(
  93         struct nb_cb_get_elem_args *args);
  94 struct yang_data *bfdd_bfd_sessions_single_hop_stats_remote_multiplier_get_elem(
  95         struct nb_cb_get_elem_args *args);
  96 struct yang_data *
  97 bfdd_bfd_sessions_single_hop_stats_negotiated_transmission_interval_get_elem(
  98         struct nb_cb_get_elem_args *args);
  99 struct yang_data *
 100 bfdd_bfd_sessions_single_hop_stats_negotiated_receive_interval_get_elem(
 101         struct nb_cb_get_elem_args *args);
 102 struct yang_data *bfdd_bfd_sessions_single_hop_stats_detection_mode_get_elem(
 103         struct nb_cb_get_elem_args *args);
 104 struct yang_data *bfdd_bfd_sessions_single_hop_stats_last_down_time_get_elem(
 105         struct nb_cb_get_elem_args *args);
 106 struct yang_data *bfdd_bfd_sessions_single_hop_stats_last_up_time_get_elem(
 107         struct nb_cb_get_elem_args *args);
 108 struct yang_data *
 109 bfdd_bfd_sessions_single_hop_stats_session_down_count_get_elem(
 110         struct nb_cb_get_elem_args *args);
 111 struct yang_data *bfdd_bfd_sessions_single_hop_stats_session_up_count_get_elem(
 112         struct nb_cb_get_elem_args *args);
 113 struct yang_data *
 114 bfdd_bfd_sessions_single_hop_stats_control_packet_input_count_get_elem(
 115         struct nb_cb_get_elem_args *args);
 116 struct yang_data *
 117 bfdd_bfd_sessions_single_hop_stats_control_packet_output_count_get_elem(
 118         struct nb_cb_get_elem_args *args);
 119 struct yang_data *
 120 bfdd_bfd_sessions_single_hop_stats_negotiated_echo_transmission_interval_get_elem(
 121         struct nb_cb_get_elem_args *args);
 122 struct yang_data *
 123 bfdd_bfd_sessions_single_hop_stats_echo_packet_input_count_get_elem(
 124         struct nb_cb_get_elem_args *args);
 125 struct yang_data *
 126 bfdd_bfd_sessions_single_hop_stats_echo_packet_output_count_get_elem(
 127         struct nb_cb_get_elem_args *args);
 128 int bfdd_bfd_sessions_multi_hop_create(struct nb_cb_create_args *args);
 129 int bfdd_bfd_sessions_multi_hop_destroy(struct nb_cb_destroy_args *args);
 130 const void *
 131 bfdd_bfd_sessions_multi_hop_get_next(struct nb_cb_get_next_args *args);
 132 int bfdd_bfd_sessions_multi_hop_get_keys(struct nb_cb_get_keys_args *args);
 133 const void *
 134 bfdd_bfd_sessions_multi_hop_lookup_entry(struct nb_cb_lookup_entry_args *args);
 135 int bfdd_bfd_sessions_multi_hop_detection_multiplier_modify(
 136         struct nb_cb_modify_args *args);
 137 int bfdd_bfd_sessions_multi_hop_desired_transmission_interval_modify(
 138         struct nb_cb_modify_args *args);
 139 int bfdd_bfd_sessions_multi_hop_required_receive_interval_modify(
 140         struct nb_cb_modify_args *args);
 141 int bfdd_bfd_sessions_multi_hop_administrative_down_modify(
 142         struct nb_cb_modify_args *args);
 143 int bfdd_bfd_sessions_multi_hop_minimum_ttl_modify(
 144         struct nb_cb_modify_args *args);
 145 int bfdd_bfd_sessions_multi_hop_minimum_ttl_destroy(
 146         struct nb_cb_destroy_args *args);
 147 struct yang_data *
 148 bfdd_bfd_sessions_multi_hop_stats_local_discriminator_get_elem(
 149         struct nb_cb_get_elem_args *args);
 150 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_local_state_get_elem(
 151         struct nb_cb_get_elem_args *args);
 152 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_local_diagnostic_get_elem(
 153         struct nb_cb_get_elem_args *args);
 154 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_local_multiplier_get_elem(
 155         struct nb_cb_get_elem_args *args);
 156 struct yang_data *
 157 bfdd_bfd_sessions_multi_hop_stats_remote_discriminator_get_elem(
 158         struct nb_cb_get_elem_args *args);
 159 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_remote_state_get_elem(
 160         struct nb_cb_get_elem_args *args);
 161 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_remote_diagnostic_get_elem(
 162         struct nb_cb_get_elem_args *args);
 163 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_remote_multiplier_get_elem(
 164         struct nb_cb_get_elem_args *args);
 165 struct yang_data *
 166 bfdd_bfd_sessions_multi_hop_stats_negotiated_transmission_interval_get_elem(
 167         struct nb_cb_get_elem_args *args);
 168 struct yang_data *
 169 bfdd_bfd_sessions_multi_hop_stats_negotiated_receive_interval_get_elem(
 170         struct nb_cb_get_elem_args *args);
 171 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_detection_mode_get_elem(
 172         struct nb_cb_get_elem_args *args);
 173 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_last_down_time_get_elem(
 174         struct nb_cb_get_elem_args *args);
 175 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_last_up_time_get_elem(
 176         struct nb_cb_get_elem_args *args);
 177 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_session_down_count_get_elem(
 178         struct nb_cb_get_elem_args *args);
 179 struct yang_data *bfdd_bfd_sessions_multi_hop_stats_session_up_count_get_elem(
 180         struct nb_cb_get_elem_args *args);
 181 struct yang_data *
 182 bfdd_bfd_sessions_multi_hop_stats_control_packet_input_count_get_elem(
 183         struct nb_cb_get_elem_args *args);
 184 struct yang_data *
 185 bfdd_bfd_sessions_multi_hop_stats_control_packet_output_count_get_elem(
 186         struct nb_cb_get_elem_args *args);
 187 struct yang_data *
 188 bfdd_bfd_sessions_multi_hop_stats_negotiated_echo_transmission_interval_get_elem(
 189         struct nb_cb_get_elem_args *args);
 190 struct yang_data *
 191 bfdd_bfd_sessions_multi_hop_stats_echo_packet_input_count_get_elem(
 192         struct nb_cb_get_elem_args *args);
 193 struct yang_data *
 194 bfdd_bfd_sessions_multi_hop_stats_echo_packet_output_count_get_elem(
 195         struct nb_cb_get_elem_args *args);
 196
 197 /* Optional 'cli_show' callbacks. */
 198 void bfd_cli_show_header(struct vty *vty, const struct lyd_node *dnode,
 199                          bool show_defaults);
 200 void bfd_cli_show_header_end(struct vty *vty, const struct lyd_node *dnode);
 201 void bfd_cli_show_single_hop_peer(struct vty *vty, const struct lyd_node *dnode,
 202                                   bool show_defaults);
 203 void bfd_cli_show_multi_hop_peer(struct vty *vty, const struct lyd_node *dnode,
 204                                  bool show_defaults);
 205 void bfd_cli_show_peer_end(struct vty *vty, const struct lyd_node *dnode);
 206 void bfd_cli_show_mult(struct vty *vty, const struct lyd_node *dnode,
 207                        bool show_defaults);
 208 void bfd_cli_show_tx(struct vty *vty, const struct lyd_node *dnode,
 209                      bool show_defaults);
 210 void bfd_cli_show_rx(struct vty *vty, const struct lyd_node *dnode,
 211                      bool show_defaults);
 212 void bfd_cli_show_shutdown(struct vty *vty, const struct lyd_node *dnode,
 213                            bool show_defaults);
 214 void bfd_cli_show_echo(struct vty *vty, const struct lyd_node *dnode,
 215                        bool show_defaults);
 216 void bfd_cli_show_desired_echo_transmission_interval(
 217         struct vty *vty, const struct lyd_node *dnode, bool show_defaults);
 218 void bfd_cli_show_required_echo_receive_interval(struct vty *vty,
 219                                                  const struct lyd_node *dnode,
 220                                                  bool show_defaults);
 221 void bfd_cli_show_profile(struct vty *vty, const struct lyd_node *dnode,
 222                           bool show_defaults);
 223 void bfd_cli_peer_profile_show(struct vty *vty, const struct lyd_node *dnode,
 224                                bool show_defaults);
 225 void bfd_cli_show_passive(struct vty *vty, const struct lyd_node *dnode,
 226                           bool show_defaults);
 227 void bfd_cli_show_minimum_ttl(struct vty *vty, const struct lyd_node *dnode,
 228                               bool show_defaults);
 229
 230 #endif /* _FRR_BFDD_NB_H_ */