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 along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_COMMAND_H
  23 #define _ZEBRA_COMMAND_H
  24
  25 #include "vector.h"
  26 #include "vty.h"
  27 #include "lib/route_types.h"
  28 #include "graph.h"
  29 #include "memory.h"
  30 #include "hash.h"
  31 #include "command_graph.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 DECLARE_MTYPE(COMPLETION)
  38
  39 /*
  40  * From RFC 1123 (Requirements for Internet Hosts), Section 2.1 on hostnames:
  41  * One aspect of host name syntax is hereby changed: the restriction on
  42  * the first character is relaxed to allow either a letter or a digit.
  43  * Host software MUST support this more liberal syntax.
  44  *
  45  * Host software MUST handle host names of up to 63 characters and
  46  * SHOULD handle host names of up to 255 characters.
  47  */
  48 #define HOSTNAME_LEN   255
  49
  50 /* Host configuration variable */
  51 struct host {
  52         /* Host name of this router. */
  53         char *name;
  54
  55         /* Domainname of this router */
  56         char *domainname;
  57
  58         /* Password for vty interface. */
  59         char *password;
  60         char *password_encrypt;
  61
  62         /* Enable password */
  63         char *enable;
  64         char *enable_encrypt;
  65
  66         /* System wide terminal lines. */
  67         int lines;
  68
  69         /* Log filename. */
  70         char *logfile;
  71
  72         /* config file name of this host */
  73         char *config;
  74         int noconfig;
  75
  76         /* Flags for services */
  77         int advanced;
  78         int encrypt;
  79
  80         /* Banner configuration. */
  81         char *motd;
  82         char *motdfile;
  83 };
  84
  85 /* List of CLI nodes. Please remember to update the name array in command.c. */
  86 enum node_type {
  87         AUTH_NODE,               /* Authentication mode of vty interface. */
  88         VIEW_NODE,               /* View node. Default mode of vty interface. */
  89         AUTH_ENABLE_NODE,       /* Authentication mode for change enable. */
  90         ENABLE_NODE,             /* Enable node. */
  91         CONFIG_NODE,             /* Config node. Default mode of config file. */
  92         DEBUG_NODE,              /* Debug node. */
  93         VRF_DEBUG_NODE,          /* Vrf Debug node. */
  94         NORTHBOUND_DEBUG_NODE,   /* Northbound Debug node. */
  95         DEBUG_VNC_NODE,          /* Debug VNC node. */
  96         RMAP_DEBUG_NODE,         /* Route-map debug node */
  97         RESOLVER_DEBUG_NODE,     /* Resolver debug node */
  98         AAA_NODE,                /* AAA node. */
  99         KEYCHAIN_NODE,           /* Key-chain node. */
 100         KEYCHAIN_KEY_NODE,       /* Key-chain key node. */
 101         IP_NODE,                 /* Static ip route node. */
 102         VRF_NODE,                /* VRF mode node. */
 103         INTERFACE_NODE,          /* Interface mode node. */
 104         NH_GROUP_NODE,           /* Nexthop-Group mode node. */
 105         ZEBRA_NODE,              /* zebra connection node. */
 106         TABLE_NODE,              /* rtm_table selection node. */
 107         RIP_NODE,                /* RIP protocol mode node. */
 108         RIPNG_NODE,              /* RIPng protocol mode node. */
 109         BABEL_NODE,              /* BABEL protocol mode node. */
 110         EIGRP_NODE,              /* EIGRP protocol mode node. */
 111         BGP_NODE,                /* BGP protocol mode which includes BGP4+ */
 112         BGP_VPNV4_NODE,          /* BGP MPLS-VPN PE exchange. */
 113         BGP_VPNV6_NODE,          /* BGP MPLS-VPN PE exchange. */
 114         BGP_IPV4_NODE,           /* BGP IPv4 unicast address family.  */
 115         BGP_IPV4M_NODE,          /* BGP IPv4 multicast address family.  */
 116         BGP_IPV4L_NODE,          /* BGP IPv4 labeled unicast address family.  */
 117         BGP_IPV6_NODE,           /* BGP IPv6 address family */
 118         BGP_IPV6M_NODE,          /* BGP IPv6 multicast address family. */
 119         BGP_IPV6L_NODE,          /* BGP IPv6 labeled unicast address family. */
 120         BGP_VRF_POLICY_NODE,     /* BGP VRF policy */
 121         BGP_VNC_DEFAULTS_NODE,   /* BGP VNC nve defaults */
 122         BGP_VNC_NVE_GROUP_NODE,  /* BGP VNC nve group */
 123         BGP_VNC_L2_GROUP_NODE,   /* BGP VNC L2 group */
 124         RFP_DEFAULTS_NODE,       /* RFP defaults node */
 125         BGP_EVPN_NODE,           /* BGP EVPN node. */
 126         OSPF_NODE,               /* OSPF protocol mode */
 127         OSPF6_NODE,              /* OSPF protocol for IPv6 mode */
 128         LDP_NODE,                /* LDP protocol mode */
 129         LDP_IPV4_NODE,           /* LDP IPv4 address family */
 130         LDP_IPV6_NODE,           /* LDP IPv6 address family */
 131         LDP_IPV4_IFACE_NODE,     /* LDP IPv4 Interface */
 132         LDP_IPV6_IFACE_NODE,     /* LDP IPv6 Interface */
 133         LDP_L2VPN_NODE,          /* LDP L2VPN node */
 134         LDP_PSEUDOWIRE_NODE,     /* LDP Pseudowire node */
 135         ISIS_NODE,               /* ISIS protocol mode */
 136         ACCESS_NODE,             /* Access list node. */
 137         PREFIX_NODE,             /* Prefix list node. */
 138         ACCESS_IPV6_NODE,       /* Access list node. */
 139         ACCESS_MAC_NODE,         /* MAC access list node*/
 140         PREFIX_IPV6_NODE,       /* Prefix list node. */
 141         AS_LIST_NODE,            /* AS list node. */
 142         COMMUNITY_LIST_NODE,     /* Community list node. */
 143         RMAP_NODE,               /* Route map node. */
 144         PBRMAP_NODE,             /* PBR map node. */
 145         SMUX_NODE,               /* SNMP configuration node. */
 146         DUMP_NODE,               /* Packet dump node. */
 147         FORWARDING_NODE,         /* IP forwarding node. */
 148         PROTOCOL_NODE,           /* protocol filtering node */
 149         MPLS_NODE,               /* MPLS config node */
 150         PW_NODE,                 /* Pseudowire config node */
 151         VTY_NODE,                /* Vty node. */
 152         LINK_PARAMS_NODE,       /* Link-parameters node */
 153         BGP_EVPN_VNI_NODE,       /* BGP EVPN VNI */
 154         RPKI_NODE,     /* RPKI node for configuration of RPKI cache server
 155                           connections.*/
 156         BGP_FLOWSPECV4_NODE,    /* BGP IPv4 FLOWSPEC Address-Family */
 157         BGP_FLOWSPECV6_NODE,    /* BGP IPv6 FLOWSPEC Address-Family */
 158         BFD_NODE,                /* BFD protocol mode. */
 159         BFD_PEER_NODE,           /* BFD peer configuration mode. */
 160         OPENFABRIC_NODE,        /* OpenFabric router configuration node */
 161         VRRP_NODE,               /* VRRP node */
 162         BMP_NODE,               /* BMP config under router bgp */
 163         NODE_TYPE_MAX, /* maximum */
 164 };
 165
 166 extern vector cmdvec;
 167 extern const struct message tokennames[];
 168 extern const char *const node_names[];
 169
 170 /* Node which has some commands and prompt string and configuration
 171    function pointer . */
 172 struct cmd_node {
 173         /* Node index. */
 174         enum node_type node;
 175
 176         /* Prompt character at vty interface. */
 177         const char *prompt;
 178
 179         /* Is this node's configuration goes to vtysh ? */
 180         int vtysh;
 181
 182         /* Node's configuration write function */
 183         int (*func)(struct vty *);
 184
 185         /* Node's command graph */
 186         struct graph *cmdgraph;
 187
 188         /* Vector of this node's command list. */
 189         vector cmd_vector;
 190
 191         /* Hashed index of command node list, for de-dupping primarily */
 192         struct hash *cmd_hash;
 193 };
 194
 195 /* Return value of the commands. */
 196 #define CMD_SUCCESS              0
 197 #define CMD_WARNING              1
 198 #define CMD_ERR_NO_MATCH         2
 199 #define CMD_ERR_AMBIGUOUS        3
 200 #define CMD_ERR_INCOMPLETE       4
 201 #define CMD_ERR_EXEED_ARGC_MAX   5
 202 #define CMD_ERR_NOTHING_TODO     6
 203 #define CMD_COMPLETE_FULL_MATCH  7
 204 #define CMD_COMPLETE_MATCH       8
 205 #define CMD_COMPLETE_LIST_MATCH  9
 206 #define CMD_SUCCESS_DAEMON      10
 207 #define CMD_ERR_NO_FILE         11
 208 #define CMD_SUSPEND             12
 209 #define CMD_WARNING_CONFIG_FAILED 13
 210 #define CMD_NOT_MY_INSTANCE     14
 211
 212 /* Argc max counts. */
 213 #define CMD_ARGC_MAX   256
 214
 215 /* Turn off these macros when uisng cpp with extract.pl */
 216 #ifndef VTYSH_EXTRACT_PL
 217
 218 /* helper defines for end-user DEFUN* macros */
 219 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum)     \
 220         static const struct cmd_element cmdname = {                            \
 221                 .string = cmdstr,                                              \
 222                 .func = funcname,                                              \
 223                 .doc = helpstr,                                                \
 224                 .attr = attrs,                                                 \
 225                 .daemon = dnum,                                                \
 226                 .name = #cmdname,                                              \
 227         };
 228
 229 #define DEFUN_CMD_FUNC_DECL(funcname)                                          \
 230         static int funcname(const struct cmd_element *, struct vty *, int,     \
 231                             struct cmd_token *[]);
 232
 233 #define DEFUN_CMD_FUNC_TEXT(funcname)                                          \
 234         static int funcname(const struct cmd_element *self                     \
 235                             __attribute__((unused)),                           \
 236                             struct vty *vty __attribute__((unused)),           \
 237                             int argc __attribute__((unused)),                  \
 238                             struct cmd_token *argv[] __attribute__((unused)))
 239
 240 #define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
 241         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
 242         funcdecl_##funcname
 243
 244 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
 245         DEFPY(funcname, cmdname, cmdstr, helpstr)
 246
 247 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 248         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
 249         funcdecl_##funcname
 250
 251 #define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 252         DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 253
 254 #define DEFUN(funcname, cmdname, cmdstr, helpstr)                              \
 255         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 256         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
 257         DEFUN_CMD_FUNC_TEXT(funcname)
 258
 259 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 260         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 261         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
 262         DEFUN_CMD_FUNC_TEXT(funcname)
 263
 264 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 265         DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 266
 267 /* DEFUN_NOSH for commands that vtysh should ignore */
 268 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
 269         DEFUN(funcname, cmdname, cmdstr, helpstr)
 270
 271 /* DEFSH for vtysh. */
 272 #define DEFSH(daemon, cmdname, cmdstr, helpstr)                                \
 273         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
 274
 275 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr)                         \
 276         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN,     \
 277                           daemon)
 278
 279 /* DEFUN + DEFSH */
 280 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr)                    \
 281         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 282         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)       \
 283         DEFUN_CMD_FUNC_TEXT(funcname)
 284
 285 /* DEFUN + DEFSH with attributes */
 286 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr)         \
 287         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 288         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon)    \
 289         DEFUN_CMD_FUNC_TEXT(funcname)
 290
 291 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)             \
 292         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
 293                      CMD_ATTR_HIDDEN)
 294
 295 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)         \
 296         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
 297                      CMD_ATTR_DEPRECATED)
 298
 299 /* ALIAS macro which define existing command's alias. */
 300 #define ALIAS(funcname, cmdname, cmdstr, helpstr)                              \
 301         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 302
 303 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 304         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 305
 306 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 307         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
 308                           0)
 309
 310 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr)                   \
 311         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
 312                           CMD_ATTR_DEPRECATED, 0)
 313
 314 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr)                   \
 315         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 316
 317 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)            \
 318         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
 319                           daemon)
 320
 321 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)        \
 322         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
 323                           CMD_ATTR_DEPRECATED, daemon)
 324
 325 #else /* VTYSH_EXTRACT_PL */
 326 #define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
 327         DEFUN(funcname, cmdname, cmdstr, helpstr)
 328
 329 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
 330         DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)
 331
 332 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 333         DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
 334
 335 #define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 336         DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)
 337 #endif /* VTYSH_EXTRACT_PL */
 338
 339 /* Some macroes */
 340
 341 /*
 342  * Sometimes #defines create maximum values that
 343  * need to have strings created from them that
 344  * allow the parser to match against them.
 345  * These macros allow that.
 346  */
 347 #define CMD_CREATE_STR(s)  CMD_CREATE_STR_HELPER(s)
 348 #define CMD_CREATE_STR_HELPER(s) #s
 349 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
 350
 351 /* Common descriptions. */
 352 #define SHOW_STR "Show running system information\n"
 353 #define IP_STR "IP information\n"
 354 #define IPV6_STR "IPv6 information\n"
 355 #define NO_STR "Negate a command or set its defaults\n"
 356 #define REDIST_STR "Redistribute information from another routing protocol\n"
 357 #define CLEAR_STR "Reset functions\n"
 358 #define RIP_STR "RIP information\n"
 359 #define EIGRP_STR "EIGRP information\n"
 360 #define BGP_STR "BGP information\n"
 361 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
 362 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
 363 #define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
 364 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
 365 #define OSPF_STR "OSPF information\n"
 366 #define NEIGHBOR_STR "Specify neighbor router\n"
 367 #define DEBUG_STR "Debugging functions\n"
 368 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 369 #define ROUTER_STR "Enable a routing process\n"
 370 #define AS_STR "AS number\n"
 371 #define MAC_STR "MAC address\n"
 372 #define MBGP_STR "MBGP information\n"
 373 #define MATCH_STR "Match values from routing table\n"
 374 #define SET_STR "Set values in destination routing protocol\n"
 375 #define OUT_STR "Filter outgoing routing updates\n"
 376 #define IN_STR  "Filter incoming routing updates\n"
 377 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 378 #define OSPF6_NUMBER_STR "Specify by number\n"
 379 #define INTERFACE_STR "Interface information\n"
 380 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 381 #define IP6_STR "IPv6 Information\n"
 382 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 383 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
 384 #define SECONDS_STR "Seconds\n"
 385 #define ROUTE_STR "Routing Table\n"
 386 #define PREFIX_LIST_STR "Build a prefix list\n"
 387 #define OSPF6_DUMP_TYPE_LIST                                                   \
 388         "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
 389 #define AREA_TAG_STR "[area tag]\n"
 390 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
 391 #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"
 392 #define MPLS_TE_STR "MPLS-TE specific commands\n"
 393 #define LINK_PARAMS_STR "Configure interface link parameters\n"
 394 #define OSPF_RI_STR "OSPF Router Information specific commands\n"
 395 #define PCE_STR "PCE Router Information specific commands\n"
 396 #define MPLS_STR "MPLS information\n"
 397 #define SR_STR "Segment-Routing specific commands\n"
 398 #define WATCHFRR_STR "watchfrr information\n"
 399 #define ZEBRA_STR "Zebra information\n"
 400 #define FILTER_LOG_STR "Filter Logs\n"
 401
 402 #define CMD_VNI_RANGE "(1-16777215)"
 403 #define CONF_BACKUP_EXT ".sav"
 404
 405 /* Command warnings. */
 406 #define NO_PASSWD_CMD_WARNING                                                  \
 407         "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
 408
 409 /* IPv4 only machine should not accept IPv6 address for peer's IP
 410    address.  So we replace VTY command string like below. */
 411 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 412 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
 413 #define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
 414
 415 /* Daemons lists */
 416 #define DAEMONS_STR                                                            \
 417         "For the zebra daemon\nFor the rip daemon\nFor the ripng daemon\nFor the ospf daemon\nFor the ospfv6 daemon\nFor the bgp daemon\nFor the isis daemon\nFor the pbr daemon\nFor the fabricd daemon\nFor the pim daemon\nFor the static daemon\nFor the sharpd daemon\nFor the vrrpd daemon\nFor the ldpd daemon\n"
 418 #define DAEMONS_LIST                                                           \
 419         "<zebra|ripd|ripngd|ospfd|ospf6d|bgpd|isisd|pbrd|fabricd|pimd|staticd|sharpd|vrrpd|ldpd>"
 420
 421 /* Graceful Restart cli help strings */
 422 #define GR_CMD "Global Graceful Restart command\n"
 423 #define NO_GR_CMD "Undo Global Graceful Restart command\n"
 424 #define GR "Global Graceful Restart - GR Mode\n"
 425 #define GR_DISABLE "Global Graceful Restart - Disable Mode\n"
 426 #define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode\n"
 427 #define GR_DEBUG "Graceful Restart - Enable Debug Logs\n"
 428 #define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode\n"
 429 #define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor\n"
 430 #define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor\n"
 431 #define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor\n"
 432 #define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor\n"
 433 #define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor\n"
 434 #define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor\n"
 435
 436 /* Prototypes. */
 437 extern void install_node(struct cmd_node *node, int (*)(struct vty *));
 438 extern void install_default(enum node_type);
 439 extern void install_element(enum node_type, const struct cmd_element *);
 440
 441 /* known issue with uninstall_element:  changes to cmd_token->attr (i.e.
 442  * deprecated/hidden) are not reversed. */
 443 extern void uninstall_element(enum node_type, const struct cmd_element *);
 444
 445 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 446    string with a space between each element (allocated using
 447    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 448 extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
 449
 450 /*
 451  * It is preferred that you set the index initial value
 452  * to a 0.  This way in the future if you modify the
 453  * cli then there is no need to modify the initial
 454  * value of the index
 455  */
 456 extern int argv_find(struct cmd_token **argv, int argc, const char *text,
 457                      int *index);
 458
 459 extern vector cmd_make_strvec(const char *);
 460 extern void cmd_free_strvec(vector);
 461 extern vector cmd_describe_command(vector, struct vty *, int *status);
 462 extern char **cmd_complete_command(vector, struct vty *, int *status);
 463 extern const char *cmd_prompt(enum node_type);
 464 extern int command_config_read_one_line(struct vty *vty,
 465                                         const struct cmd_element **,
 466                                         uint32_t line_num, int use_config_node);
 467 extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
 468 extern enum node_type node_parent(enum node_type);
 469 /*
 470  * Execute command under the given vty context.
 471  *
 472  * vty
 473  *    The vty context to execute under.
 474  *
 475  * cmd
 476  *    The command string to execute.
 477  *
 478  * matched
 479  *    If non-null and a match was found, the address of the matched command is
 480  *    stored here. No action otherwise.
 481  *
 482  * vtysh
 483  *    Whether or not this is being called from vtysh. If this is nonzero,
 484  *    XXX: then what?
 485  *
 486  * Returns:
 487  *    XXX: what does it return
 488  */
 489 extern int cmd_execute(struct vty *vty, const char *cmd,
 490                        const struct cmd_element **matched, int vtysh);
 491 extern int cmd_execute_command(vector, struct vty *,
 492                                const struct cmd_element **, int);
 493 extern int cmd_execute_command_strict(vector, struct vty *,
 494                                       const struct cmd_element **);
 495 extern void cmd_init(int);
 496 extern void cmd_terminate(void);
 497 extern void cmd_exit(struct vty *vty);
 498 extern int cmd_list_cmds(struct vty *vty, int do_permute);
 499
 500 extern int cmd_domainname_set(const char *domainname);
 501 extern int cmd_hostname_set(const char *hostname);
 502 extern const char *cmd_hostname_get(void);
 503 extern const char *cmd_domainname_get(void);
 504
 505 /* NOT safe for general use; call this only if DEV_BUILD! */
 506 extern void grammar_sandbox_init(void);
 507
 508 extern vector completions_to_vec(struct list *completions);
 509
 510 /* Export typical functions. */
 511 extern const char *host_config_get(void);
 512 extern void host_config_set(const char *);
 513
 514 extern void print_version(const char *);
 515
 516 extern int cmd_banner_motd_file(const char *);
 517 extern void cmd_banner_motd_line(const char *line);
 518
 519 /* struct host global, ick */
 520 extern struct host host;
 521
 522 struct cmd_variable_handler {
 523         const char *tokenname, *varname;
 524         void (*completions)(vector out, struct cmd_token *token);
 525 };
 526
 527 extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
 528                                   vector comps);
 529 extern void
 530 cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
 531 extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
 532
 533 extern void command_setup_early_logging(const char *dest, const char *level);
 534
 535 #ifdef __cplusplus
 536 }
 537 #endif
 538
 539 #endif /* _ZEBRA_COMMAND_H */