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