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