lib/command.h

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