blob: d8029fb39d77fbc677c9a66341f6b1b14ea92f39 [file] [log] [blame]
paul718e3742002-12-13 20:15:29 +00001/*
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"
Paul Jakma9c42a6e2006-06-27 07:52:03 +000028#include "lib/route_types.h"
Paul Jakma92193662016-06-16 15:53:26 +010029#include "hash.h"
paul718e3742002-12-13 20:15:29 +000030
31/* Host configuration variable */
32struct host
33{
34 /* Host name of this router. */
35 char *name;
36
37 /* Password for vty interface. */
38 char *password;
39 char *password_encrypt;
40
41 /* Enable password */
42 char *enable;
43 char *enable_encrypt;
44
45 /* System wide terminal lines. */
46 int lines;
47
48 /* Log filename. */
49 char *logfile;
50
paul718e3742002-12-13 20:15:29 +000051 /* config file name of this host */
52 char *config;
53
54 /* Flags for services */
55 int advanced;
56 int encrypt;
57
58 /* Banner configuration. */
hasso8c328f12004-10-05 21:01:23 +000059 const char *motd;
paul3b0c5d92005-03-08 10:43:43 +000060 char *motdfile;
paul718e3742002-12-13 20:15:29 +000061};
62
63/* There are some command levels which called from command node. */
64enum node_type
65{
66 AUTH_NODE, /* Authentication mode of vty interface. */
Paul Jakma62687ff2008-08-23 14:27:06 +010067 RESTRICTED_NODE, /* Restricted view mode */
paul718e3742002-12-13 20:15:29 +000068 VIEW_NODE, /* View node. Default mode of vty interface. */
69 AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
70 ENABLE_NODE, /* Enable node. */
71 CONFIG_NODE, /* Config node. Default mode of config file. */
Feng Lu55cfa2f2014-07-03 18:24:34 +080072 VRF_NODE, /* VRF node. */
hassoe7168df2004-10-03 20:11:32 +000073 SERVICE_NODE, /* Service node. */
paul718e3742002-12-13 20:15:29 +000074 DEBUG_NODE, /* Debug node. */
75 AAA_NODE, /* AAA node. */
76 KEYCHAIN_NODE, /* Key-chain node. */
77 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
78 INTERFACE_NODE, /* Interface mode node. */
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. */
Paul Jakma57345092011-12-25 17:52:09 +010083 BABEL_NODE, /* Babel protocol mode node. */
paul718e3742002-12-13 20:15:29 +000084 BGP_NODE, /* BGP protocol mode which includes BGP4+ */
85 BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
Lou Berger13c378d2016-01-12 13:41:56 -050086 BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */
paul718e3742002-12-13 20:15:29 +000087 BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
88 BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
89 BGP_IPV6_NODE, /* BGP IPv6 address family */
paul1e836592005-08-22 22:39:56 +000090 BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
Lou Bergera3fda882016-01-12 13:42:04 -050091 BGP_ENCAP_NODE, /* BGP ENCAP SAFI */
92 BGP_ENCAPV6_NODE, /* BGP ENCAP SAFI */
paul718e3742002-12-13 20:15:29 +000093 OSPF_NODE, /* OSPF protocol mode */
94 OSPF6_NODE, /* OSPF protocol for IPv6 mode */
jardin9e867fe2003-12-23 08:56:18 +000095 ISIS_NODE, /* ISIS protocol mode */
Everton Marques871dbcf2009-08-11 15:43:05 -030096 PIM_NODE, /* PIM protocol mode */
paul718e3742002-12-13 20:15:29 +000097 MASC_NODE, /* MASC for multicast. */
98 IRDP_NODE, /* ICMP Router Discovery Protocol mode. */
99 IP_NODE, /* Static ip route node. */
100 ACCESS_NODE, /* Access list node. */
101 PREFIX_NODE, /* Prefix list node. */
102 ACCESS_IPV6_NODE, /* Access list node. */
103 PREFIX_IPV6_NODE, /* Prefix list node. */
104 AS_LIST_NODE, /* AS list node. */
105 COMMUNITY_LIST_NODE, /* Community list node. */
106 RMAP_NODE, /* Route map node. */
107 SMUX_NODE, /* SNMP configuration node. */
108 DUMP_NODE, /* Packet dump node. */
109 FORWARDING_NODE, /* IP forwarding node. */
Paul Jakma7514fb72007-05-02 16:05:35 +0000110 PROTOCOL_NODE, /* protocol filtering node */
Paul Jakma62687ff2008-08-23 14:27:06 +0100111 VTY_NODE, /* Vty node. */
Olivier Dugeonae51c9d2016-04-19 16:21:46 +0200112 LINK_PARAMS_NODE, /* Link-parameters node */
paul718e3742002-12-13 20:15:29 +0000113};
114
115/* Node which has some commands and prompt string and configuration
116 function pointer . */
117struct cmd_node
118{
119 /* Node index. */
120 enum node_type node;
121
122 /* Prompt character at vty interface. */
hasso8c328f12004-10-05 21:01:23 +0000123 const char *prompt;
paul718e3742002-12-13 20:15:29 +0000124
125 /* Is this node's configuration goes to vtysh ? */
126 int vtysh;
127
128 /* Node's configuration write function */
129 int (*func) (struct vty *);
130
131 /* Vector of this node's command list. */
Paul Jakma92193662016-06-16 15:53:26 +0100132 vector cmd_vector;
133
134 /* Hashed index of command node list, for de-dupping primarily */
135 struct hash *cmd_hash;
paul718e3742002-12-13 20:15:29 +0000136};
137
paul406d6712004-10-22 12:27:44 +0000138enum
139{
paul9c5d8562005-03-08 15:56:42 +0000140 CMD_ATTR_DEPRECATED = 1,
paul406d6712004-10-22 12:27:44 +0000141 CMD_ATTR_HIDDEN,
142};
143
paul718e3742002-12-13 20:15:29 +0000144/* Structure of command element. */
145struct cmd_element
146{
hasso8c328f12004-10-05 21:01:23 +0000147 const char *string; /* Command specification by string. */
paul9035efa2004-10-10 11:56:56 +0000148 int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
hasso8c328f12004-10-05 21:01:23 +0000149 const char *doc; /* Documentation of this command. */
paul718e3742002-12-13 20:15:29 +0000150 int daemon; /* Daemon to which this command belong. */
Christian Frankecd40b322013-09-30 12:27:51 +0000151 vector tokens; /* Vector of cmd_tokens */
paul406d6712004-10-22 12:27:44 +0000152 u_char attr; /* Command attributes */
paul718e3742002-12-13 20:15:29 +0000153};
154
Christian Frankecd40b322013-09-30 12:27:51 +0000155
156enum cmd_token_type
paul718e3742002-12-13 20:15:29 +0000157{
Christian Frankecd40b322013-09-30 12:27:51 +0000158 TOKEN_TERMINAL = 0,
159 TOKEN_MULTIPLE,
160 TOKEN_KEYWORD,
161};
162
David Lamparter10bac802015-05-05 11:10:20 +0200163enum cmd_terminal_type
164{
165 _TERMINAL_BUG = 0,
166 TERMINAL_LITERAL,
167 TERMINAL_OPTION,
168 TERMINAL_VARIABLE,
169 TERMINAL_VARARG,
170 TERMINAL_RANGE,
171 TERMINAL_IPV4,
172 TERMINAL_IPV4_PREFIX,
173 TERMINAL_IPV6,
174 TERMINAL_IPV6_PREFIX,
175};
176
David Lamparter14162932015-05-12 17:18:04 +0200177/* argument to be recorded on argv[] if it's not a literal */
178#define TERMINAL_RECORD(t) ((t) >= TERMINAL_OPTION)
179
Christian Frankecd40b322013-09-30 12:27:51 +0000180/* Command description structure. */
181struct cmd_token
182{
183 enum cmd_token_type type;
David Lamparter10bac802015-05-05 11:10:20 +0200184 enum cmd_terminal_type terminal;
Christian Frankecd40b322013-09-30 12:27:51 +0000185
186 /* Used for type == MULTIPLE */
187 vector multiple; /* vector of cmd_token, type == FINAL */
188
189 /* Used for type == KEYWORD */
190 vector keyword; /* vector of vector of cmd_tokens */
191
192 /* Used for type == TERMINAL */
Chris Caputo228da422009-07-18 05:44:03 +0000193 char *cmd; /* Command string. */
Christian Frankecd40b322013-09-30 12:27:51 +0000194 char *desc; /* Command's description. */
paul718e3742002-12-13 20:15:29 +0000195};
196
197/* Return value of the commands. */
198#define CMD_SUCCESS 0
199#define CMD_WARNING 1
200#define CMD_ERR_NO_MATCH 2
201#define CMD_ERR_AMBIGUOUS 3
202#define CMD_ERR_INCOMPLETE 4
203#define CMD_ERR_EXEED_ARGC_MAX 5
204#define CMD_ERR_NOTHING_TODO 6
205#define CMD_COMPLETE_FULL_MATCH 7
206#define CMD_COMPLETE_MATCH 8
207#define CMD_COMPLETE_LIST_MATCH 9
208#define CMD_SUCCESS_DAEMON 10
209
210/* Argc max counts. */
211#define CMD_ARGC_MAX 25
212
213/* Turn off these macros when uisng cpp with extract.pl */
214#ifndef VTYSH_EXTRACT_PL
215
paul406d6712004-10-22 12:27:44 +0000216/* helper defines for end-user DEFUN* macros */
217#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
paul718e3742002-12-13 20:15:29 +0000218 struct cmd_element cmdname = \
219 { \
paul9035efa2004-10-10 11:56:56 +0000220 .string = cmdstr, \
221 .func = funcname, \
paul406d6712004-10-22 12:27:44 +0000222 .doc = helpstr, \
223 .attr = attrs, \
224 .daemon = dnum, \
225 };
226
227#define DEFUN_CMD_FUNC_DECL(funcname) \
paul34204aa2005-11-03 09:00:23 +0000228 static int funcname (struct cmd_element *, struct vty *, int, const char *[]);
paul406d6712004-10-22 12:27:44 +0000229
230#define DEFUN_CMD_FUNC_TEXT(funcname) \
ajs274a4a42004-12-07 15:39:31 +0000231 static int funcname \
Paul Jakma6cf0cf02006-03-30 14:43:17 +0000232 (struct cmd_element *self __attribute__ ((unused)), \
233 struct vty *vty __attribute__ ((unused)), \
234 int argc __attribute__ ((unused)), \
235 const char *argv[] __attribute__ ((unused)) )
paul406d6712004-10-22 12:27:44 +0000236
Christian Frankecd40b322013-09-30 12:27:51 +0000237/* DEFUN for vty command interafce. Little bit hacky ;-).
238 *
239 * DEFUN(funcname, cmdname, cmdstr, helpstr)
240 *
241 * funcname
242 * ========
243 *
244 * Name of the function that will be defined.
245 *
246 * cmdname
247 * =======
248 *
249 * Name of the struct that will be defined for the command.
250 *
251 * cmdstr
252 * ======
253 *
254 * The cmdstr defines the command syntax. It is used by the vty subsystem
255 * and vtysh to perform matching and completion in the cli. So you have to take
256 * care to construct it adhering to the following grammar. The names used
257 * for the production rules losely represent the names used in lib/command.c
258 *
259 * cmdstr = cmd_token , { " " , cmd_token } ;
260 *
261 * cmd_token = cmd_terminal
262 * | cmd_multiple
263 * | cmd_keyword ;
264 *
265 * cmd_terminal_fixed = fixed_string
266 * | variable
267 * | range
268 * | ipv4
269 * | ipv4_prefix
270 * | ipv6
271 * | ipv6_prefix ;
272 *
273 * cmd_terminal = cmd_terminal_fixed
274 * | option
275 * | vararg ;
276 *
277 * multiple_part = cmd_terminal_fixed ;
278 * cmd_multiple = "(" , multiple_part , ( "|" | { "|" , multiple_part } ) , ")" ;
279 *
280 * keyword_part = fixed_string , { " " , ( cmd_terminal_fixed | cmd_multiple ) } ;
281 * cmd_keyword = "{" , keyword_part , { "|" , keyword_part } , "}" ;
282 *
283 * lowercase = "a" | ... | "z" ;
284 * uppercase = "A" | ... | "Z" ;
285 * digit = "0" | ... | "9" ;
286 * number = digit , { digit } ;
287 *
288 * fixed_string = (lowercase | digit) , { lowercase | digit | uppercase | "-" | "_" } ;
289 * variable = uppercase , { uppercase | "_" } ;
290 * range = "<" , number , "-" , number , ">" ;
291 * ipv4 = "A.B.C.D" ;
292 * ipv4_prefix = "A.B.C.D/M" ;
293 * ipv6 = "X:X::X:X" ;
294 * ipv6_prefix = "X:X::X:X/M" ;
295 * option = "[" , variable , "]" ;
296 * vararg = "." , variable ;
297 *
298 * To put that all in a textual description: A cmdstr is a sequence of tokens,
299 * separated by spaces.
300 *
301 * Terminal Tokens:
302 *
303 * A very simple cmdstring would be something like: "show ip bgp". It consists
304 * of three Terminal Tokens, each containing a fixed string. When this command
305 * is called, no arguments will be passed down to the function implementing it,
306 * as it only consists of fixed strings.
307 *
308 * Apart from fixed strings, Terminal Tokens can also contain variables:
309 * An example would be "show ip bgp A.B.C.D". This command expects an IPv4
310 * as argument. As this is a variable, the IP address entered by the user will
311 * be passed down as an argument. Apart from two exceptions, the other options
312 * for Terminal Tokens behave exactly as we just discussed and only make a
313 * difference for the CLI. The two exceptions will be discussed in the next
314 * paragraphs.
315 *
316 * A Terminal Token can contain a so called option match. This is a simple
317 * string variable that the user may omit. An example would be:
318 * "show interface [IFNAME]". If the user calls this without an interface as
319 * argument, no arguments will be passed down to the function implementing
320 * this command. Otherwise, the interface name will be provided to the function
321 * as a regular argument.
322
323 * Also, a Terminal Token can contain a so called vararg. This is used e.g. in
324 * "show ip bgp regexp .LINE". The last token is a vararg match and will
325 * consume all the arguments the user inputs on the command line and append
326 * those to the list of arguments passed down to the function implementing this
327 * command. (Therefore, it doesn't make much sense to have any tokens after a
328 * vararg because the vararg will already consume all the words the user entered
329 * in the CLI)
330 *
331 * Multiple Tokens:
332 *
333 * The Multiple Token type can be used if there are multiple possibilities what
334 * arguments may be used for a command, but it should map to the same function
335 * nonetheless. An example would be "ip route A.B.C.D/M (reject|blackhole)"
336 * In that case both "reject" and "blackhole" would be acceptable as last
337 * arguments. The words matched by Multiple Tokens are always added to the
338 * argument list, even if they are matched by fixed strings. Such a Multiple
339 * Token can contain almost any type of token that would also be acceptable
340 * for a Terminal Token, the exception are optional variables and varag.
341 *
342 * There is one special case that is used in some places of Quagga that should be
343 * pointed out here shortly. An example would be "password (8|) WORD". This
344 * construct is used to have fixed strings communicated as arguments. (The "8"
345 * will be passed down as an argument in this case) It does not mean that
346 * the "8" is optional. Another historic and possibly surprising property of
347 * this construct is that it consumes two parts of helpstr. (Help
348 * strings will be explained later)
349 *
350 * Keyword Tokens:
351 *
352 * There are commands that take a lot of different and possibly optional arguments.
353 * An example from ospf would be the "default-information originate" command. This
354 * command takes a lot of optional arguments that may be provided in any order.
355 * To accomodate such commands, the Keyword Token has been implemented.
356 * Using the keyword token, the "default-information originate" command and all
357 * its possible options can be represented using this single cmdstr:
358 * "default-information originate \
359 * {always|metric <0-16777214>|metric-type (1|2)|route-map WORD}"
360 *
361 * Keywords always start with a fixed string and may be followed by arguments.
362 * Except optional variables and vararg, everything is permitted here.
363 *
364 * For the special case of a keyword without arguments, either NULL or the
365 * keyword itself will be pushed as an argument, depending on whether the
366 * keyword is present.
367 * For the other keywords, arguments will be only pushed for
368 * variables/Multiple Tokens. If the keyword is not present, the arguments that
369 * would have been pushed will be substituted by NULL.
370 *
371 * A few examples:
372 * "default information originate metric-type 1 metric 1000"
373 * would yield the following arguments:
374 * { NULL, "1000", "1", NULL }
375 *
376 * "default information originate always route-map RMAP-DEFAULT"
377 * would yield the following arguments:
378 * { "always", NULL, NULL, "RMAP-DEFAULT" }
379 *
380 * helpstr
381 * =======
382 *
383 * The helpstr is used to show a short explantion for the commands that
384 * are available when the user presses '?' on the CLI. It is the concatenation
385 * of the helpstrings for all the tokens that make up the command.
386 *
387 * There should be one helpstring for each token in the cmdstr except those
388 * containing other tokens, like Multiple or Keyword Tokens. For those, there
389 * will only be the helpstrings of the contained tokens.
390 *
391 * The individual helpstrings are expected to be in the same order as their
392 * respective Tokens appear in the cmdstr. They should each be terminated with
393 * a linefeed. The last helpstring should be terminated with a linefeed as well.
394 *
395 * Care should also be taken to avoid having similar tokens with different
396 * helpstrings. Imagine e.g. the commands "show ip ospf" and "show ip bgp".
397 * they both contain a helpstring for "show", but only one will be displayed
398 * when the user enters "sh?". If those two helpstrings differ, it is not
399 * defined which one will be shown and the behavior is therefore unpredictable.
400 */
paul406d6712004-10-22 12:27:44 +0000401#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
402 DEFUN_CMD_FUNC_DECL(funcname) \
403 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
404 DEFUN_CMD_FUNC_TEXT(funcname)
405
406#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
407 DEFUN_CMD_FUNC_DECL(funcname) \
408 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
409 DEFUN_CMD_FUNC_TEXT(funcname)
410
411#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
412 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
413
414#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
hasso2557aed2004-11-28 21:16:20 +0000415 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
paul718e3742002-12-13 20:15:29 +0000416
417/* DEFUN_NOSH for commands that vtysh should ignore */
418#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
419 DEFUN(funcname, cmdname, cmdstr, helpstr)
420
421/* DEFSH for vtysh. */
422#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
paul406d6712004-10-22 12:27:44 +0000423 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
paul718e3742002-12-13 20:15:29 +0000424
425/* DEFUN + DEFSH */
426#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
paul406d6712004-10-22 12:27:44 +0000427 DEFUN_CMD_FUNC_DECL(funcname) \
428 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
429 DEFUN_CMD_FUNC_TEXT(funcname)
paul718e3742002-12-13 20:15:29 +0000430
ajs274a4a42004-12-07 15:39:31 +0000431/* 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
paul718e3742002-12-13 20:15:29 +0000443/* ALIAS macro which define existing command's alias. */
444#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
paul406d6712004-10-22 12:27:44 +0000445 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
446
447#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
ajs274a4a42004-12-07 15:39:31 +0000448 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
paul406d6712004-10-22 12:27:44 +0000449
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)
paul718e3742002-12-13 20:15:29 +0000455
ajs274a4a42004-12-07 15:39:31 +0000456#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
paul718e3742002-12-13 20:15:29 +0000465#endif /* VTYSH_EXTRACT_PL */
466
Donald Sharpb2a2fd72015-12-09 08:24:46 -0500467/*
468 * Sometimes #defines create maximum values that
469 * need to have strings created from them that
470 * allow the parser to match against them.
471 * These macros allow that.
472 */
473#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
474#define CMD_CREATE_STR_HELPER(s) #s
475#define CMD_RANGE_STR(a,s) "<" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ">"
476
477
paul718e3742002-12-13 20:15:29 +0000478/* Common descriptions. */
479#define SHOW_STR "Show running system information\n"
480#define IP_STR "IP information\n"
481#define IPV6_STR "IPv6 information\n"
482#define NO_STR "Negate a command or set its defaults\n"
Paul Jakma9c42a6e2006-06-27 07:52:03 +0000483#define REDIST_STR "Redistribute information from another routing protocol\n"
paul718e3742002-12-13 20:15:29 +0000484#define CLEAR_STR "Reset functions\n"
485#define RIP_STR "RIP information\n"
486#define BGP_STR "BGP information\n"
487#define OSPF_STR "OSPF information\n"
488#define NEIGHBOR_STR "Specify neighbor router\n"
489#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
490#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
491#define ROUTER_STR "Enable a routing process\n"
492#define AS_STR "AS number\n"
493#define MBGP_STR "MBGP information\n"
494#define MATCH_STR "Match values from routing table\n"
495#define SET_STR "Set values in destination routing protocol\n"
496#define OUT_STR "Filter outgoing routing updates\n"
497#define IN_STR "Filter incoming routing updates\n"
498#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
499#define OSPF6_NUMBER_STR "Specify by number\n"
500#define INTERFACE_STR "Interface infomation\n"
501#define IFNAME_STR "Interface name(e.g. ep0)\n"
502#define IP6_STR "IPv6 Information\n"
503#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
504#define OSPF6_ROUTER_STR "Enable a routing process\n"
505#define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
506#define SECONDS_STR "<1-65535> Seconds\n"
507#define ROUTE_STR "Routing Table\n"
508#define PREFIX_LIST_STR "Build a prefix list\n"
509#define OSPF6_DUMP_TYPE_LIST \
510"(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
jardin9e867fe2003-12-23 08:56:18 +0000511#define ISIS_STR "IS-IS information\n"
512#define AREA_TAG_STR "[area tag]\n"
Olivier Dugeonae51c9d2016-04-19 16:21:46 +0200513#define MPLS_TE_STR "MPLS-TE specific commands\n"
514#define LINK_PARAMS_STR "Configure interface link parameters\n"
515#define OSPF_RI_STR "OSPF Router Information specific commands\n"
516#define PCE_STR "PCE Router Information specific commands\n"
paul718e3742002-12-13 20:15:29 +0000517
518#define CONF_BACKUP_EXT ".sav"
519
520/* IPv4 only machine should not accept IPv6 address for peer's IP
521 address. So we replace VTY command string like below. */
522#ifdef HAVE_IPV6
523#define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
524#define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
525#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
526#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
527#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
528#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
529#else
530#define NEIGHBOR_CMD "neighbor A.B.C.D "
531#define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
532#define NEIGHBOR_ADDR_STR "Neighbor address\n"
533#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
534#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
535#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
536#endif /* HAVE_IPV6 */
537
538/* Prototypes. */
paul8cc41982005-05-06 21:25:49 +0000539extern 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 *);
paul718e3742002-12-13 20:15:29 +0000542
ajsf6834d42005-01-28 20:28:35 +0000543/* 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. */
paul8cc41982005-05-06 21:25:49 +0000546extern char *argv_concat (const char **argv, int argc, int shift);
ajsf6834d42005-01-28 20:28:35 +0000547
paul8cc41982005-05-06 21:25:49 +0000548extern 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);
Lou Berger67290032016-01-12 13:41:46 -0500552extern char **cmd_complete_command_lib (vector, struct vty *, int *status, int islib);
paul8cc41982005-05-06 21:25:49 +0000553extern const char *cmd_prompt (enum node_type);
Donald Sharpd8aa4be2015-09-28 20:10:40 -0400554extern int command_config_read_one_line (struct vty *vty, struct cmd_element **, int use_config_node);
Steve Hillea555002009-07-28 16:36:14 -0400555extern int config_from_file (struct vty *, FILE *, unsigned int *line_num);
paul8cc41982005-05-06 21:25:49 +0000556extern enum node_type node_parent (enum node_type);
557extern int cmd_execute_command (vector, struct vty *, struct cmd_element **, int);
558extern int cmd_execute_command_strict (vector, struct vty *, struct cmd_element **);
paul8cc41982005-05-06 21:25:49 +0000559extern void cmd_init (int);
Chris Caputo228da422009-07-18 05:44:03 +0000560extern void cmd_terminate (void);
paul718e3742002-12-13 20:15:29 +0000561
562/* Export typical functions. */
563extern struct cmd_element config_end_cmd;
564extern struct cmd_element config_exit_cmd;
565extern struct cmd_element config_quit_cmd;
566extern struct cmd_element config_help_cmd;
567extern struct cmd_element config_list_cmd;
Christian Franke41de6292016-05-03 19:59:41 +0200568extern const char *host_config_get (void);
paul8cc41982005-05-06 21:25:49 +0000569extern void host_config_set (char *);
paul718e3742002-12-13 20:15:29 +0000570
paul8cc41982005-05-06 21:25:49 +0000571extern void print_version (const char *);
Paul Jakma86228fd2006-03-30 15:00:30 +0000572
573/* struct host global, ick */
574extern struct host host;
Chris Caputo228da422009-07-18 05:44:03 +0000575
576/* "<cr>" global */
577extern char *command_cr;
paul718e3742002-12-13 20:15:29 +0000578#endif /* _ZEBRA_COMMAND_H */