]>
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 | * | |
f63f5f19 CS |
78 | * vty |
79 | * The vty terminal to dump any error. | |
80 | * | |
a6233bfc RW |
81 | * xpath |
82 | * XPath of the YANG RPC or Action node. | |
83 | * | |
84 | * input | |
85 | * List of 'yang_data' structures containing the RPC input parameters. It | |
86 | * can be set to NULL when there are no input parameters. | |
87 | * | |
88 | * output | |
89 | * List of 'yang_data' structures used to retrieve the RPC output parameters. | |
90 | * It can be set to NULL when it's known that the given YANG RPC or Action | |
91 | * doesn't have any output parameters. | |
92 | * | |
93 | * Returns: | |
94 | * CMD_SUCCESS on success, CMD_WARNING otherwise. | |
95 | */ | |
f63f5f19 | 96 | extern int nb_cli_rpc(struct vty *vty, const char *xpath, struct list *input, |
1c2facd1 | 97 | struct list *output); |
a6233bfc RW |
98 | |
99 | /* | |
100 | * Show CLI commands associated to the given YANG data node. | |
101 | * | |
102 | * vty | |
103 | * The vty terminal to dump the configuration to. | |
104 | * | |
105 | * dnode | |
106 | * libyang data node that should be shown in the form of CLI commands. | |
107 | * | |
108 | * show_defaults | |
109 | * Specify whether to display default configuration values or not. | |
110 | */ | |
1c2facd1 RW |
111 | extern void nb_cli_show_dnode_cmds(struct vty *vty, struct lyd_node *dnode, |
112 | bool show_defaults); | |
a6233bfc | 113 | |
b855e95f RW |
114 | /* |
115 | * Perform pending commit, if any. | |
116 | * | |
117 | * vty | |
118 | * The vty context. | |
119 | */ | |
120 | extern void nb_cli_pending_commit_check(struct vty *vty); | |
121 | ||
a6233bfc | 122 | /* Prototypes of internal functions. */ |
5e6a9350 RW |
123 | extern void nb_cli_show_config_prepare(struct nb_config *config, |
124 | bool with_defaults); | |
fbdc1c0a RW |
125 | extern void nb_cli_confirmed_commit_clean(struct vty *vty); |
126 | extern int nb_cli_confirmed_commit_rollback(struct vty *vty); | |
1c2facd1 | 127 | extern void nb_cli_install_default(int node); |
fbdc1c0a | 128 | extern void nb_cli_init(struct thread_master *tm); |
1c2facd1 RW |
129 | extern void nb_cli_terminate(void); |
130 | ||
5e244469 RW |
131 | #ifdef __cplusplus |
132 | } | |
133 | #endif | |
134 | ||
1c2facd1 | 135 | #endif /* _FRR_NORTHBOUND_CLI_H_ */ |