]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.h
projects / mirror_frr.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
snapcraft: Update bgpd to use newer rpki lib
[mirror_frr.git] / lib / command.h
CommitLineData
718e3744 1/*
2 * Zebra configuration command interface routine
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
4 *
5 * This file is part of GNU Zebra.
6 *
7 * GNU Zebra is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published
9 * by the Free Software Foundation; either version 2, or (at your
10 * option) any later version.
d0bfb22c 11 *
718e3744 12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
896014f4
DL		 17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
718e3744 20 */
21
22#ifndef _ZEBRA_COMMAND_H
23#define _ZEBRA_COMMAND_H
24
25#include "vector.h"
26#include "vty.h"
9c42a6eb 27#include "lib/route_types.h"
d0bfb22c 28#include "graph.h"
4a1ab8e4 29#include "memory.h"
274f29b2 30#include "hash.h"
5894e76d 31#include "command_graph.h"
4a1ab8e4 32
5e244469
RW		 33#ifdef __cplusplus
34extern "C" {
35#endif
36
4a1ab8e4 37DECLARE_MTYPE(HOST)
70d44c5c 38DECLARE_MTYPE(COMPLETION)
4a1ab8e4 39
718e3744 40/* Host configuration variable */
d62a17ae 41struct host {
42 /* Host name of this router. */
43 char *name;
718e3744 44
6f9d219a 45 /* Domainname of this router */
419cd5a0
MK		 46 char *domainname;
47
d62a17ae 48 /* Password for vty interface. */
49 char *password;
50 char *password_encrypt;
718e3744 51
d62a17ae 52 /* Enable password */
53 char *enable;
54 char *enable_encrypt;
718e3744 55
d62a17ae 56 /* System wide terminal lines. */
57 int lines;
718e3744 58
d62a17ae 59 /* Log filename. */
60 char *logfile;
718e3744 61
d62a17ae 62 /* config file name of this host */
63 char *config;
64 int noconfig;
718e3744 65
d62a17ae 66 /* Flags for services */
67 int advanced;
68 int encrypt;
718e3744 69
d62a17ae 70 /* Banner configuration. */
71 const char *motd;
72 char *motdfile;
718e3744 73};
74
cf6c83e7 75/* List of CLI nodes. Please remember to update the name array in command.c. */
d62a17ae 76enum node_type {
9f36abf9
PZ		 77 AUTH_NODE, /* Authentication mode of vty interface. */
78 VIEW_NODE, /* View node. Default mode of vty interface. */
79 AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
80 ENABLE_NODE, /* Enable node. */
81 CONFIG_NODE, /* Config node. Default mode of config file. */
9f36abf9
PZ		 82 DEBUG_NODE, /* Debug node. */
83 VRF_DEBUG_NODE, /* Vrf Debug node. */
1c2facd1 84 NORTHBOUND_DEBUG_NODE, /* Northbound Debug node. */
9f36abf9
PZ		 85 DEBUG_VNC_NODE, /* Debug VNC node. */
86 AAA_NODE, /* AAA node. */
87 KEYCHAIN_NODE, /* Key-chain node. */
88 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
89 LOGICALROUTER_NODE, /* Logical-Router node. */
9f46cc36 90 IP_NODE, /* Static ip route node. */
9f36abf9
PZ		 91 VRF_NODE, /* VRF mode node. */
92 INTERFACE_NODE, /* Interface mode node. */
93 NH_GROUP_NODE, /* Nexthop-Group mode node. */
94 ZEBRA_NODE, /* zebra connection node. */
95 TABLE_NODE, /* rtm_table selection node. */
96 RIP_NODE, /* RIP protocol mode node. */
97 RIPNG_NODE, /* RIPng protocol mode node. */
98 BABEL_NODE, /* BABEL protocol mode node. */
99 EIGRP_NODE, /* EIGRP protocol mode node. */
100 BGP_NODE, /* BGP protocol mode which includes BGP4+ */
101 BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
102 BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */
103 BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
104 BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
105 BGP_IPV4L_NODE, /* BGP IPv4 labeled unicast address family. */
106 BGP_IPV6_NODE, /* BGP IPv6 address family */
107 BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
108 BGP_IPV6L_NODE, /* BGP IPv6 labeled unicast address family. */
109 BGP_VRF_POLICY_NODE, /* BGP VRF policy */
110 BGP_VNC_DEFAULTS_NODE, /* BGP VNC nve defaults */
111 BGP_VNC_NVE_GROUP_NODE, /* BGP VNC nve group */
112 BGP_VNC_L2_GROUP_NODE, /* BGP VNC L2 group */
113 RFP_DEFAULTS_NODE, /* RFP defaults node */
114 BGP_EVPN_NODE, /* BGP EVPN node. */
9f36abf9
PZ		 115 OSPF_NODE, /* OSPF protocol mode */
116 OSPF6_NODE, /* OSPF protocol for IPv6 mode */
117 LDP_NODE, /* LDP protocol mode */
118 LDP_IPV4_NODE, /* LDP IPv4 address family */
119 LDP_IPV6_NODE, /* LDP IPv6 address family */
120 LDP_IPV4_IFACE_NODE, /* LDP IPv4 Interface */
121 LDP_IPV6_IFACE_NODE, /* LDP IPv6 Interface */
122 LDP_L2VPN_NODE, /* LDP L2VPN node */
123 LDP_PSEUDOWIRE_NODE, /* LDP Pseudowire node */
124 ISIS_NODE, /* ISIS protocol mode */
9f36abf9
PZ		 125 ACCESS_NODE, /* Access list node. */
126 PREFIX_NODE, /* Prefix list node. */
127 ACCESS_IPV6_NODE, /* Access list node. */
128 ACCESS_MAC_NODE, /* MAC access list node*/
129 PREFIX_IPV6_NODE, /* Prefix list node. */
130 AS_LIST_NODE, /* AS list node. */
131 COMMUNITY_LIST_NODE, /* Community list node. */
132 RMAP_NODE, /* Route map node. */
e5c83d9b 133 PBRMAP_NODE, /* PBR map node. */
9f36abf9
PZ		 134 SMUX_NODE, /* SNMP configuration node. */
135 DUMP_NODE, /* Packet dump node. */
136 FORWARDING_NODE, /* IP forwarding node. */
137 PROTOCOL_NODE, /* protocol filtering node */
138 MPLS_NODE, /* MPLS config node */
139 PW_NODE, /* Pseudowire config node */
140 VTY_NODE, /* Vty node. */
141 LINK_PARAMS_NODE, /* Link-parameters node */
142 BGP_EVPN_VNI_NODE, /* BGP EVPN VNI */
996c9314
LB		 143 RPKI_NODE, /* RPKI node for configuration of RPKI cache server
144 connections.*/
7c40bf39 145 BGP_FLOWSPECV4_NODE, /* BGP IPv4 FLOWSPEC Address-Family */
146 BGP_FLOWSPECV6_NODE, /* BGP IPv6 FLOWSPEC Address-Family */
c2f29cf3
RZ		 147 BFD_NODE, /* BFD protocol mode. */
148 BFD_PEER_NODE, /* BFD peer configuration mode. */
7c0cbd0e 149 OPENFABRIC_NODE, /* OpenFabric router configuration node */
996c9314 150 NODE_TYPE_MAX, /* maximum */
718e3744 151};
152
cf6c83e7 153extern vector cmdvec;
26fbe472 154extern const struct message tokennames[];
a83a5331
QY		 155extern const char *node_names[];
156
718e3744 157/* Node which has some commands and prompt string and configuration
158 function pointer . */
d62a17ae 159struct cmd_node {
160 /* Node index. */
161 enum node_type node;
718e3744 162
d62a17ae 163 /* Prompt character at vty interface. */
164 const char *prompt;
718e3744 165
d62a17ae 166 /* Is this node's configuration goes to vtysh ? */
167 int vtysh;
d0bfb22c 168
d62a17ae 169 /* Node's configuration write function */
170 int (*func)(struct vty *);
718e3744 171
d62a17ae 172 /* Node's command graph */
173 struct graph *cmdgraph;
d0bfb22c 174
d62a17ae 175 /* Vector of this node's command list. */
176 vector cmd_vector;
274f29b2 177
d62a17ae 178 /* Hashed index of command node list, for de-dupping primarily */
179 struct hash *cmd_hash;
718e3744 180};
181
718e3744 182/* Return value of the commands. */
183#define CMD_SUCCESS 0
184#define CMD_WARNING 1
185#define CMD_ERR_NO_MATCH 2
186#define CMD_ERR_AMBIGUOUS 3
187#define CMD_ERR_INCOMPLETE 4
188#define CMD_ERR_EXEED_ARGC_MAX 5
189#define CMD_ERR_NOTHING_TODO 6
190#define CMD_COMPLETE_FULL_MATCH 7
191#define CMD_COMPLETE_MATCH 8
192#define CMD_COMPLETE_LIST_MATCH 9
193#define CMD_SUCCESS_DAEMON 10
1db63918 194#define CMD_ERR_NO_FILE 11
95c4aff2 195#define CMD_SUSPEND 12
f1a05de9 196#define CMD_WARNING_CONFIG_FAILED 13
a3d826f0 197#define CMD_NOT_MY_INSTANCE 14
718e3744 198
199/* Argc max counts. */
09f6d019 200#define CMD_ARGC_MAX 256
718e3744 201
202/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c 203#ifndef VTYSH_EXTRACT_PL
718e3744 204
406d6716 205/* helper defines for end-user DEFUN* macros */
d62a17ae 206#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
207 static struct cmd_element cmdname = { \
208 .string = cmdstr, \
209 .func = funcname, \
210 .doc = helpstr, \
211 .attr = attrs, \
212 .daemon = dnum, \
213 .name = #cmdname, \
214 };
215
216#define DEFUN_CMD_FUNC_DECL(funcname) \
217 static int funcname(const struct cmd_element *, struct vty *, int, \
218 struct cmd_token *[]);
219
220#define DEFUN_CMD_FUNC_TEXT(funcname) \
221 static int funcname(const struct cmd_element *self \
222 __attribute__((unused)), \
223 struct vty *vty __attribute__((unused)), \
224 int argc __attribute__((unused)), \
225 struct cmd_token *argv[] __attribute__((unused)))
226
227#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
228 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
229 funcdecl_##funcname
230
26d19c83
RW		 231#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
232 DEFPY(funcname, cmdname, cmdstr, helpstr)
233
e31f4dbe
QY		 234#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
235 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
236 funcdecl_##funcname
237
238#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
239 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
240
d62a17ae 241#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
242 DEFUN_CMD_FUNC_DECL(funcname) \
243 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
244 DEFUN_CMD_FUNC_TEXT(funcname)
245
246#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
247 DEFUN_CMD_FUNC_DECL(funcname) \
248 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
249 DEFUN_CMD_FUNC_TEXT(funcname)
250
251#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
252 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
253
718e3744 254/* DEFUN_NOSH for commands that vtysh should ignore */
d62a17ae 255#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
256 DEFUN(funcname, cmdname, cmdstr, helpstr)
718e3744 257
258/* DEFSH for vtysh. */
d62a17ae 259#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
260 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
718e3744 261
d62a17ae 262#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
263 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
264 daemon)
abaaab4e 265
718e3744 266/* DEFUN + DEFSH */
d62a17ae 267#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
268 DEFUN_CMD_FUNC_DECL(funcname) \
269 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
270 DEFUN_CMD_FUNC_TEXT(funcname)
718e3744 271
274a4a44 272/* DEFUN + DEFSH with attributes */
d62a17ae 273#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
274 DEFUN_CMD_FUNC_DECL(funcname) \
275 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
276 DEFUN_CMD_FUNC_TEXT(funcname)
274a4a44 277
d62a17ae 278#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
279 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
280 CMD_ATTR_HIDDEN)
274a4a44 281
d62a17ae 282#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
283 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
284 CMD_ATTR_DEPRECATED)
274a4a44 285
718e3744 286/* ALIAS macro which define existing command's alias. */
d62a17ae 287#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
288 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
406d6716 289
d62a17ae 290#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
291 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 292
d62a17ae 293#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
294 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
295 0)
406d6716 296
d62a17ae 297#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
298 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
299 CMD_ATTR_DEPRECATED, 0)
718e3744 300
d62a17ae 301#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
302 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
274a4a44 303
d62a17ae 304#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
305 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
306 daemon)
274a4a44 307
d62a17ae 308#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
309 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
310 CMD_ATTR_DEPRECATED, daemon)
274a4a44 311
5578a14d 312#else /* VTYSH_EXTRACT_PL */
d62a17ae 313#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
314 DEFUN(funcname, cmdname, cmdstr, helpstr)
e31f4dbe 315
26d19c83
RW		 316#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
317 DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)
318
e31f4dbe
QY		 319#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
320 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
7f9adc7c
DS		 321
322#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
323 DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)
718e3744 324#endif /* VTYSH_EXTRACT_PL */
325
326/* Some macroes */
ba6d273b
DS		 327
328/*
329 * Sometimes #defines create maximum values that
330 * need to have strings created from them that
331 * allow the parser to match against them.
332 * These macros allow that.
333 */
334#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
335#define CMD_CREATE_STR_HELPER(s) #s
6319fd63 336#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b 337
718e3744 338/* Common descriptions. */
339#define SHOW_STR "Show running system information\n"
340#define IP_STR "IP information\n"
341#define IPV6_STR "IPv6 information\n"
342#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb 343#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 344#define CLEAR_STR "Reset functions\n"
345#define RIP_STR "RIP information\n"
7f57883e 346#define EIGRP_STR "EIGRP information\n"
718e3744 347#define BGP_STR "BGP information\n"
e0bce756
DS		 348#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
349#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
350#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
351#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 352#define OSPF_STR "OSPF information\n"
353#define NEIGHBOR_STR "Specify neighbor router\n"
ef7eec74 354#define DEBUG_STR "Debugging functions\n"
718e3744 355#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
356#define ROUTER_STR "Enable a routing process\n"
357#define AS_STR "AS number\n"
377e3565 358#define MAC_STR "MAC address\n"
718e3744 359#define MBGP_STR "MBGP information\n"
360#define MATCH_STR "Match values from routing table\n"
361#define SET_STR "Set values in destination routing protocol\n"
362#define OUT_STR "Filter outgoing routing updates\n"
363#define IN_STR "Filter incoming routing updates\n"
364#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
365#define OSPF6_NUMBER_STR "Specify by number\n"
0437e105 366#define INTERFACE_STR "Interface information\n"
718e3744 367#define IFNAME_STR "Interface name(e.g. ep0)\n"
368#define IP6_STR "IPv6 Information\n"
369#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c 370#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b 371#define SECONDS_STR "Seconds\n"
718e3744 372#define ROUTE_STR "Routing Table\n"
373#define PREFIX_LIST_STR "Build a prefix list\n"
d62a17ae 374#define OSPF6_DUMP_TYPE_LIST \
375 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
9e867fe6 376#define AREA_TAG_STR "[area tag]\n"
d0bfb22c
QY		 377#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
378#define COMMUNITY_VAL_STR "Community number in AA:NN format (where AA and NN are (0-65535)) or local-AS|no-advertise|no-export|internet or additive\n"
16f1b9ee
OD		 379#define MPLS_TE_STR "MPLS-TE specific commands\n"
380#define LINK_PARAMS_STR "Configure interface link parameters\n"
381#define OSPF_RI_STR "OSPF Router Information specific commands\n"
382#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3 383#define MPLS_STR "MPLS information\n"
cf9b9f77 384#define SR_STR "Segment-Routing specific commands\n"
dff13b6f 385#define WATCHFRR_STR "watchfrr information\n"
41e7fb80 386#define ZEBRA_STR "Zebra information\n"
718e3744 387
093e3f23 388#define CMD_VNI_RANGE "(1-16777215)"
718e3744 389#define CONF_BACKUP_EXT ".sav"
390
4911ca9c
PM		 391/* Command warnings. */
392#define NO_PASSWD_CMD_WARNING \
393 "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
394
718e3744 395/* IPv4 only machine should not accept IPv6 address for peer's IP
396 address. So we replace VTY command string like below. */
718e3744 397#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece
DS		 398#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
399#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 400
401/* Prototypes. */
d62a17ae 402extern void install_node(struct cmd_node *, int (*)(struct vty *));
403extern void install_default(enum node_type);
404extern void install_element(enum node_type, struct cmd_element *);
718e3744 405
de8f7a39
DL		 406/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
407 * deprecated/hidden) are not reversed. */
d62a17ae 408extern void uninstall_element(enum node_type, struct cmd_element *);
de8f7a39 409
f6834d4c 410/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
411 string with a space between each element (allocated using
412 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d62a17ae 413extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
b286ddb0
DS		 414
415/*
416 * It is preferred that you set the index initial value
417 * to a 0. This way in the future if you modify the
418 * cli then there is no need to modify the initial
419 * value of the index
420 */
d62a17ae 421extern int argv_find(struct cmd_token **argv, int argc, const char *text,
422 int *index);
423
424extern vector cmd_make_strvec(const char *);
425extern void cmd_free_strvec(vector);
426extern vector cmd_describe_command(vector, struct vty *, int *status);
427extern char **cmd_complete_command(vector, struct vty *, int *status);
428extern const char *cmd_prompt(enum node_type);
429extern int command_config_read_one_line(struct vty *vty,
430 const struct cmd_element **,
7ab57d19 431 uint32_t line_num, int use_config_node);
d62a17ae 432extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
433extern enum node_type node_parent(enum node_type);
01e24c4a
QY		 434/*
435 * Execute command under the given vty context.
436 *
437 * vty
438 * The vty context to execute under.
439 *
440 * cmd
441 * The command string to execute.
442 *
443 * matched
444 * If non-null and a match was found, the address of the matched command is
445 * stored here. No action otherwise.
446 *
447 * vtysh
448 * Whether or not this is being called from vtysh. If this is nonzero,
449 * XXX: then what?
450 *
451 * Returns:
452 * XXX: what does it return
453 */
454extern int cmd_execute(struct vty *vty, const char *cmd,
455 const struct cmd_element **matched, int vtysh);
d62a17ae 456extern int cmd_execute_command(vector, struct vty *,
457 const struct cmd_element **, int);
458extern int cmd_execute_command_strict(vector, struct vty *,
459 const struct cmd_element **);
460extern void cmd_init(int);
461extern void cmd_terminate(void);
462extern void cmd_exit(struct vty *vty);
463extern int cmd_list_cmds(struct vty *vty, int do_permute);
464
6b3ee3a0 465extern int cmd_domainname_set(const char *domainname);
d62a17ae 466extern int cmd_hostname_set(const char *hostname);
6b3ee3a0
MK		 467extern const char *cmd_hostname_get(void);
468extern const char *cmd_domainname_get(void);
bff9c3e9 469
af2567b6 470/* NOT safe for general use; call this only if DEV_BUILD! */
d62a17ae 471extern void grammar_sandbox_init(void);
af2567b6 472
d62a17ae 473extern vector completions_to_vec(struct list *completions);
2ab40270 474
718e3744 475/* Export typical functions. */
d62a17ae 476extern const char *host_config_get(void);
477extern void host_config_set(const char *);
6590f2c3 478
d62a17ae 479extern void print_version(const char *);
86228fde 480
d62a17ae 481extern int cmd_banner_motd_file(const char *);
7cfc61d3 482
86228fde 483/* struct host global, ick */
d0bfb22c
QY		 484extern struct host host;
485
70d44c5c 486struct cmd_variable_handler {
d62a17ae 487 const char *tokenname, *varname;
488 void (*completions)(vector out, struct cmd_token *token);
70d44c5c
DL		 489};
490
d62a17ae 491extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
492 vector comps);
493extern void
494cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
495extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
228da428 496
e9b4e74a 497extern void command_setup_early_logging(const char *dest, const char *level);
5e244469
RW		 498
499#ifdef __cplusplus
500}
501#endif
502
718e3744 503#endif /* _ZEBRA_COMMAND_H */
FRRouting mirror