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