]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.h
lib: Initialize variable
[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.
11 *
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 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Zebra; see the file COPYING. If not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
21 */
22
23#ifndef _ZEBRA_COMMAND_H
24#define _ZEBRA_COMMAND_H
25
26#include "vector.h"
27#include "vty.h"
9c42a6eb 28#include "lib/route_types.h"
718e3744 29
30/* Host configuration variable */
31struct host
32{
33 /* Host name of this router. */
34 char *name;
35
36 /* Password for vty interface. */
37 char *password;
38 char *password_encrypt;
39
40 /* Enable password */
41 char *enable;
42 char *enable_encrypt;
43
44 /* System wide terminal lines. */
45 int lines;
46
47 /* Log filename. */
48 char *logfile;
49
718e3744 50 /* config file name of this host */
51 char *config;
52
53 /* Flags for services */
54 int advanced;
55 int encrypt;
56
57 /* Banner configuration. */
8c328f11 58 const char *motd;
3b0c5d9a 59 char *motdfile;
718e3744 60};
61
62/* There are some command levels which called from command node. */
63enum node_type
64{
65 AUTH_NODE, /* Authentication mode of vty interface. */
62687ff1 66 RESTRICTED_NODE, /* Restricted view mode */
718e3744 67 VIEW_NODE, /* View node. Default mode of vty interface. */
68 AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
69 ENABLE_NODE, /* Enable node. */
70 CONFIG_NODE, /* Config node. Default mode of config file. */
e7168df4 71 SERVICE_NODE, /* Service node. */
718e3744 72 DEBUG_NODE, /* Debug node. */
19dc275e 73 VRF_DEBUG_NODE, /* Vrf Debug node. */
718e3744 74 AAA_NODE, /* AAA node. */
75 KEYCHAIN_NODE, /* Key-chain node. */
76 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
77 INTERFACE_NODE, /* Interface mode node. */
f93e3f69 78 VRF_NODE, /* VRF mode node. */
718e3744 79 ZEBRA_NODE, /* zebra connection node. */
80 TABLE_NODE, /* rtm_table selection node. */
81 RIP_NODE, /* RIP protocol mode node. */
82 RIPNG_NODE, /* RIPng protocol mode node. */
83 BGP_NODE, /* BGP protocol mode which includes BGP4+ */
84 BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
85 BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
86 BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
87 BGP_IPV6_NODE, /* BGP IPv6 address family */
1e836590 88 BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
718e3744 89 OSPF_NODE, /* OSPF protocol mode */
90 OSPF6_NODE, /* OSPF protocol for IPv6 mode */
9e867fe6 91 ISIS_NODE, /* ISIS protocol mode */
718e3744 92 MASC_NODE, /* MASC for multicast. */
93 IRDP_NODE, /* ICMP Router Discovery Protocol mode. */
94 IP_NODE, /* Static ip route node. */
95 ACCESS_NODE, /* Access list node. */
96 PREFIX_NODE, /* Prefix list node. */
97 ACCESS_IPV6_NODE, /* Access list node. */
98 PREFIX_IPV6_NODE, /* Prefix list node. */
99 AS_LIST_NODE, /* AS list node. */
100 COMMUNITY_LIST_NODE, /* Community list node. */
101 RMAP_NODE, /* Route map node. */
102 SMUX_NODE, /* SNMP configuration node. */
103 DUMP_NODE, /* Packet dump node. */
104 FORWARDING_NODE, /* IP forwarding node. */
7514fb77 105 PROTOCOL_NODE, /* protocol filtering node */
62687ff1 106 VTY_NODE, /* Vty node. */
718e3744 107};
108
109/* Node which has some commands and prompt string and configuration
110 function pointer . */
111struct cmd_node
112{
113 /* Node index. */
114 enum node_type node;
115
116 /* Prompt character at vty interface. */
8c328f11 117 const char *prompt;
718e3744 118
119 /* Is this node's configuration goes to vtysh ? */
120 int vtysh;
121
122 /* Node's configuration write function */
123 int (*func) (struct vty *);
124
125 /* Vector of this node's command list. */
126 vector cmd_vector;
127};
128
406d6716 129enum
130{
9c5d8562 131 CMD_ATTR_DEPRECATED = 1,
406d6716 132 CMD_ATTR_HIDDEN,
133};
134
718e3744 135/* Structure of command element. */
136struct cmd_element
137{
8c328f11 138 const char *string; /* Command specification by string. */
9035efaa 139 int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
8c328f11 140 const char *doc; /* Documentation of this command. */
718e3744 141 int daemon; /* Daemon to which this command belong. */
cd40b329 142 vector tokens; /* Vector of cmd_tokens */
406d6716 143 u_char attr; /* Command attributes */
718e3744 144};
145
cd40b329
CF
146
147enum cmd_token_type
148{
149 TOKEN_TERMINAL = 0,
150 TOKEN_MULTIPLE,
151 TOKEN_KEYWORD,
152};
153
718e3744 154/* Command description structure. */
cd40b329 155struct cmd_token
718e3744 156{
cd40b329
CF
157 enum cmd_token_type type;
158
159 /* Used for type == MULTIPLE */
160 vector multiple; /* vector of cmd_token, type == FINAL */
161
162 /* Used for type == KEYWORD */
163 vector keyword; /* vector of vector of cmd_tokens */
164
165 /* Used for type == TERMINAL */
228da428 166 char *cmd; /* Command string. */
cd40b329 167 char *desc; /* Command's description. */
718e3744 168};
169
170/* Return value of the commands. */
171#define CMD_SUCCESS 0
172#define CMD_WARNING 1
173#define CMD_ERR_NO_MATCH 2
174#define CMD_ERR_AMBIGUOUS 3
175#define CMD_ERR_INCOMPLETE 4
176#define CMD_ERR_EXEED_ARGC_MAX 5
177#define CMD_ERR_NOTHING_TODO 6
178#define CMD_COMPLETE_FULL_MATCH 7
179#define CMD_COMPLETE_MATCH 8
180#define CMD_COMPLETE_LIST_MATCH 9
181#define CMD_SUCCESS_DAEMON 10
182
183/* Argc max counts. */
184#define CMD_ARGC_MAX 25
185
186/* Turn off these macros when uisng cpp with extract.pl */
187#ifndef VTYSH_EXTRACT_PL
188
406d6716 189/* helper defines for end-user DEFUN* macros */
190#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
718e3744 191 struct cmd_element cmdname = \
192 { \
9035efaa 193 .string = cmdstr, \
194 .func = funcname, \
406d6716 195 .doc = helpstr, \
196 .attr = attrs, \
197 .daemon = dnum, \
198 };
199
200#define DEFUN_CMD_FUNC_DECL(funcname) \
34204aac 201 static int funcname (struct cmd_element *, struct vty *, int, const char *[]);
406d6716 202
203#define DEFUN_CMD_FUNC_TEXT(funcname) \
274a4a44 204 static int funcname \
6cf0cf0c
PJ
205 (struct cmd_element *self __attribute__ ((unused)), \
206 struct vty *vty __attribute__ ((unused)), \
207 int argc __attribute__ ((unused)), \
208 const char *argv[] __attribute__ ((unused)) )
406d6716 209
cd40b329
CF
210/* DEFUN for vty command interafce. Little bit hacky ;-).
211 *
212 * DEFUN(funcname, cmdname, cmdstr, helpstr)
213 *
214 * funcname
215 * ========
216 *
217 * Name of the function that will be defined.
218 *
219 * cmdname
220 * =======
221 *
222 * Name of the struct that will be defined for the command.
223 *
224 * cmdstr
225 * ======
226 *
227 * The cmdstr defines the command syntax. It is used by the vty subsystem
228 * and vtysh to perform matching and completion in the cli. So you have to take
229 * care to construct it adhering to the following grammar. The names used
230 * for the production rules losely represent the names used in lib/command.c
231 *
232 * cmdstr = cmd_token , { " " , cmd_token } ;
233 *
234 * cmd_token = cmd_terminal
235 * | cmd_multiple
236 * | cmd_keyword ;
237 *
238 * cmd_terminal_fixed = fixed_string
239 * | variable
240 * | range
241 * | ipv4
242 * | ipv4_prefix
243 * | ipv6
244 * | ipv6_prefix ;
245 *
246 * cmd_terminal = cmd_terminal_fixed
247 * | option
248 * | vararg ;
249 *
250 * multiple_part = cmd_terminal_fixed ;
251 * cmd_multiple = "(" , multiple_part , ( "|" | { "|" , multiple_part } ) , ")" ;
252 *
253 * keyword_part = fixed_string , { " " , ( cmd_terminal_fixed | cmd_multiple ) } ;
254 * cmd_keyword = "{" , keyword_part , { "|" , keyword_part } , "}" ;
255 *
256 * lowercase = "a" | ... | "z" ;
257 * uppercase = "A" | ... | "Z" ;
258 * digit = "0" | ... | "9" ;
259 * number = digit , { digit } ;
260 *
261 * fixed_string = (lowercase | digit) , { lowercase | digit | uppercase | "-" | "_" } ;
262 * variable = uppercase , { uppercase | "_" } ;
263 * range = "<" , number , "-" , number , ">" ;
264 * ipv4 = "A.B.C.D" ;
265 * ipv4_prefix = "A.B.C.D/M" ;
266 * ipv6 = "X:X::X:X" ;
267 * ipv6_prefix = "X:X::X:X/M" ;
268 * option = "[" , variable , "]" ;
269 * vararg = "." , variable ;
270 *
271 * To put that all in a textual description: A cmdstr is a sequence of tokens,
272 * separated by spaces.
273 *
274 * Terminal Tokens:
275 *
276 * A very simple cmdstring would be something like: "show ip bgp". It consists
277 * of three Terminal Tokens, each containing a fixed string. When this command
278 * is called, no arguments will be passed down to the function implementing it,
279 * as it only consists of fixed strings.
280 *
281 * Apart from fixed strings, Terminal Tokens can also contain variables:
282 * An example would be "show ip bgp A.B.C.D". This command expects an IPv4
283 * as argument. As this is a variable, the IP address entered by the user will
284 * be passed down as an argument. Apart from two exceptions, the other options
285 * for Terminal Tokens behave exactly as we just discussed and only make a
286 * difference for the CLI. The two exceptions will be discussed in the next
287 * paragraphs.
288 *
289 * A Terminal Token can contain a so called option match. This is a simple
290 * string variable that the user may omit. An example would be:
291 * "show interface [IFNAME]". If the user calls this without an interface as
292 * argument, no arguments will be passed down to the function implementing
293 * this command. Otherwise, the interface name will be provided to the function
294 * as a regular argument.
295
296 * Also, a Terminal Token can contain a so called vararg. This is used e.g. in
297 * "show ip bgp regexp .LINE". The last token is a vararg match and will
298 * consume all the arguments the user inputs on the command line and append
299 * those to the list of arguments passed down to the function implementing this
300 * command. (Therefore, it doesn't make much sense to have any tokens after a
301 * vararg because the vararg will already consume all the words the user entered
302 * in the CLI)
303 *
304 * Multiple Tokens:
305 *
306 * The Multiple Token type can be used if there are multiple possibilities what
307 * arguments may be used for a command, but it should map to the same function
308 * nonetheless. An example would be "ip route A.B.C.D/M (reject|blackhole)"
309 * In that case both "reject" and "blackhole" would be acceptable as last
310 * arguments. The words matched by Multiple Tokens are always added to the
311 * argument list, even if they are matched by fixed strings. Such a Multiple
312 * Token can contain almost any type of token that would also be acceptable
313 * for a Terminal Token, the exception are optional variables and varag.
314 *
315 * There is one special case that is used in some places of Quagga that should be
316 * pointed out here shortly. An example would be "password (8|) WORD". This
317 * construct is used to have fixed strings communicated as arguments. (The "8"
318 * will be passed down as an argument in this case) It does not mean that
319 * the "8" is optional. Another historic and possibly surprising property of
320 * this construct is that it consumes two parts of helpstr. (Help
321 * strings will be explained later)
322 *
323 * Keyword Tokens:
324 *
325 * There are commands that take a lot of different and possibly optional arguments.
326 * An example from ospf would be the "default-information originate" command. This
327 * command takes a lot of optional arguments that may be provided in any order.
328 * To accomodate such commands, the Keyword Token has been implemented.
329 * Using the keyword token, the "default-information originate" command and all
330 * its possible options can be represented using this single cmdstr:
331 * "default-information originate \
332 * {always|metric <0-16777214>|metric-type (1|2)|route-map WORD}"
333 *
334 * Keywords always start with a fixed string and may be followed by arguments.
335 * Except optional variables and vararg, everything is permitted here.
336 *
337 * For the special case of a keyword without arguments, either NULL or the
338 * keyword itself will be pushed as an argument, depending on whether the
339 * keyword is present.
340 * For the other keywords, arguments will be only pushed for
341 * variables/Multiple Tokens. If the keyword is not present, the arguments that
342 * would have been pushed will be substituted by NULL.
343 *
344 * A few examples:
345 * "default information originate metric-type 1 metric 1000"
346 * would yield the following arguments:
347 * { NULL, "1000", "1", NULL }
348 *
349 * "default information originate always route-map RMAP-DEFAULT"
350 * would yield the following arguments:
351 * { "always", NULL, NULL, "RMAP-DEFAULT" }
352 *
353 * helpstr
354 * =======
355 *
356 * The helpstr is used to show a short explantion for the commands that
357 * are available when the user presses '?' on the CLI. It is the concatenation
358 * of the helpstrings for all the tokens that make up the command.
359 *
360 * There should be one helpstring for each token in the cmdstr except those
361 * containing other tokens, like Multiple or Keyword Tokens. For those, there
362 * will only be the helpstrings of the contained tokens.
363 *
364 * The individual helpstrings are expected to be in the same order as their
365 * respective Tokens appear in the cmdstr. They should each be terminated with
366 * a linefeed. The last helpstring should be terminated with a linefeed as well.
367 *
368 * Care should also be taken to avoid having similar tokens with different
369 * helpstrings. Imagine e.g. the commands "show ip ospf" and "show ip bgp".
370 * they both contain a helpstring for "show", but only one will be displayed
371 * when the user enters "sh?". If those two helpstrings differ, it is not
372 * defined which one will be shown and the behavior is therefore unpredictable.
373 */
406d6716 374#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
375 DEFUN_CMD_FUNC_DECL(funcname) \
376 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
377 DEFUN_CMD_FUNC_TEXT(funcname)
378
379#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
380 DEFUN_CMD_FUNC_DECL(funcname) \
381 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
382 DEFUN_CMD_FUNC_TEXT(funcname)
383
384#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
385 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
386
387#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
2557aed1 388 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
718e3744 389
390/* DEFUN_NOSH for commands that vtysh should ignore */
391#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
392 DEFUN(funcname, cmdname, cmdstr, helpstr)
393
394/* DEFSH for vtysh. */
395#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
406d6716 396 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
718e3744 397
abaaab4e
DW
398#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
399 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
400
718e3744 401/* DEFUN + DEFSH */
402#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
406d6716 403 DEFUN_CMD_FUNC_DECL(funcname) \
404 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
405 DEFUN_CMD_FUNC_TEXT(funcname)
718e3744 406
274a4a44 407/* DEFUN + DEFSH with attributes */
408#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
409 DEFUN_CMD_FUNC_DECL(funcname) \
410 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
411 DEFUN_CMD_FUNC_TEXT(funcname)
412
413#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
414 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
415
416#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
417 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
418
718e3744 419/* ALIAS macro which define existing command's alias. */
420#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
406d6716 421 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
422
423#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
274a4a44 424 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 425
426#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
427 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
428
429#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
430 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
718e3744 431
274a4a44 432#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
433 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
434
435#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
436 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
437
438#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
439 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
440
718e3744 441#endif /* VTYSH_EXTRACT_PL */
442
443/* Some macroes */
ba6d273b
DS
444
445/*
446 * Sometimes #defines create maximum values that
447 * need to have strings created from them that
448 * allow the parser to match against them.
449 * These macros allow that.
450 */
451#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
452#define CMD_CREATE_STR_HELPER(s) #s
453#define CMD_RANGE_STR(a,s) "<" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ">"
454
718e3744 455#define CMD_OPTION(S) ((S[0]) == '[')
456#define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
457#define CMD_VARARG(S) ((S[0]) == '.')
458#define CMD_RANGE(S) ((S[0] == '<'))
459
460#define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
461#define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
462#define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
463#define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
464
465/* Common descriptions. */
466#define SHOW_STR "Show running system information\n"
467#define IP_STR "IP information\n"
468#define IPV6_STR "IPv6 information\n"
469#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb 470#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 471#define CLEAR_STR "Reset functions\n"
472#define RIP_STR "RIP information\n"
473#define BGP_STR "BGP information\n"
e0bce756
DS
474#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
475#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
476#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
477#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 478#define OSPF_STR "OSPF information\n"
479#define NEIGHBOR_STR "Specify neighbor router\n"
480#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
481#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
482#define ROUTER_STR "Enable a routing process\n"
483#define AS_STR "AS number\n"
484#define MBGP_STR "MBGP information\n"
485#define MATCH_STR "Match values from routing table\n"
486#define SET_STR "Set values in destination routing protocol\n"
487#define OUT_STR "Filter outgoing routing updates\n"
488#define IN_STR "Filter incoming routing updates\n"
489#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
490#define OSPF6_NUMBER_STR "Specify by number\n"
491#define INTERFACE_STR "Interface infomation\n"
492#define IFNAME_STR "Interface name(e.g. ep0)\n"
493#define IP6_STR "IPv6 Information\n"
494#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
495#define OSPF6_ROUTER_STR "Enable a routing process\n"
496#define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
497#define SECONDS_STR "<1-65535> Seconds\n"
498#define ROUTE_STR "Routing Table\n"
499#define PREFIX_LIST_STR "Build a prefix list\n"
500#define OSPF6_DUMP_TYPE_LIST \
501"(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
9e867fe6 502#define ISIS_STR "IS-IS information\n"
503#define AREA_TAG_STR "[area tag]\n"
718e3744 504
505#define CONF_BACKUP_EXT ".sav"
506
507/* IPv4 only machine should not accept IPv6 address for peer's IP
508 address. So we replace VTY command string like below. */
509#ifdef HAVE_IPV6
510#define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
511#define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
512#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
513#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
514#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
a80beece
DS
515#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
516#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 517#else
518#define NEIGHBOR_CMD "neighbor A.B.C.D "
519#define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
520#define NEIGHBOR_ADDR_STR "Neighbor address\n"
521#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
522#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
523#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
524#endif /* HAVE_IPV6 */
525
f14e6fdb
DS
526/* Dynamic neighbor (listen range) configuration */
527#ifdef HAVE_IPV6
528#define LISTEN_RANGE_CMD "bgp listen range (A.B.C.D/M|X:X::X:X/M) "
529#define LISTEN_RANGE_ADDR_STR "Neighbor address\nNeighbor IPv6 address\n"
530#else
531#define LISTEN_RANGE_CMD "bgp listen range A.B.C.D/M "
532#define LISTEN_RANGE_ADDR_STR "Neighbor address\n"
533#endif /* HAVE_IPV6 */
534
718e3744 535/* Prototypes. */
8cc4198f 536extern void install_node (struct cmd_node *, int (*) (struct vty *));
537extern void install_default (enum node_type);
538extern void install_element (enum node_type, struct cmd_element *);
718e3744 539
f6834d4c 540/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
541 string with a space between each element (allocated using
542 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
8cc4198f 543extern char *argv_concat (const char **argv, int argc, int shift);
544
545extern vector cmd_make_strvec (const char *);
546extern void cmd_free_strvec (vector);
547extern vector cmd_describe_command (vector, struct vty *, int *status);
548extern char **cmd_complete_command (vector, struct vty *, int *status);
549extern const char *cmd_prompt (enum node_type);
bed578b8 550extern int command_config_read_one_line (struct vty *vty, struct cmd_element **, int use_config_node);
13fbc82d 551extern int config_from_file (struct vty *, FILE *, unsigned int *line_num);
8cc4198f 552extern enum node_type node_parent (enum node_type);
553extern int cmd_execute_command (vector, struct vty *, struct cmd_element **, int);
554extern int cmd_execute_command_strict (vector, struct vty *, struct cmd_element **);
8cc4198f 555extern void cmd_init (int);
228da428 556extern void cmd_terminate (void);
718e3744 557
558/* Export typical functions. */
559extern struct cmd_element config_end_cmd;
560extern struct cmd_element config_exit_cmd;
561extern struct cmd_element config_quit_cmd;
562extern struct cmd_element config_help_cmd;
563extern struct cmd_element config_list_cmd;
8cc4198f 564extern char *host_config_file (void);
c0e8c16f 565extern void host_config_set (const char *);
6590f2c3 566
8cc4198f 567extern void print_version (const char *);
86228fde 568
7cfc61d3
DS
569extern int cmd_banner_motd_file (const char *);
570
86228fde
PJ
571/* struct host global, ick */
572extern struct host host;
228da428
CC
573
574/* "<cr>" global */
575extern char *command_cr;
718e3744 576#endif /* _ZEBRA_COMMAND_H */