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