]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.h
zebra: Fix show vrf and show run to use the zvrf_list
[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
1db63918 182#define CMD_ERR_NO_FILE 11
718e3744 183
184/* Argc max counts. */
185#define CMD_ARGC_MAX 25
186
187/* Turn off these macros when uisng cpp with extract.pl */
188#ifndef VTYSH_EXTRACT_PL
189
406d6716 190/* helper defines for end-user DEFUN* macros */
191#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
718e3744 192 struct cmd_element cmdname = \
193 { \
9035efaa 194 .string = cmdstr, \
195 .func = funcname, \
406d6716 196 .doc = helpstr, \
197 .attr = attrs, \
198 .daemon = dnum, \
199 };
200
201#define DEFUN_CMD_FUNC_DECL(funcname) \
34204aac 202 static int funcname (struct cmd_element *, struct vty *, int, const char *[]);
406d6716 203
204#define DEFUN_CMD_FUNC_TEXT(funcname) \
274a4a44 205 static int funcname \
6cf0cf0c
PJ
206 (struct cmd_element *self __attribute__ ((unused)), \
207 struct vty *vty __attribute__ ((unused)), \
208 int argc __attribute__ ((unused)), \
209 const char *argv[] __attribute__ ((unused)) )
406d6716 210
cd40b329
CF
211/* DEFUN for vty command interafce. Little bit hacky ;-).
212 *
213 * DEFUN(funcname, cmdname, cmdstr, helpstr)
214 *
215 * funcname
216 * ========
217 *
218 * Name of the function that will be defined.
219 *
220 * cmdname
221 * =======
222 *
223 * Name of the struct that will be defined for the command.
224 *
225 * cmdstr
226 * ======
227 *
228 * The cmdstr defines the command syntax. It is used by the vty subsystem
229 * and vtysh to perform matching and completion in the cli. So you have to take
230 * care to construct it adhering to the following grammar. The names used
231 * for the production rules losely represent the names used in lib/command.c
232 *
233 * cmdstr = cmd_token , { " " , cmd_token } ;
234 *
235 * cmd_token = cmd_terminal
236 * | cmd_multiple
237 * | cmd_keyword ;
238 *
239 * cmd_terminal_fixed = fixed_string
240 * | variable
241 * | range
242 * | ipv4
243 * | ipv4_prefix
244 * | ipv6
245 * | ipv6_prefix ;
246 *
247 * cmd_terminal = cmd_terminal_fixed
248 * | option
249 * | vararg ;
250 *
251 * multiple_part = cmd_terminal_fixed ;
252 * cmd_multiple = "(" , multiple_part , ( "|" | { "|" , multiple_part } ) , ")" ;
253 *
254 * keyword_part = fixed_string , { " " , ( cmd_terminal_fixed | cmd_multiple ) } ;
255 * cmd_keyword = "{" , keyword_part , { "|" , keyword_part } , "}" ;
256 *
257 * lowercase = "a" | ... | "z" ;
258 * uppercase = "A" | ... | "Z" ;
259 * digit = "0" | ... | "9" ;
260 * number = digit , { digit } ;
261 *
262 * fixed_string = (lowercase | digit) , { lowercase | digit | uppercase | "-" | "_" } ;
263 * variable = uppercase , { uppercase | "_" } ;
264 * range = "<" , number , "-" , number , ">" ;
265 * ipv4 = "A.B.C.D" ;
266 * ipv4_prefix = "A.B.C.D/M" ;
267 * ipv6 = "X:X::X:X" ;
268 * ipv6_prefix = "X:X::X:X/M" ;
269 * option = "[" , variable , "]" ;
270 * vararg = "." , variable ;
271 *
272 * To put that all in a textual description: A cmdstr is a sequence of tokens,
273 * separated by spaces.
274 *
275 * Terminal Tokens:
276 *
277 * A very simple cmdstring would be something like: "show ip bgp". It consists
278 * of three Terminal Tokens, each containing a fixed string. When this command
279 * is called, no arguments will be passed down to the function implementing it,
280 * as it only consists of fixed strings.
281 *
282 * Apart from fixed strings, Terminal Tokens can also contain variables:
283 * An example would be "show ip bgp A.B.C.D". This command expects an IPv4
284 * as argument. As this is a variable, the IP address entered by the user will
285 * be passed down as an argument. Apart from two exceptions, the other options
286 * for Terminal Tokens behave exactly as we just discussed and only make a
287 * difference for the CLI. The two exceptions will be discussed in the next
288 * paragraphs.
289 *
290 * A Terminal Token can contain a so called option match. This is a simple
291 * string variable that the user may omit. An example would be:
292 * "show interface [IFNAME]". If the user calls this without an interface as
293 * argument, no arguments will be passed down to the function implementing
294 * this command. Otherwise, the interface name will be provided to the function
295 * as a regular argument.
296
297 * Also, a Terminal Token can contain a so called vararg. This is used e.g. in
298 * "show ip bgp regexp .LINE". The last token is a vararg match and will
299 * consume all the arguments the user inputs on the command line and append
300 * those to the list of arguments passed down to the function implementing this
301 * command. (Therefore, it doesn't make much sense to have any tokens after a
302 * vararg because the vararg will already consume all the words the user entered
303 * in the CLI)
304 *
305 * Multiple Tokens:
306 *
307 * The Multiple Token type can be used if there are multiple possibilities what
308 * arguments may be used for a command, but it should map to the same function
309 * nonetheless. An example would be "ip route A.B.C.D/M (reject|blackhole)"
310 * In that case both "reject" and "blackhole" would be acceptable as last
311 * arguments. The words matched by Multiple Tokens are always added to the
312 * argument list, even if they are matched by fixed strings. Such a Multiple
313 * Token can contain almost any type of token that would also be acceptable
314 * for a Terminal Token, the exception are optional variables and varag.
315 *
316 * There is one special case that is used in some places of Quagga that should be
317 * pointed out here shortly. An example would be "password (8|) WORD". This
318 * construct is used to have fixed strings communicated as arguments. (The "8"
319 * will be passed down as an argument in this case) It does not mean that
320 * the "8" is optional. Another historic and possibly surprising property of
321 * this construct is that it consumes two parts of helpstr. (Help
322 * strings will be explained later)
323 *
324 * Keyword Tokens:
325 *
326 * There are commands that take a lot of different and possibly optional arguments.
327 * An example from ospf would be the "default-information originate" command. This
328 * command takes a lot of optional arguments that may be provided in any order.
329 * To accomodate such commands, the Keyword Token has been implemented.
330 * Using the keyword token, the "default-information originate" command and all
331 * its possible options can be represented using this single cmdstr:
332 * "default-information originate \
333 * {always|metric <0-16777214>|metric-type (1|2)|route-map WORD}"
334 *
335 * Keywords always start with a fixed string and may be followed by arguments.
336 * Except optional variables and vararg, everything is permitted here.
337 *
338 * For the special case of a keyword without arguments, either NULL or the
339 * keyword itself will be pushed as an argument, depending on whether the
340 * keyword is present.
341 * For the other keywords, arguments will be only pushed for
342 * variables/Multiple Tokens. If the keyword is not present, the arguments that
343 * would have been pushed will be substituted by NULL.
344 *
345 * A few examples:
346 * "default information originate metric-type 1 metric 1000"
347 * would yield the following arguments:
348 * { NULL, "1000", "1", NULL }
349 *
350 * "default information originate always route-map RMAP-DEFAULT"
351 * would yield the following arguments:
352 * { "always", NULL, NULL, "RMAP-DEFAULT" }
353 *
354 * helpstr
355 * =======
356 *
357 * The helpstr is used to show a short explantion for the commands that
358 * are available when the user presses '?' on the CLI. It is the concatenation
359 * of the helpstrings for all the tokens that make up the command.
360 *
361 * There should be one helpstring for each token in the cmdstr except those
362 * containing other tokens, like Multiple or Keyword Tokens. For those, there
363 * will only be the helpstrings of the contained tokens.
364 *
365 * The individual helpstrings are expected to be in the same order as their
366 * respective Tokens appear in the cmdstr. They should each be terminated with
367 * a linefeed. The last helpstring should be terminated with a linefeed as well.
368 *
369 * Care should also be taken to avoid having similar tokens with different
370 * helpstrings. Imagine e.g. the commands "show ip ospf" and "show ip bgp".
371 * they both contain a helpstring for "show", but only one will be displayed
372 * when the user enters "sh?". If those two helpstrings differ, it is not
373 * defined which one will be shown and the behavior is therefore unpredictable.
374 */
406d6716 375#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
376 DEFUN_CMD_FUNC_DECL(funcname) \
377 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
378 DEFUN_CMD_FUNC_TEXT(funcname)
379
380#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
381 DEFUN_CMD_FUNC_DECL(funcname) \
382 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
383 DEFUN_CMD_FUNC_TEXT(funcname)
384
385#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
386 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
387
388#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
2557aed1 389 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
718e3744 390
391/* DEFUN_NOSH for commands that vtysh should ignore */
392#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
393 DEFUN(funcname, cmdname, cmdstr, helpstr)
394
395/* DEFSH for vtysh. */
396#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
406d6716 397 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
718e3744 398
abaaab4e
DW
399#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
400 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
401
718e3744 402/* DEFUN + DEFSH */
403#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
406d6716 404 DEFUN_CMD_FUNC_DECL(funcname) \
405 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
406 DEFUN_CMD_FUNC_TEXT(funcname)
718e3744 407
274a4a44 408/* DEFUN + DEFSH with attributes */
409#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
410 DEFUN_CMD_FUNC_DECL(funcname) \
411 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
412 DEFUN_CMD_FUNC_TEXT(funcname)
413
414#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
415 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
416
417#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
418 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
419
718e3744 420/* ALIAS macro which define existing command's alias. */
421#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
406d6716 422 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
423
424#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
274a4a44 425 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 426
427#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
428 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
429
430#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
431 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
718e3744 432
274a4a44 433#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
434 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
435
436#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
437 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
438
439#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
440 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
441
718e3744 442#endif /* VTYSH_EXTRACT_PL */
443
444/* Some macroes */
ba6d273b
DS
445
446/*
447 * Sometimes #defines create maximum values that
448 * need to have strings created from them that
449 * allow the parser to match against them.
450 * These macros allow that.
451 */
452#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
453#define CMD_CREATE_STR_HELPER(s) #s
454#define CMD_RANGE_STR(a,s) "<" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ">"
455
718e3744 456#define CMD_OPTION(S) ((S[0]) == '[')
457#define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
458#define CMD_VARARG(S) ((S[0]) == '.')
459#define CMD_RANGE(S) ((S[0] == '<'))
460
461#define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
462#define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
463#define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
464#define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
465
466/* Common descriptions. */
467#define SHOW_STR "Show running system information\n"
468#define IP_STR "IP information\n"
469#define IPV6_STR "IPv6 information\n"
470#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb 471#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 472#define CLEAR_STR "Reset functions\n"
473#define RIP_STR "RIP information\n"
474#define BGP_STR "BGP information\n"
e0bce756
DS
475#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
476#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
477#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
478#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 479#define OSPF_STR "OSPF information\n"
480#define NEIGHBOR_STR "Specify neighbor router\n"
481#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
482#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
483#define ROUTER_STR "Enable a routing process\n"
484#define AS_STR "AS number\n"
485#define MBGP_STR "MBGP information\n"
486#define MATCH_STR "Match values from routing table\n"
487#define SET_STR "Set values in destination routing protocol\n"
488#define OUT_STR "Filter outgoing routing updates\n"
489#define IN_STR "Filter incoming routing updates\n"
490#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
491#define OSPF6_NUMBER_STR "Specify by number\n"
492#define INTERFACE_STR "Interface infomation\n"
493#define IFNAME_STR "Interface name(e.g. ep0)\n"
494#define IP6_STR "IPv6 Information\n"
495#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
496#define OSPF6_ROUTER_STR "Enable a routing process\n"
497#define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
498#define SECONDS_STR "<1-65535> Seconds\n"
499#define ROUTE_STR "Routing Table\n"
500#define PREFIX_LIST_STR "Build a prefix list\n"
501#define OSPF6_DUMP_TYPE_LIST \
502"(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
9e867fe6 503#define ISIS_STR "IS-IS information\n"
504#define AREA_TAG_STR "[area tag]\n"
859d388e
DW
505#define COMMUNITY_AANN_STR "Community number where AA and NN are <0-65535>\n"
506#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"
718e3744 507
508#define CONF_BACKUP_EXT ".sav"
509
510/* IPv4 only machine should not accept IPv6 address for peer's IP
511 address. So we replace VTY command string like below. */
512#ifdef HAVE_IPV6
513#define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
514#define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
515#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
516#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
517#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
a80beece
DS
518#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
519#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 520#else
521#define NEIGHBOR_CMD "neighbor A.B.C.D "
522#define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
523#define NEIGHBOR_ADDR_STR "Neighbor address\n"
524#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
525#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
526#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
527#endif /* HAVE_IPV6 */
528
f14e6fdb
DS
529/* Dynamic neighbor (listen range) configuration */
530#ifdef HAVE_IPV6
531#define LISTEN_RANGE_CMD "bgp listen range (A.B.C.D/M|X:X::X:X/M) "
532#define LISTEN_RANGE_ADDR_STR "Neighbor address\nNeighbor IPv6 address\n"
533#else
534#define LISTEN_RANGE_CMD "bgp listen range A.B.C.D/M "
535#define LISTEN_RANGE_ADDR_STR "Neighbor address\n"
536#endif /* HAVE_IPV6 */
537
718e3744 538/* Prototypes. */
8cc4198f 539extern void install_node (struct cmd_node *, int (*) (struct vty *));
540extern void install_default (enum node_type);
541extern void install_element (enum node_type, struct cmd_element *);
718e3744 542
f6834d4c 543/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
544 string with a space between each element (allocated using
545 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
8cc4198f 546extern char *argv_concat (const char **argv, int argc, int shift);
547
548extern vector cmd_make_strvec (const char *);
549extern void cmd_free_strvec (vector);
550extern vector cmd_describe_command (vector, struct vty *, int *status);
551extern char **cmd_complete_command (vector, struct vty *, int *status);
552extern const char *cmd_prompt (enum node_type);
bed578b8 553extern int command_config_read_one_line (struct vty *vty, struct cmd_element **, int use_config_node);
13fbc82d 554extern int config_from_file (struct vty *, FILE *, unsigned int *line_num);
8cc4198f 555extern enum node_type node_parent (enum node_type);
556extern int cmd_execute_command (vector, struct vty *, struct cmd_element **, int);
557extern int cmd_execute_command_strict (vector, struct vty *, struct cmd_element **);
8cc4198f 558extern void cmd_init (int);
228da428 559extern void cmd_terminate (void);
718e3744 560
561/* Export typical functions. */
562extern struct cmd_element config_end_cmd;
563extern struct cmd_element config_exit_cmd;
564extern struct cmd_element config_quit_cmd;
565extern struct cmd_element config_help_cmd;
566extern struct cmd_element config_list_cmd;
8cc4198f 567extern char *host_config_file (void);
c0e8c16f 568extern void host_config_set (const char *);
6590f2c3 569
8cc4198f 570extern void print_version (const char *);
86228fde 571
7cfc61d3
DS
572extern int cmd_banner_motd_file (const char *);
573
86228fde
PJ
574/* struct host global, ick */
575extern struct host host;
228da428
CC
576
577/* "<cr>" global */
578extern char *command_cr;
718e3744 579#endif /* _ZEBRA_COMMAND_H */