]> 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
Merge pull request #4413 from donaldsharp/bgp_distance_comes_closer
[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 */
f828842a 150 VRRP_NODE, /* VRRP node */
996c9314 151 NODE_TYPE_MAX, /* maximum */
718e3744 152};
153
cf6c83e7 154extern vector cmdvec;
26fbe472 155extern const struct message tokennames[];
a83a5331
QY		 156extern const char *node_names[];
157
718e3744 158/* Node which has some commands and prompt string and configuration
159 function pointer . */
d62a17ae 160struct cmd_node {
161 /* Node index. */
162 enum node_type node;
718e3744 163
d62a17ae 164 /* Prompt character at vty interface. */
165 const char *prompt;
718e3744 166
d62a17ae 167 /* Is this node's configuration goes to vtysh ? */
168 int vtysh;
d0bfb22c 169
d62a17ae 170 /* Node's configuration write function */
171 int (*func)(struct vty *);
718e3744 172
d62a17ae 173 /* Node's command graph */
174 struct graph *cmdgraph;
d0bfb22c 175
d62a17ae 176 /* Vector of this node's command list. */
177 vector cmd_vector;
274f29b2 178
d62a17ae 179 /* Hashed index of command node list, for de-dupping primarily */
180 struct hash *cmd_hash;
718e3744 181};
182
718e3744 183/* Return value of the commands. */
184#define CMD_SUCCESS 0
185#define CMD_WARNING 1
186#define CMD_ERR_NO_MATCH 2
187#define CMD_ERR_AMBIGUOUS 3
188#define CMD_ERR_INCOMPLETE 4
189#define CMD_ERR_EXEED_ARGC_MAX 5
190#define CMD_ERR_NOTHING_TODO 6
191#define CMD_COMPLETE_FULL_MATCH 7
192#define CMD_COMPLETE_MATCH 8
193#define CMD_COMPLETE_LIST_MATCH 9
194#define CMD_SUCCESS_DAEMON 10
1db63918 195#define CMD_ERR_NO_FILE 11
95c4aff2 196#define CMD_SUSPEND 12
f1a05de9 197#define CMD_WARNING_CONFIG_FAILED 13
a3d826f0 198#define CMD_NOT_MY_INSTANCE 14
718e3744 199
200/* Argc max counts. */
09f6d019 201#define CMD_ARGC_MAX 256
718e3744 202
203/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c 204#ifndef VTYSH_EXTRACT_PL
718e3744 205
406d6716 206/* helper defines for end-user DEFUN* macros */
d62a17ae 207#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
208 static struct cmd_element cmdname = { \
209 .string = cmdstr, \
210 .func = funcname, \
211 .doc = helpstr, \
212 .attr = attrs, \
213 .daemon = dnum, \
214 .name = #cmdname, \
215 };
216
217#define DEFUN_CMD_FUNC_DECL(funcname) \
218 static int funcname(const struct cmd_element *, struct vty *, int, \
219 struct cmd_token *[]);
220
221#define DEFUN_CMD_FUNC_TEXT(funcname) \
222 static int funcname(const struct cmd_element *self \
223 __attribute__((unused)), \
224 struct vty *vty __attribute__((unused)), \
225 int argc __attribute__((unused)), \
226 struct cmd_token *argv[] __attribute__((unused)))
227
228#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
229 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
230 funcdecl_##funcname
231
26d19c83
RW		 232#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
233 DEFPY(funcname, cmdname, cmdstr, helpstr)
234
e31f4dbe
QY		 235#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
236 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
237 funcdecl_##funcname
238
239#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
240 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
241
d62a17ae 242#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
243 DEFUN_CMD_FUNC_DECL(funcname) \
244 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
245 DEFUN_CMD_FUNC_TEXT(funcname)
246
247#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
248 DEFUN_CMD_FUNC_DECL(funcname) \
249 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
250 DEFUN_CMD_FUNC_TEXT(funcname)
251
252#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
253 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
254
718e3744 255/* DEFUN_NOSH for commands that vtysh should ignore */
d62a17ae 256#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
257 DEFUN(funcname, cmdname, cmdstr, helpstr)
718e3744 258
259/* DEFSH for vtysh. */
d62a17ae 260#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
261 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
718e3744 262
d62a17ae 263#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
264 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
265 daemon)
abaaab4e 266
718e3744 267/* DEFUN + DEFSH */
d62a17ae 268#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
269 DEFUN_CMD_FUNC_DECL(funcname) \
270 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
271 DEFUN_CMD_FUNC_TEXT(funcname)
718e3744 272
274a4a44 273/* DEFUN + DEFSH with attributes */
d62a17ae 274#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
275 DEFUN_CMD_FUNC_DECL(funcname) \
276 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
277 DEFUN_CMD_FUNC_TEXT(funcname)
274a4a44 278
d62a17ae 279#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
280 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
281 CMD_ATTR_HIDDEN)
274a4a44 282
d62a17ae 283#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
284 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
285 CMD_ATTR_DEPRECATED)
274a4a44 286
718e3744 287/* ALIAS macro which define existing command's alias. */
d62a17ae 288#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
289 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
406d6716 290
d62a17ae 291#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
292 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 293
d62a17ae 294#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
295 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
296 0)
406d6716 297
d62a17ae 298#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
299 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
300 CMD_ATTR_DEPRECATED, 0)
718e3744 301
d62a17ae 302#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
303 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
274a4a44 304
d62a17ae 305#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
306 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
307 daemon)
274a4a44 308
d62a17ae 309#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
310 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
311 CMD_ATTR_DEPRECATED, daemon)
274a4a44 312
5578a14d 313#else /* VTYSH_EXTRACT_PL */
d62a17ae 314#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
315 DEFUN(funcname, cmdname, cmdstr, helpstr)
e31f4dbe 316
26d19c83
RW		 317#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
318 DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)
319
e31f4dbe
QY		 320#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
321 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
7f9adc7c
DS		 322
323#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
324 DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)
718e3744 325#endif /* VTYSH_EXTRACT_PL */
326
327/* Some macroes */
ba6d273b
DS		 328
329/*
330 * Sometimes #defines create maximum values that
331 * need to have strings created from them that
332 * allow the parser to match against them.
333 * These macros allow that.
334 */
335#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
336#define CMD_CREATE_STR_HELPER(s) #s
6319fd63 337#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b 338
718e3744 339/* Common descriptions. */
340#define SHOW_STR "Show running system information\n"
341#define IP_STR "IP information\n"
342#define IPV6_STR "IPv6 information\n"
343#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb 344#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 345#define CLEAR_STR "Reset functions\n"
346#define RIP_STR "RIP information\n"
7f57883e 347#define EIGRP_STR "EIGRP information\n"
718e3744 348#define BGP_STR "BGP information\n"
e0bce756
DS		 349#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
350#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
351#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
352#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 353#define OSPF_STR "OSPF information\n"
354#define NEIGHBOR_STR "Specify neighbor router\n"
ef7eec74 355#define DEBUG_STR "Debugging functions\n"
718e3744 356#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
357#define ROUTER_STR "Enable a routing process\n"
358#define AS_STR "AS number\n"
377e3565 359#define MAC_STR "MAC address\n"
718e3744 360#define MBGP_STR "MBGP information\n"
361#define MATCH_STR "Match values from routing table\n"
362#define SET_STR "Set values in destination routing protocol\n"
363#define OUT_STR "Filter outgoing routing updates\n"
364#define IN_STR "Filter incoming routing updates\n"
365#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
366#define OSPF6_NUMBER_STR "Specify by number\n"
0437e105 367#define INTERFACE_STR "Interface information\n"
718e3744 368#define IFNAME_STR "Interface name(e.g. ep0)\n"
369#define IP6_STR "IPv6 Information\n"
370#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c 371#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b 372#define SECONDS_STR "Seconds\n"
718e3744 373#define ROUTE_STR "Routing Table\n"
374#define PREFIX_LIST_STR "Build a prefix list\n"
d62a17ae 375#define OSPF6_DUMP_TYPE_LIST \
376 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
9e867fe6 377#define AREA_TAG_STR "[area tag]\n"
d0bfb22c
QY		 378#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
379#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		 380#define MPLS_TE_STR "MPLS-TE specific commands\n"
381#define LINK_PARAMS_STR "Configure interface link parameters\n"
382#define OSPF_RI_STR "OSPF Router Information specific commands\n"
383#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3 384#define MPLS_STR "MPLS information\n"
cf9b9f77 385#define SR_STR "Segment-Routing specific commands\n"
dff13b6f 386#define WATCHFRR_STR "watchfrr information\n"
41e7fb80 387#define ZEBRA_STR "Zebra information\n"
718e3744 388
093e3f23 389#define CMD_VNI_RANGE "(1-16777215)"
718e3744 390#define CONF_BACKUP_EXT ".sav"
391
4911ca9c
PM		 392/* Command warnings. */
393#define NO_PASSWD_CMD_WARNING \
394 "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
395
718e3744 396/* IPv4 only machine should not accept IPv6 address for peer's IP
397 address. So we replace VTY command string like below. */
718e3744 398#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece
DS		 399#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
400#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 401
402/* Prototypes. */
d62a17ae 403extern void install_node(struct cmd_node *, int (*)(struct vty *));
404extern void install_default(enum node_type);
405extern void install_element(enum node_type, struct cmd_element *);
718e3744 406
de8f7a39
DL		 407/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
408 * deprecated/hidden) are not reversed. */
d62a17ae 409extern void uninstall_element(enum node_type, struct cmd_element *);
de8f7a39 410
f6834d4c 411/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
412 string with a space between each element (allocated using
413 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d62a17ae 414extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
b286ddb0
DS		 415
416/*
417 * It is preferred that you set the index initial value
418 * to a 0. This way in the future if you modify the
419 * cli then there is no need to modify the initial
420 * value of the index
421 */
d62a17ae 422extern int argv_find(struct cmd_token **argv, int argc, const char *text,
423 int *index);
424
425extern vector cmd_make_strvec(const char *);
426extern void cmd_free_strvec(vector);
427extern vector cmd_describe_command(vector, struct vty *, int *status);
428extern char **cmd_complete_command(vector, struct vty *, int *status);
429extern const char *cmd_prompt(enum node_type);
430extern int command_config_read_one_line(struct vty *vty,
431 const struct cmd_element **,
7ab57d19 432 uint32_t line_num, int use_config_node);
d62a17ae 433extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
434extern enum node_type node_parent(enum node_type);
01e24c4a
QY		 435/*
436 * Execute command under the given vty context.
437 *
438 * vty
439 * The vty context to execute under.
440 *
441 * cmd
442 * The command string to execute.
443 *
444 * matched
445 * If non-null and a match was found, the address of the matched command is
446 * stored here. No action otherwise.
447 *
448 * vtysh
449 * Whether or not this is being called from vtysh. If this is nonzero,
450 * XXX: then what?
451 *
452 * Returns:
453 * XXX: what does it return
454 */
455extern int cmd_execute(struct vty *vty, const char *cmd,
456 const struct cmd_element **matched, int vtysh);
d62a17ae 457extern int cmd_execute_command(vector, struct vty *,
458 const struct cmd_element **, int);
459extern int cmd_execute_command_strict(vector, struct vty *,
460 const struct cmd_element **);
461extern void cmd_init(int);
462extern void cmd_terminate(void);
463extern void cmd_exit(struct vty *vty);
464extern int cmd_list_cmds(struct vty *vty, int do_permute);
465
6b3ee3a0 466extern int cmd_domainname_set(const char *domainname);
d62a17ae 467extern int cmd_hostname_set(const char *hostname);
6b3ee3a0
MK		 468extern const char *cmd_hostname_get(void);
469extern const char *cmd_domainname_get(void);
bff9c3e9 470
af2567b6 471/* NOT safe for general use; call this only if DEV_BUILD! */
d62a17ae 472extern void grammar_sandbox_init(void);
af2567b6 473
d62a17ae 474extern vector completions_to_vec(struct list *completions);
2ab40270 475
718e3744 476/* Export typical functions. */
d62a17ae 477extern const char *host_config_get(void);
478extern void host_config_set(const char *);
6590f2c3 479
d62a17ae 480extern void print_version(const char *);
86228fde 481
d62a17ae 482extern int cmd_banner_motd_file(const char *);
7cfc61d3 483
86228fde 484/* struct host global, ick */
d0bfb22c
QY		 485extern struct host host;
486
70d44c5c 487struct cmd_variable_handler {
d62a17ae 488 const char *tokenname, *varname;
489 void (*completions)(vector out, struct cmd_token *token);
70d44c5c
DL		 490};
491
d62a17ae 492extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
493 vector comps);
494extern void
495cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
496extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
228da428 497
e9b4e74a 498extern void command_setup_early_logging(const char *dest, const char *level);
5e244469
RW		 499
500#ifdef __cplusplus
501}
502#endif
503
718e3744 504#endif /* _ZEBRA_COMMAND_H */
FRRouting mirror