[mirror_frr.git] / lib / northbound_cli.h

/*
 * Copyright (C) 2018  NetDEF, Inc.
 *                     Renato Westphal
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _FRR_NORTHBOUND_CLI_H_
#define _FRR_NORTHBOUND_CLI_H_

#include "northbound.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Possible formats in which a configuration can be displayed. */
enum nb_cfg_format {
	NB_CFG_FMT_CMDS = 0,
	NB_CFG_FMT_JSON,
	NB_CFG_FMT_XML,
};

extern struct nb_config *vty_shared_candidate_config;

/*
 * Enqueue change to be applied in the candidate configuration.
 *
 * vty
 *    The vty context.
 *
 * xpath
 *    XPath (absolute or relative) of the configuration option being edited.
 *
 * operation
 *    Operation to apply (either NB_OP_CREATE, NB_OP_MODIFY or NB_OP_DELETE).
 *
 * value
 *    New value of the configuration option. Should be NULL for typeless YANG
 *    data (e.g. presence-containers). For convenience, NULL can also be used
 *    to restore a leaf to its default value.
 */
extern void nb_cli_enqueue_change(struct vty *vty, const char *xpath,
				  enum nb_operation operation,
				  const char *value);

/*
 * Apply enqueued changes to the candidate configuration.
 *
 * vty
 *    The vty context.
 *
 * xpath_base_fmt
 *    Prepend the given XPath (absolute or relative) to all enqueued
 *    configuration changes. This is an optional parameter.
 *
 * Returns:
 *    CMD_SUCCESS on success, CMD_WARNING_CONFIG_FAILED otherwise.
 */
extern int nb_cli_apply_changes(struct vty *vty, const char *xpath_base_fmt,
				...);

/*
 * Execute a YANG RPC or Action.
 *
 * xpath
 *    XPath of the YANG RPC or Action node.
 *
 * input
 *    List of 'yang_data' structures containing the RPC input parameters. It
 *    can be set to NULL when there are no input parameters.
 *
 * output
 *    List of 'yang_data' structures used to retrieve the RPC output parameters.
 *    It can be set to NULL when it's known that the given YANG RPC or Action
 *    doesn't have any output parameters.
 *
 * Returns:
 *    CMD_SUCCESS on success, CMD_WARNING otherwise.
 */
extern int nb_cli_rpc(const char *xpath, struct list *input,
		      struct list *output);

/*
 * Show CLI commands associated to the given YANG data node.
 *
 * vty
 *    The vty terminal to dump the configuration to.
 *
 * dnode
 *    libyang data node that should be shown in the form of CLI commands.
 *
 * show_defaults
 *    Specify whether to display default configuration values or not.
 */
extern void nb_cli_show_dnode_cmds(struct vty *vty, struct lyd_node *dnode,
				   bool show_defaults);

/* Prototypes of internal functions. */
extern void nb_cli_show_config_prepare(struct nb_config *config,
				       bool with_defaults);
extern void nb_cli_confirmed_commit_clean(struct vty *vty);
extern int nb_cli_confirmed_commit_rollback(struct vty *vty);
extern void nb_cli_install_default(int node);
extern void nb_cli_init(struct thread_master *tm);
extern void nb_cli_terminate(void);

#ifdef __cplusplus
}
#endif

#endif /* _FRR_NORTHBOUND_CLI_H_ */
Commit	Line	Data
1c2facd1 RW	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
5e244469 RW	25	#ifdef __cplusplus
	26	extern "C" {
	27	#endif
	28
1c2facd1 RW	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
a6233bfc RW	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.
	61	*
	62	* vty
	63	* The vty context.
	64	*
	65	* xpath_base_fmt
	66	* Prepend the given XPath (absolute or relative) to all enqueued
3cb4162c	67	* configuration changes. This is an optional parameter.
a6233bfc RW	68	*
	69	* Returns:
	70	* CMD_SUCCESS on success, CMD_WARNING_CONFIG_FAILED otherwise.
	71	*/
	72	extern int nb_cli_apply_changes(struct vty vty, const char xpath_base_fmt,
	73	...);
	74
	75	/*
	76	* Execute a YANG RPC or Action.
	77	*
	78	* xpath
	79	* XPath of the YANG RPC or Action node.
	80	*
	81	* input
	82	* List of 'yang_data' structures containing the RPC input parameters. It
	83	* can be set to NULL when there are no input parameters.
	84	*
	85	* output
	86	* List of 'yang_data' structures used to retrieve the RPC output parameters.
	87	* It can be set to NULL when it's known that the given YANG RPC or Action
	88	* doesn't have any output parameters.
	89	*
	90	* Returns:
	91	* CMD_SUCCESS on success, CMD_WARNING otherwise.
	92	*/
1c2facd1 RW	93	extern int nb_cli_rpc(const char xpath, struct list input,
1c2facd1 RW	94	struct list *output);
a6233bfc RW	95
	96	/*
	97	* Show CLI commands associated to the given YANG data node.
	98	*
	99	* vty
	100	* The vty terminal to dump the configuration to.
	101	*
	102	* dnode
	103	* libyang data node that should be shown in the form of CLI commands.
	104	*
	105	* show_defaults
	106	* Specify whether to display default configuration values or not.
	107	*/
1c2facd1 RW	108	extern void nb_cli_show_dnode_cmds(struct vty vty, struct lyd_node dnode,
1c2facd1 RW	109	bool show_defaults);
a6233bfc RW	110
a6233bfc RW	111	/* Prototypes of internal functions. */
5e6a9350 RW	112	extern void nb_cli_show_config_prepare(struct nb_config *config,
5e6a9350 RW	113	bool with_defaults);
fbdc1c0a RW	114	extern void nb_cli_confirmed_commit_clean(struct vty *vty);
fbdc1c0a RW	115	extern int nb_cli_confirmed_commit_rollback(struct vty *vty);
1c2facd1	116	extern void nb_cli_install_default(int node);
fbdc1c0a	117	extern void nb_cli_init(struct thread_master *tm);
1c2facd1 RW	118	extern void nb_cli_terminate(void);
1c2facd1 RW	119
5e244469 RW	120	#ifdef __cplusplus
	121	}
	122	#endif
	123
1c2facd1	124	#endif /* _FRR_NORTHBOUND_CLI_H_ */