lib/northbound_cli.h

   1 /*
   2  * Copyright (C) 2018  NetDEF, Inc.
   3  *                     Renato Westphal
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the Free
   7  * Software Foundation; either version 2 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef _FRR_NORTHBOUND_CLI_H_
  21 #define _FRR_NORTHBOUND_CLI_H_
  22
  23 #include "northbound.h"
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /* Possible formats in which a configuration can be displayed. */
  30 enum nb_cfg_format {
  31         NB_CFG_FMT_CMDS = 0,
  32         NB_CFG_FMT_JSON,
  33         NB_CFG_FMT_XML,
  34 };
  35
  36 extern struct nb_config *vty_shared_candidate_config;
  37
  38 /*
  39  * Enqueue change to be applied in the candidate configuration.
  40  *
  41  * vty
  42  *    The vty context.
  43  *
  44  * xpath
  45  *    XPath (absolute or relative) of the configuration option being edited.
  46  *
  47  * operation
  48  *    Operation to apply (either NB_OP_CREATE, NB_OP_MODIFY or NB_OP_DELETE).
  49  *
  50  * value
  51  *    New value of the configuration option. Should be NULL for typeless YANG
  52  *    data (e.g. presence-containers). For convenience, NULL can also be used
  53  *    to restore a leaf to its default value.
  54  */
  55 extern void nb_cli_enqueue_change(struct vty *vty, const char *xpath,
  56                                   enum nb_operation operation,
  57                                   const char *value);
  58
  59 /*
  60  * Apply enqueued changes to the candidate configuration, do not batch,
  61  * and apply any pending commits along with the currently enqueued.
  62  *
  63  * vty
  64  *    The vty context.
  65  *
  66  * xpath_base_fmt
  67  *    Prepend the given XPath (absolute or relative) to all enqueued
  68  *    configuration changes. This is an optional parameter.
  69  *
  70  * Returns:
  71  *    CMD_SUCCESS on success, CMD_WARNING_CONFIG_FAILED otherwise.
  72  */
  73 extern int nb_cli_apply_changes_clear_pending(struct vty *vty,
  74                                               const char *xpath_base_fmt, ...)
  75         PRINTFRR(2, 3);
  76
  77 /*
  78  * Apply enqueued changes to the candidate configuration, this function
  79  * may not immediately apply the changes, instead adding them to a pending
  80  * queue.
  81  *
  82  * vty
  83  *    The vty context.
  84  *
  85  * xpath_base_fmt
  86  *    Prepend the given XPath (absolute or relative) to all enqueued
  87  *    configuration changes. This is an optional parameter.
  88  *
  89  * Returns:
  90  *    CMD_SUCCESS on success, CMD_WARNING_CONFIG_FAILED otherwise.
  91  */
  92 extern int nb_cli_apply_changes(struct vty *vty, const char *xpath_base_fmt,
  93                                 ...) PRINTFRR(2, 3);
  94
  95 /*
  96  * Execute a YANG RPC or Action.
  97  *
  98  * vty
  99  *    The vty terminal to dump any error.
 100  *
 101  * xpath
 102  *    XPath of the YANG RPC or Action node.
 103  *
 104  * input
 105  *    List of 'yang_data' structures containing the RPC input parameters. It
 106  *    can be set to NULL when there are no input parameters.
 107  *
 108  * output
 109  *    List of 'yang_data' structures used to retrieve the RPC output parameters.
 110  *    It can be set to NULL when it's known that the given YANG RPC or Action
 111  *    doesn't have any output parameters.
 112  *
 113  * Returns:
 114  *    CMD_SUCCESS on success, CMD_WARNING otherwise.
 115  */
 116 extern int nb_cli_rpc(struct vty *vty, const char *xpath, struct list *input,
 117                       struct list *output);
 118
 119 /*
 120  * Show CLI commands associated to the given YANG data node.
 121  *
 122  * vty
 123  *    The vty terminal to dump the configuration to.
 124  *
 125  * dnode
 126  *    libyang data node that should be shown in the form of CLI commands.
 127  *
 128  * show_defaults
 129  *    Specify whether to display default configuration values or not.
 130  */
 131 extern void nb_cli_show_dnode_cmds(struct vty *vty,
 132                                    const struct lyd_node *dnode,
 133                                    bool show_defaults);
 134
 135 /*
 136  * Perform pending commit, if any.
 137  *
 138  * vty
 139  *    The vty context.
 140  *
 141  * Returns
 142  *    CMD_SUCCESS on success (or no pending), CMD_WARNING_CONFIG_FAILED
 143  *    otherwise.
 144  */
 145 extern int nb_cli_pending_commit_check(struct vty *vty);
 146
 147 /* Prototypes of internal functions. */
 148 extern void nb_cli_show_config_prepare(struct nb_config *config,
 149                                        bool with_defaults);
 150 extern void nb_cli_confirmed_commit_clean(struct vty *vty);
 151 extern int nb_cli_confirmed_commit_rollback(struct vty *vty);
 152 extern void nb_cli_install_default(int node);
 153 extern void nb_cli_init(struct thread_master *tm);
 154 extern void nb_cli_terminate(void);
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif /* _FRR_NORTHBOUND_CLI_H_ */