2 * CLI backend interface.
5 * Copyright (C) 2016 Cumulus Networks, Inc.
6 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
7 * Copyright (C) 2013 by Open Source Routing.
8 * Copyright (C) 2013 by Internet Systems Consortium, Inc. ("ISC")
10 * This file is part of GNU Zebra.
12 * GNU Zebra is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2, or (at your option) any
17 * GNU Zebra is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; see the file COPYING; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <lib/version.h>
39 #include "workqueue.h"
41 #include "command_match.h"
42 #include "command_graph.h"
48 #include "lib_errors.h"
50 DEFINE_MTYPE(LIB
, HOST
, "Host config")
51 DEFINE_MTYPE(LIB
, COMPLETION
, "Completion item")
58 /* clang-format off */
59 const struct message tokennames
[] = {
64 item(IPV4_PREFIX_TKN
),
66 item(IPV6_PREFIX_TKN
),
76 const char *node_names
[] = {
79 "auth enable", // AUTH_ENABLE_NODE,
80 "enable", // ENABLE_NODE,
81 "config", // CONFIG_NODE,
82 "debug", // DEBUG_NODE,
83 "vrf debug", // VRF_DEBUG_NODE,
84 "vnc debug", // DEBUG_VNC_NODE,
86 "keychain", // KEYCHAIN_NODE,
87 "keychain key", // KEYCHAIN_KEY_NODE,
88 "logical-router", // LOGICALROUTER_NODE,
89 "static ip", // IP_NODE,
91 "interface", // INTERFACE_NODE,
92 "nexthop-group", // NH_GROUP_NODE,
93 "zebra", // ZEBRA_NODE,
94 "table", // TABLE_NODE,
96 "ripng", // RIPNG_NODE,
97 "babel", // BABEL_NODE,
98 "eigrp", // EIGRP_NODE,
100 "bgp vpnv4", // BGP_VPNV4_NODE,
101 "bgp vpnv6", // BGP_VPNV6_NODE,
102 "bgp ipv4 unicast", // BGP_IPV4_NODE,
103 "bgp ipv4 multicast", // BGP_IPV4M_NODE,
104 "bgp ipv4 labeled unicast", // BGP_IPV4L_NODE,
105 "bgp ipv6", // BGP_IPV6_NODE,
106 "bgp ipv6 multicast", // BGP_IPV6M_NODE,
107 "bgp ipv6 labeled unicast", // BGP_IPV6L_NODE,
108 "bgp vrf policy", // BGP_VRF_POLICY_NODE,
109 "bgp vnc defaults", // BGP_VNC_DEFAULTS_NODE,
110 "bgp vnc nve", // BGP_VNC_NVE_GROUP_NODE,
111 "bgp vnc l2", // BGP_VNC_L2_GROUP_NODE,
112 "rfp defaults", // RFP_DEFAULTS_NODE,
113 "bgp evpn", // BGP_EVPN_NODE,
114 "ospf", // OSPF_NODE,
115 "ospf6", // OSPF6_NODE,
117 "ldp ipv4", // LDP_IPV4_NODE,
118 "ldp ipv6", // LDP_IPV6_NODE,
119 "ldp ipv4 interface", // LDP_IPV4_IFACE_NODE,
120 "ldp ipv6 interface", // LDP_IPV6_IFACE_NODE,
121 "ldp l2vpn", // LDP_L2VPN_NODE,
122 "ldp", // LDP_PSEUDOWIRE_NODE,
123 "isis", // ISIS_NODE,
124 "ipv4 access list", // ACCESS_NODE,
125 "ipv4 prefix list", // PREFIX_NODE,
126 "ipv6 access list", // ACCESS_IPV6_NODE,
127 "MAC access list", // ACCESS_MAC_NODE,
128 "ipv6 prefix list", // PREFIX_IPV6_NODE,
129 "as list", // AS_LIST_NODE,
130 "community list", // COMMUNITY_LIST_NODE,
131 "routemap", // RMAP_NODE,
132 "pbr-map", // PBRMAP_NODE,
133 "smux", // SMUX_NODE,
134 "dump", // DUMP_NODE,
135 "forwarding", // FORWARDING_NODE,
136 "protocol", // PROTOCOL_NODE,
137 "mpls", // MPLS_NODE,
140 "link-params", // LINK_PARAMS_NODE,
141 "bgp evpn vni", // BGP_EVPN_VNI_NODE,
143 "bgp ipv4 flowspec", /* BGP_FLOWSPECV4_NODE
145 "bgp ipv6 flowspec", /* BGP_FLOWSPECV6_NODE
147 "bfd", /* BFD_NODE */
148 "bfd peer", /* BFD_PEER_NODE */
149 "openfabric", // OPENFABRIC_NODE
151 /* clang-format on */
153 /* Command vector which includes some level of command lists. Normally
154 each daemon maintains each own cmdvec. */
155 vector cmdvec
= NULL
;
157 /* Host information structure. */
161 * Returns host.name if any, otherwise
162 * it returns the system hostname.
164 const char *cmd_hostname_get(void)
170 * Returns unix domainname
172 const char *cmd_domainname_get(void)
174 return host
.domainname
;
177 /* Standard command node structures. */
178 static struct cmd_node auth_node
= {
179 AUTH_NODE
, "Password: ",
182 static struct cmd_node view_node
= {
186 static struct cmd_node auth_enable_node
= {
187 AUTH_ENABLE_NODE
, "Password: ",
190 static struct cmd_node enable_node
= {
194 static struct cmd_node config_node
= {CONFIG_NODE
, "%s(config)# ", 1};
196 /* Default motd string. */
197 static const char *default_motd
= FRR_DEFAULT_MOTD
;
199 static const struct facility_map
{
203 } syslog_facilities
[] = {
204 {LOG_KERN
, "kern", 1},
205 {LOG_USER
, "user", 2},
206 {LOG_MAIL
, "mail", 1},
207 {LOG_DAEMON
, "daemon", 1},
208 {LOG_AUTH
, "auth", 1},
209 {LOG_SYSLOG
, "syslog", 1},
211 {LOG_NEWS
, "news", 1},
212 {LOG_UUCP
, "uucp", 2},
213 {LOG_CRON
, "cron", 1},
217 {LOG_LOCAL0
, "local0", 6},
218 {LOG_LOCAL1
, "local1", 6},
219 {LOG_LOCAL2
, "local2", 6},
220 {LOG_LOCAL3
, "local3", 6},
221 {LOG_LOCAL4
, "local4", 6},
222 {LOG_LOCAL5
, "local5", 6},
223 {LOG_LOCAL6
, "local6", 6},
224 {LOG_LOCAL7
, "local7", 6},
228 static const char *facility_name(int facility
)
230 const struct facility_map
*fm
;
232 for (fm
= syslog_facilities
; fm
->name
; fm
++)
233 if (fm
->facility
== facility
)
238 static int facility_match(const char *str
)
240 const struct facility_map
*fm
;
242 for (fm
= syslog_facilities
; fm
->name
; fm
++)
243 if (!strncmp(str
, fm
->name
, fm
->match
))
248 static int level_match(const char *s
)
252 for (level
= 0; zlog_priority
[level
] != NULL
; level
++)
253 if (!strncmp(s
, zlog_priority
[level
], 2))
255 return ZLOG_DISABLED
;
258 /* This is called from main when a daemon is invoked with -v or --version. */
259 void print_version(const char *progname
)
261 printf("%s version %s\n", progname
, FRR_VERSION
);
262 printf("%s\n", FRR_COPYRIGHT
);
263 printf("configured with:\n\t%s\n", FRR_CONFIG_ARGS
);
266 char *argv_concat(struct cmd_token
**argv
, int argc
, int shift
)
268 int cnt
= MAX(argc
- shift
, 0);
269 const char *argstr
[cnt
+ 1];
274 for (int i
= 0; i
< cnt
; i
++)
275 argstr
[i
] = argv
[i
+ shift
]->arg
;
277 return frrstr_join(argstr
, cnt
, " ");
280 vector
cmd_make_strvec(const char *string
)
285 const char *copy
= string
;
287 /* skip leading whitespace */
288 while (isspace((int)*copy
) && *copy
!= '\0')
291 /* if the entire string was whitespace or a comment, return */
292 if (*copy
== '\0' || *copy
== '!' || *copy
== '#')
295 vector result
= frrstr_split_vec(copy
, "\n\r\t ");
297 for (unsigned int i
= 0; i
< vector_active(result
); i
++) {
298 if (strlen(vector_slot(result
, i
)) == 0) {
299 XFREE(MTYPE_TMP
, vector_slot(result
, i
));
300 vector_unset(result
, i
);
304 vector_compact(result
);
309 void cmd_free_strvec(vector v
)
311 frrstr_strvec_free(v
);
315 * Convenience function for accessing argv data.
319 * @param text definition snippet of the desired token
320 * @param index the starting index, and where to store the
321 * index of the found token if it exists
322 * @return 1 if found, 0 otherwise
324 int argv_find(struct cmd_token
**argv
, int argc
, const char *text
, int *index
)
327 for (int i
= *index
; i
< argc
&& found
== 0; i
++)
328 if ((found
= strmatch(text
, argv
[i
]->text
)))
333 static unsigned int cmd_hash_key(void *p
)
335 int size
= sizeof(p
);
337 return jhash(p
, size
, 0);
340 static int cmd_hash_cmp(const void *a
, const void *b
)
345 /* Install top node of command vector. */
346 void install_node(struct cmd_node
*node
, int (*func
)(struct vty
*))
348 vector_set_index(cmdvec
, node
->node
, node
);
350 node
->cmdgraph
= graph_new();
351 node
->cmd_vector
= vector_init(VECTOR_MIN_SIZE
);
353 struct cmd_token
*token
=
354 cmd_token_new(START_TKN
, CMD_ATTR_NORMAL
, NULL
, NULL
);
355 graph_new_node(node
->cmdgraph
, token
,
356 (void (*)(void *)) & cmd_token_del
);
357 node
->cmd_hash
= hash_create_size(16, cmd_hash_key
, cmd_hash_cmp
,
361 /* Return prompt character of specified node. */
362 const char *cmd_prompt(enum node_type node
)
364 struct cmd_node
*cnode
;
366 cnode
= vector_slot(cmdvec
, node
);
367 return cnode
->prompt
;
370 /* Install a command into a node. */
371 void install_element(enum node_type ntype
, struct cmd_element
*cmd
)
373 struct cmd_node
*cnode
;
375 /* cmd_init hasn't been called */
377 fprintf(stderr
, "%s called before cmd_init, breakage likely\n",
382 cnode
= vector_lookup(cmdvec
, ntype
);
387 "\tnode %d (%s) does not exist.\n"
388 "\tplease call install_node() before install_element()\n",
389 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
393 if (hash_lookup(cnode
->cmd_hash
, cmd
) != NULL
) {
396 "\tnode %d (%s) already has this command installed.\n"
397 "\tduplicate install_element call?\n",
398 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
402 assert(hash_get(cnode
->cmd_hash
, cmd
, hash_alloc_intern
));
404 struct graph
*graph
= graph_new();
405 struct cmd_token
*token
=
406 cmd_token_new(START_TKN
, CMD_ATTR_NORMAL
, NULL
, NULL
);
407 graph_new_node(graph
, token
, (void (*)(void *)) & cmd_token_del
);
409 cmd_graph_parse(graph
, cmd
);
410 cmd_graph_names(graph
);
411 cmd_graph_merge(cnode
->cmdgraph
, graph
, +1);
412 graph_delete_graph(graph
);
414 vector_set(cnode
->cmd_vector
, cmd
);
416 if (ntype
== VIEW_NODE
)
417 install_element(ENABLE_NODE
, cmd
);
420 void uninstall_element(enum node_type ntype
, struct cmd_element
*cmd
)
422 struct cmd_node
*cnode
;
424 /* cmd_init hasn't been called */
426 fprintf(stderr
, "%s called before cmd_init, breakage likely\n",
431 cnode
= vector_lookup(cmdvec
, ntype
);
436 "\tnode %d (%s) does not exist.\n"
437 "\tplease call install_node() before uninstall_element()\n",
438 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
442 if (hash_release(cnode
->cmd_hash
, cmd
) == NULL
) {
445 "\tnode %d (%s) does not have this command installed.\n"
446 "\tduplicate uninstall_element call?\n",
447 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
451 vector_unset_value(cnode
->cmd_vector
, cmd
);
453 struct graph
*graph
= graph_new();
454 struct cmd_token
*token
=
455 cmd_token_new(START_TKN
, CMD_ATTR_NORMAL
, NULL
, NULL
);
456 graph_new_node(graph
, token
, (void (*)(void *)) & cmd_token_del
);
458 cmd_graph_parse(graph
, cmd
);
459 cmd_graph_names(graph
);
460 cmd_graph_merge(cnode
->cmdgraph
, graph
, -1);
461 graph_delete_graph(graph
);
463 if (ntype
== VIEW_NODE
)
464 uninstall_element(ENABLE_NODE
, cmd
);
468 static const unsigned char itoa64
[] =
469 "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
471 static void to64(char *s
, long v
, int n
)
474 *s
++ = itoa64
[v
& 0x3f];
479 static char *zencrypt(const char *passwd
)
483 char *crypt(const char *, const char *);
485 gettimeofday(&tv
, 0);
487 to64(&salt
[0], random(), 3);
488 to64(&salt
[3], tv
.tv_usec
, 3);
491 return crypt(passwd
, salt
);
494 /* This function write configuration of this host. */
495 static int config_write_host(struct vty
*vty
)
497 if (cmd_hostname_get())
498 vty_out(vty
, "hostname %s\n", cmd_hostname_get());
500 if (cmd_domainname_get())
501 vty_out(vty
, "domainname %s\n", cmd_domainname_get());
503 /* The following are all configuration commands that are not sent to
504 * watchfrr. For instance watchfrr is hardcoded to log to syslog so
505 * we would always display 'log syslog informational' in the config
506 * which would cause other daemons to then switch to syslog when they
509 if (strcmp(zlog_default
->protoname
, "WATCHFRR")) {
511 if (host
.password_encrypt
)
512 vty_out(vty
, "password 8 %s\n",
513 host
.password_encrypt
);
514 if (host
.enable_encrypt
)
515 vty_out(vty
, "enable password 8 %s\n",
516 host
.enable_encrypt
);
519 vty_out(vty
, "password %s\n", host
.password
);
521 vty_out(vty
, "enable password %s\n",
526 && (zlog_default
->maxlvl
[ZLOG_DEST_FILE
]
528 vty_out(vty
, "log file %s", host
.logfile
);
529 if (zlog_default
->maxlvl
[ZLOG_DEST_FILE
]
530 != zlog_default
->default_lvl
)
533 [zlog_default
->maxlvl
538 if (zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
] != ZLOG_DISABLED
) {
539 vty_out(vty
, "log stdout");
540 if (zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
]
541 != zlog_default
->default_lvl
)
544 [zlog_default
->maxlvl
545 [ZLOG_DEST_STDOUT
]]);
549 if (zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
] == ZLOG_DISABLED
)
550 vty_out(vty
, "no log monitor\n");
551 else if (zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
]
552 != zlog_default
->default_lvl
)
553 vty_out(vty
, "log monitor %s\n",
554 zlog_priority
[zlog_default
->maxlvl
555 [ZLOG_DEST_MONITOR
]]);
557 if (zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
] != ZLOG_DISABLED
) {
558 vty_out(vty
, "log syslog");
559 if (zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
]
560 != zlog_default
->default_lvl
)
562 zlog_priority
[zlog_default
->maxlvl
563 [ZLOG_DEST_SYSLOG
]]);
567 if (zlog_default
->facility
!= LOG_DAEMON
)
568 vty_out(vty
, "log facility %s\n",
569 facility_name(zlog_default
->facility
));
571 if (zlog_default
->record_priority
== 1)
572 vty_out(vty
, "log record-priority\n");
574 if (zlog_default
->timestamp_precision
> 0)
575 vty_out(vty
, "log timestamp precision %d\n",
576 zlog_default
->timestamp_precision
);
579 vty_out(vty
, "service advanced-vty\n");
582 vty_out(vty
, "service password-encryption\n");
585 vty_out(vty
, "service terminal-length %d\n",
589 vty_out(vty
, "banner motd file %s\n", host
.motdfile
);
591 vty_out(vty
, "no banner motd\n");
594 if (debug_memstats_at_exit
)
595 vty_out(vty
, "!\ndebug memstats-at-exit\n");
600 /* Utility function for getting command graph. */
601 static struct graph
*cmd_node_graph(vector v
, enum node_type ntype
)
603 struct cmd_node
*cnode
= vector_slot(v
, ntype
);
604 return cnode
->cmdgraph
;
607 static int cmd_try_do_shortcut(enum node_type node
, char *first_word
)
609 if (first_word
!= NULL
&& node
!= AUTH_NODE
&& node
!= VIEW_NODE
610 && node
!= AUTH_ENABLE_NODE
&& 0 == strcmp("do", first_word
))
616 * Compare function for cmd_token.
617 * Used with qsort to sort command completions.
619 static int compare_completions(const void *fst
, const void *snd
)
621 struct cmd_token
*first
= *(struct cmd_token
**)fst
,
622 *secnd
= *(struct cmd_token
**)snd
;
623 return strcmp(first
->text
, secnd
->text
);
627 * Takes a list of completions returned by command_complete,
628 * dedeuplicates them based on both text and description,
629 * sorts them, and returns them as a vector.
631 * @param completions linked list of cmd_token
632 * @return deduplicated and sorted vector with
634 vector
completions_to_vec(struct list
*completions
)
636 vector comps
= vector_init(VECTOR_MIN_SIZE
);
639 struct cmd_token
*token
, *cr
= NULL
;
640 unsigned int i
, exists
;
641 for (ALL_LIST_ELEMENTS_RO(completions
, ln
, token
)) {
642 if (token
->type
== END_TKN
&& (cr
= token
))
645 // linear search for token in completions vector
647 for (i
= 0; i
< vector_active(comps
) && !exists
; i
++) {
648 struct cmd_token
*curr
= vector_slot(comps
, i
);
650 exists
= !strcmp(curr
->text
, token
->text
)
651 && !strcmp(curr
->desc
, token
->desc
);
653 exists
= !strcmp(curr
->text
, token
->text
);
654 #endif /* VTYSH_DEBUG */
658 vector_set(comps
, token
);
662 qsort(comps
->index
, vector_active(comps
), sizeof(void *),
663 &compare_completions
);
665 // make <cr> the first element, if it is present
667 vector_set_index(comps
, vector_active(comps
), NULL
);
668 memmove(comps
->index
+ 1, comps
->index
,
669 (comps
->alloced
- 1) * sizeof(void *));
670 vector_set_index(comps
, 0, cr
);
676 * Generates a vector of cmd_token representing possible completions
677 * on the current input.
679 * @param vline the vectorized input line
680 * @param vty the vty with the node to match on
681 * @param status pointer to matcher status code
682 * @return vector of struct cmd_token * with possible completions
684 static vector
cmd_complete_command_real(vector vline
, struct vty
*vty
,
687 struct list
*completions
;
688 struct graph
*cmdgraph
= cmd_node_graph(cmdvec
, vty
->node
);
690 enum matcher_rv rv
= command_complete(cmdgraph
, vline
, &completions
);
692 if (MATCHER_ERROR(rv
)) {
693 *status
= CMD_ERR_NO_MATCH
;
697 vector comps
= completions_to_vec(completions
);
698 list_delete_and_null(&completions
);
700 // set status code appropriately
701 switch (vector_active(comps
)) {
703 *status
= CMD_ERR_NO_MATCH
;
706 *status
= CMD_COMPLETE_FULL_MATCH
;
709 *status
= CMD_COMPLETE_LIST_MATCH
;
715 vector
cmd_describe_command(vector vline
, struct vty
*vty
, int *status
)
719 if (cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0))) {
720 enum node_type onode
;
721 vector shifted_vline
;
725 vty
->node
= ENABLE_NODE
;
726 /* We can try it on enable node, cos' the vty is authenticated
729 shifted_vline
= vector_init(vector_count(vline
));
731 for (index
= 1; index
< vector_active(vline
); index
++) {
732 vector_set_index(shifted_vline
, index
- 1,
733 vector_lookup(vline
, index
));
736 ret
= cmd_complete_command_real(shifted_vline
, vty
, status
);
738 vector_free(shifted_vline
);
743 return cmd_complete_command_real(vline
, vty
, status
);
746 static struct list
*varhandlers
= NULL
;
748 void cmd_variable_complete(struct cmd_token
*token
, const char *arg
,
752 const struct cmd_variable_handler
*cvh
;
756 tmpcomps
= arg
? vector_init(VECTOR_MIN_SIZE
) : comps
;
758 for (ALL_LIST_ELEMENTS_RO(varhandlers
, ln
, cvh
)) {
759 if (cvh
->tokenname
&& strcmp(cvh
->tokenname
, token
->text
))
761 if (cvh
->varname
&& (!token
->varname
762 || strcmp(cvh
->varname
, token
->varname
)))
764 cvh
->completions(tmpcomps
, token
);
772 for (i
= vector_active(tmpcomps
); i
; i
--) {
773 char *item
= vector_slot(tmpcomps
, i
- 1);
774 if (strlen(item
) >= argsz
&& !strncmp(item
, arg
, argsz
))
775 vector_set(comps
, item
);
777 XFREE(MTYPE_COMPLETION
, item
);
779 vector_free(tmpcomps
);
782 #define AUTOCOMP_INDENT 5
784 char *cmd_variable_comp2str(vector comps
, unsigned short cols
)
787 char *buf
= XCALLOC(MTYPE_TMP
, bsz
);
788 int lc
= AUTOCOMP_INDENT
;
789 size_t cs
= AUTOCOMP_INDENT
;
791 snprintf(buf
, bsz
, "%*s", AUTOCOMP_INDENT
, "");
792 for (size_t j
= 0; j
< vector_active(comps
); j
++) {
793 char *item
= vector_slot(comps
, j
);
794 itemlen
= strlen(item
);
796 if (cs
+ itemlen
+ AUTOCOMP_INDENT
+ 3 >= bsz
)
797 buf
= XREALLOC(MTYPE_TMP
, buf
, (bsz
*= 2));
799 if (lc
+ itemlen
+ 1 >= cols
) {
800 cs
+= snprintf(&buf
[cs
], bsz
- cs
, "\n%*s",
801 AUTOCOMP_INDENT
, "");
802 lc
= AUTOCOMP_INDENT
;
805 size_t written
= snprintf(&buf
[cs
], bsz
- cs
, "%s ", item
);
808 XFREE(MTYPE_COMPLETION
, item
);
809 vector_set_index(comps
, j
, NULL
);
814 void cmd_variable_handler_register(const struct cmd_variable_handler
*cvh
)
819 for (; cvh
->completions
; cvh
++)
820 listnode_add(varhandlers
, (void *)cvh
);
823 DEFUN_HIDDEN (autocomplete
,
825 "autocomplete TYPE TEXT VARNAME",
826 "Autocompletion handler (internal, for vtysh)\n"
829 "cmd_token->varname\n")
831 struct cmd_token tok
;
832 vector comps
= vector_init(32);
835 memset(&tok
, 0, sizeof(tok
));
836 tok
.type
= atoi(argv
[1]->arg
);
837 tok
.text
= argv
[2]->arg
;
838 tok
.varname
= argv
[3]->arg
;
839 if (!strcmp(tok
.varname
, "-"))
842 cmd_variable_complete(&tok
, NULL
, comps
);
844 for (i
= 0; i
< vector_active(comps
); i
++) {
845 char *text
= vector_slot(comps
, i
);
846 vty_out(vty
, "%s\n", text
);
847 XFREE(MTYPE_COMPLETION
, text
);
855 * Generate possible tab-completions for the given input. This function only
856 * returns results that would result in a valid command if used as Readline
857 * completions (as is the case in vtysh). For instance, if the passed vline ends
858 * with '4.3.2', the strings 'A.B.C.D' and 'A.B.C.D/M' will _not_ be returned.
860 * @param vline vectorized input line
862 * @param status location to store matcher status code in
863 * @return set of valid strings for use with Readline as tab-completions.
866 char **cmd_complete_command(vector vline
, struct vty
*vty
, int *status
)
869 int original_node
= vty
->node
;
870 vector input_line
= vector_init(vector_count(vline
));
872 // if the first token is 'do' we'll want to execute the command in the
874 int do_shortcut
= cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0));
875 vty
->node
= do_shortcut
? ENABLE_NODE
: original_node
;
877 // construct the input line we'll be matching on
878 unsigned int offset
= (do_shortcut
) ? 1 : 0;
879 for (unsigned index
= 0; index
+ offset
< vector_active(vline
); index
++)
880 vector_set_index(input_line
, index
,
881 vector_lookup(vline
, index
+ offset
));
883 // get token completions -- this is a copying operation
884 vector comps
= NULL
, initial_comps
;
885 initial_comps
= cmd_complete_command_real(input_line
, vty
, status
);
887 if (!MATCHER_ERROR(*status
)) {
888 assert(initial_comps
);
889 // filter out everything that is not suitable for a
891 comps
= vector_init(VECTOR_MIN_SIZE
);
892 for (unsigned int i
= 0; i
< vector_active(initial_comps
);
894 struct cmd_token
*token
= vector_slot(initial_comps
, i
);
895 if (token
->type
== WORD_TKN
)
896 vector_set(comps
, XSTRDUP(MTYPE_COMPLETION
,
898 else if (IS_VARYING_TOKEN(token
->type
)) {
899 const char *ref
= vector_lookup(
900 vline
, vector_active(vline
) - 1);
901 cmd_variable_complete(token
, ref
, comps
);
904 vector_free(initial_comps
);
906 // since we filtered results, we need to re-set status code
907 switch (vector_active(comps
)) {
909 *status
= CMD_ERR_NO_MATCH
;
912 *status
= CMD_COMPLETE_FULL_MATCH
;
915 *status
= CMD_COMPLETE_LIST_MATCH
;
918 // copy completions text into an array of char*
919 ret
= XMALLOC(MTYPE_TMP
,
920 (vector_active(comps
) + 1) * sizeof(char *));
922 for (i
= 0; i
< vector_active(comps
); i
++) {
923 ret
[i
] = vector_slot(comps
, i
);
925 // set the last element to NULL, because this array is used in
926 // a Readline completion_generator function which expects NULL
927 // as a sentinel value
931 } else if (initial_comps
)
932 vector_free(initial_comps
);
934 // comps should always be null here
937 // free the adjusted input line
938 vector_free(input_line
);
940 // reset vty->node to its original value
941 vty
->node
= original_node
;
946 /* return parent node */
947 /* MUST eventually converge on CONFIG_NODE */
948 enum node_type
node_parent(enum node_type node
)
952 assert(node
> CONFIG_NODE
);
957 case BGP_FLOWSPECV4_NODE
:
958 case BGP_FLOWSPECV6_NODE
:
959 case BGP_VRF_POLICY_NODE
:
960 case BGP_VNC_DEFAULTS_NODE
:
961 case BGP_VNC_NVE_GROUP_NODE
:
962 case BGP_VNC_L2_GROUP_NODE
:
972 case BGP_EVPN_VNI_NODE
:
975 case KEYCHAIN_KEY_NODE
:
978 case LINK_PARAMS_NODE
:
979 ret
= INTERFACE_NODE
;
985 case LDP_IPV4_IFACE_NODE
:
988 case LDP_IPV6_IFACE_NODE
:
991 case LDP_PSEUDOWIRE_NODE
:
992 ret
= LDP_L2VPN_NODE
;
1005 /* Execute command by argument vline vector. */
1006 static int cmd_execute_command_real(vector vline
, enum filter_type filter
,
1008 const struct cmd_element
**cmd
)
1010 struct list
*argv_list
;
1011 enum matcher_rv status
;
1012 const struct cmd_element
*matched_element
= NULL
;
1014 struct graph
*cmdgraph
= cmd_node_graph(cmdvec
, vty
->node
);
1015 status
= command_match(cmdgraph
, vline
, &argv_list
, &matched_element
);
1018 *cmd
= matched_element
;
1020 // if matcher error, return corresponding CMD_ERR
1021 if (MATCHER_ERROR(status
)) {
1023 list_delete_and_null(&argv_list
);
1025 case MATCHER_INCOMPLETE
:
1026 return CMD_ERR_INCOMPLETE
;
1027 case MATCHER_AMBIGUOUS
:
1028 return CMD_ERR_AMBIGUOUS
;
1030 return CMD_ERR_NO_MATCH
;
1034 // build argv array from argv list
1035 struct cmd_token
**argv
= XMALLOC(
1036 MTYPE_TMP
, argv_list
->count
* sizeof(struct cmd_token
*));
1037 struct listnode
*ln
;
1038 struct cmd_token
*token
;
1040 for (ALL_LIST_ELEMENTS_RO(argv_list
, ln
, token
))
1043 int argc
= argv_list
->count
;
1046 if (matched_element
->daemon
)
1047 ret
= CMD_SUCCESS_DAEMON
;
1049 ret
= matched_element
->func(matched_element
, vty
, argc
, argv
);
1051 // delete list and cmd_token's in it
1052 list_delete_and_null(&argv_list
);
1053 XFREE(MTYPE_TMP
, argv
);
1059 * Execute a given command, handling things like "do ..." and checking
1060 * whether the given command might apply at a parent node if doesn't
1061 * apply for the current node.
1063 * @param vline Command line input, vector of char* where each element is
1065 * @param vty The vty context in which the command should be executed.
1066 * @param cmd Pointer where the struct cmd_element of the matched command
1067 * will be stored, if any. May be set to NULL if this info is
1069 * @param vtysh If set != 0, don't lookup the command at parent nodes.
1070 * @return The status of the command that has been executed or an error code
1071 * as to why no command could be executed.
1073 int cmd_execute_command(vector vline
, struct vty
*vty
,
1074 const struct cmd_element
**cmd
, int vtysh
)
1076 int ret
, saved_ret
= 0;
1077 enum node_type onode
, try_node
;
1079 onode
= try_node
= vty
->node
;
1081 if (cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0))) {
1082 vector shifted_vline
;
1085 vty
->node
= ENABLE_NODE
;
1086 /* We can try it on enable node, cos' the vty is authenticated
1089 shifted_vline
= vector_init(vector_count(vline
));
1091 for (index
= 1; index
< vector_active(vline
); index
++)
1092 vector_set_index(shifted_vline
, index
- 1,
1093 vector_lookup(vline
, index
));
1095 ret
= cmd_execute_command_real(shifted_vline
, FILTER_RELAXED
,
1098 vector_free(shifted_vline
);
1104 cmd_execute_command_real(vline
, FILTER_RELAXED
, vty
, cmd
);
1109 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1110 && ret
!= CMD_NOT_MY_INSTANCE
&& ret
!= CMD_WARNING_CONFIG_FAILED
) {
1111 /* This assumes all nodes above CONFIG_NODE are childs of
1113 while (vty
->node
> CONFIG_NODE
) {
1114 try_node
= node_parent(try_node
);
1115 vty
->node
= try_node
;
1116 ret
= cmd_execute_command_real(vline
, FILTER_RELAXED
,
1118 if (ret
== CMD_SUCCESS
|| ret
== CMD_WARNING
1119 || ret
== CMD_NOT_MY_INSTANCE
1120 || ret
== CMD_WARNING_CONFIG_FAILED
)
1123 /* no command succeeded, reset the vty to the original node */
1127 /* return command status for original node */
1132 * Execute a given command, matching it strictly against the current node.
1133 * This mode is used when reading config files.
1135 * @param vline Command line input, vector of char* where each element is
1137 * @param vty The vty context in which the command should be executed.
1138 * @param cmd Pointer where the struct cmd_element* of the matched command
1139 * will be stored, if any. May be set to NULL if this info is
1141 * @return The status of the command that has been executed or an error code
1142 * as to why no command could be executed.
1144 int cmd_execute_command_strict(vector vline
, struct vty
*vty
,
1145 const struct cmd_element
**cmd
)
1147 return cmd_execute_command_real(vline
, FILTER_STRICT
, vty
, cmd
);
1151 * Hook for preprocessing command string before executing.
1153 * All subscribers are called with the raw command string that is to be
1154 * executed. If any changes are to be made, a new string should be allocated
1155 * with MTYPE_TMP and *cmd_out updated to point to this new string. The caller
1156 * is then responsible for freeing this string.
1158 * All processing functions must be mutually exclusive in their action, i.e. if
1159 * one subscriber decides to modify the command, all others must not modify it
1160 * when called. Feeding the output of one processing command into a subsequent
1161 * one is not supported.
1163 * This hook is intentionally internal to the command processing system.
1166 * The raw command string.
1169 * The result of any processing.
1171 DECLARE_HOOK(cmd_execute
,
1172 (struct vty
*vty
, const char *cmd_in
, char **cmd_out
),
1173 (vty
, cmd_in
, cmd_out
));
1174 DEFINE_HOOK(cmd_execute
, (struct vty
*vty
, const char *cmd_in
, char **cmd_out
),
1175 (vty
, cmd_in
, cmd_out
));
1177 /* Hook executed after a CLI command. */
1178 DECLARE_KOOH(cmd_execute_done
, (struct vty
*vty
, const char *cmd_exec
),
1180 DEFINE_KOOH(cmd_execute_done
, (struct vty
*vty
, const char *cmd_exec
),
1184 * cmd_execute hook subscriber to handle `|` actions.
1186 static int handle_pipe_action(struct vty
*vty
, const char *cmd_in
,
1190 char *orig
, *working
, *token
, *u
;
1191 char *pipe
= strstr(cmd_in
, "| ");
1196 /* duplicate string for processing purposes, not including pipe */
1197 orig
= working
= XSTRDUP(MTYPE_TMP
, pipe
+ 2);
1199 /* retrieve action */
1200 token
= strsep(&working
, " ");
1203 /* match result to known actions */
1204 if (strmatch(token
, "include")) {
1205 /* the remaining text should be a regexp */
1206 char *regexp
= working
;
1209 vty_out(vty
, "%% Need a regexp to filter with\n");
1213 bool succ
= vty_set_include(vty
, regexp
);
1216 vty_out(vty
, "%% Bad regexp '%s'\n", regexp
);
1219 *cmd_out
= XSTRDUP(MTYPE_TMP
, cmd_in
);
1223 vty_out(vty
, "%% Unknown action '%s'\n", token
);
1228 XFREE(MTYPE_TMP
, orig
);
1232 static int handle_pipe_action_done(struct vty
*vty
, const char *cmd_exec
)
1235 vty_set_include(vty
, NULL
);
1240 int cmd_execute(struct vty
*vty
, const char *cmd
,
1241 const struct cmd_element
**matched
, int vtysh
)
1244 char *cmd_out
= NULL
;
1245 const char *cmd_exec
;
1248 hook_call(cmd_execute
, vty
, cmd
, &cmd_out
);
1249 cmd_exec
= cmd_out
? (const char *)cmd_out
: cmd
;
1251 vline
= cmd_make_strvec(cmd_exec
);
1254 ret
= cmd_execute_command(vline
, vty
, matched
, vtysh
);
1255 cmd_free_strvec(vline
);
1260 hook_call(cmd_execute_done
, vty
, cmd_exec
);
1263 XFREE(MTYPE_TMP
, cmd_out
);
1270 * Parse one line of config, walking up the parse tree attempting to find a
1273 * @param vty The vty context in which the command should be executed.
1274 * @param cmd Pointer where the struct cmd_element* of the match command
1275 * will be stored, if any. May be set to NULL if this info is
1277 * @param use_daemon Boolean to control whether or not we match on
1278 * CMD_SUCCESS_DAEMON
1280 * @return The status of the command that has been executed or an error code
1281 * as to why no command could be executed.
1283 int command_config_read_one_line(struct vty
*vty
,
1284 const struct cmd_element
**cmd
, int use_daemon
)
1290 vline
= cmd_make_strvec(vty
->buf
);
1292 /* In case of comment line */
1296 /* Execute configuration command : this is strict match */
1297 ret
= cmd_execute_command_strict(vline
, vty
, cmd
);
1299 // Climb the tree and try the command again at each node
1300 if (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1301 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1302 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1303 && ret
!= CMD_NOT_MY_INSTANCE
&& ret
!= CMD_WARNING_CONFIG_FAILED
1304 && vty
->node
!= CONFIG_NODE
) {
1306 saved_node
= vty
->node
;
1308 while (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1309 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1310 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1311 && vty
->node
> CONFIG_NODE
) {
1312 vty
->node
= node_parent(vty
->node
);
1313 ret
= cmd_execute_command_strict(vline
, vty
, cmd
);
1316 // If climbing the tree did not work then ignore the command and
1317 // stay at the same node
1318 if (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1319 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1320 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
) {
1321 vty
->node
= saved_node
;
1325 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
)
1326 memcpy(vty
->error_buf
, vty
->buf
, VTY_BUFSIZ
);
1328 cmd_free_strvec(vline
);
1333 /* Configuration make from file. */
1334 int config_from_file(struct vty
*vty
, FILE *fp
, unsigned int *line_num
)
1336 int ret
, error_ret
= 0;
1339 while (fgets(vty
->buf
, VTY_BUFSIZ
, fp
)) {
1343 ret
= command_config_read_one_line(vty
, NULL
, 0);
1345 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1346 && ret
!= CMD_ERR_NOTHING_TODO
)
1357 /* Configuration from terminal */
1358 DEFUN (config_terminal
,
1359 config_terminal_cmd
,
1360 "configure terminal",
1361 "Configuration from vty interface\n"
1362 "Configuration terminal\n")
1364 if (vty_config_lock(vty
))
1365 vty
->node
= CONFIG_NODE
;
1367 vty_out(vty
, "VTY configuration is locked by other VTY\n");
1368 return CMD_WARNING_CONFIG_FAILED
;
1373 /* Enable command */
1377 "Turn on privileged mode command\n")
1379 /* If enable password is NULL, change to ENABLE_NODE */
1380 if ((host
.enable
== NULL
&& host
.enable_encrypt
== NULL
)
1381 || vty
->type
== VTY_SHELL_SERV
)
1382 vty
->node
= ENABLE_NODE
;
1384 vty
->node
= AUTH_ENABLE_NODE
;
1389 /* Disable command */
1393 "Turn off privileged mode command\n")
1395 if (vty
->node
== ENABLE_NODE
)
1396 vty
->node
= VIEW_NODE
;
1400 /* Down vty node level. */
1404 "Exit current mode and down to previous mode\n")
1410 void cmd_exit(struct vty
*vty
)
1412 switch (vty
->node
) {
1418 vty
->status
= VTY_CLOSE
;
1421 vty
->node
= ENABLE_NODE
;
1422 vty_config_unlock(vty
);
1424 case INTERFACE_NODE
:
1426 case LOGICALROUTER_NODE
:
1438 case LDP_L2VPN_NODE
:
1440 case OPENFABRIC_NODE
:
1446 vty
->node
= CONFIG_NODE
;
1449 case BGP_IPV4M_NODE
:
1450 case BGP_IPV4L_NODE
:
1451 case BGP_VPNV4_NODE
:
1452 case BGP_VPNV6_NODE
:
1453 case BGP_FLOWSPECV4_NODE
:
1454 case BGP_FLOWSPECV6_NODE
:
1455 case BGP_VRF_POLICY_NODE
:
1456 case BGP_VNC_DEFAULTS_NODE
:
1457 case BGP_VNC_NVE_GROUP_NODE
:
1458 case BGP_VNC_L2_GROUP_NODE
:
1460 case BGP_IPV6M_NODE
:
1462 case BGP_IPV6L_NODE
:
1463 vty
->node
= BGP_NODE
;
1465 case BGP_EVPN_VNI_NODE
:
1466 vty
->node
= BGP_EVPN_NODE
;
1470 vty
->node
= LDP_NODE
;
1472 case LDP_IPV4_IFACE_NODE
:
1473 vty
->node
= LDP_IPV4_NODE
;
1475 case LDP_IPV6_IFACE_NODE
:
1476 vty
->node
= LDP_IPV6_NODE
;
1478 case LDP_PSEUDOWIRE_NODE
:
1479 vty
->node
= LDP_L2VPN_NODE
;
1481 case KEYCHAIN_KEY_NODE
:
1482 vty
->node
= KEYCHAIN_NODE
;
1484 case LINK_PARAMS_NODE
:
1485 vty
->node
= INTERFACE_NODE
;
1488 vty
->node
= BFD_NODE
;
1499 "Exit current mode and down to previous mode\n")
1501 return config_exit(self
, vty
, argc
, argv
);
1505 /* End of configuration. */
1509 "End current mode and change to enable mode.\n")
1511 switch (vty
->node
) {
1514 /* Nothing to do. */
1517 case INTERFACE_NODE
:
1519 case LOGICALROUTER_NODE
:
1528 case BGP_VRF_POLICY_NODE
:
1529 case BGP_VNC_DEFAULTS_NODE
:
1530 case BGP_VNC_NVE_GROUP_NODE
:
1531 case BGP_VNC_L2_GROUP_NODE
:
1532 case BGP_VPNV4_NODE
:
1533 case BGP_VPNV6_NODE
:
1534 case BGP_FLOWSPECV4_NODE
:
1535 case BGP_FLOWSPECV6_NODE
:
1537 case BGP_IPV4M_NODE
:
1538 case BGP_IPV4L_NODE
:
1540 case BGP_IPV6M_NODE
:
1542 case BGP_EVPN_VNI_NODE
:
1543 case BGP_IPV6L_NODE
:
1551 case LDP_IPV4_IFACE_NODE
:
1552 case LDP_IPV6_IFACE_NODE
:
1553 case LDP_L2VPN_NODE
:
1554 case LDP_PSEUDOWIRE_NODE
:
1556 case OPENFABRIC_NODE
:
1558 case KEYCHAIN_KEY_NODE
:
1560 case LINK_PARAMS_NODE
:
1563 vty_config_unlock(vty
);
1564 vty
->node
= ENABLE_NODE
;
1573 DEFUN (show_version
,
1577 "Displays zebra version\n")
1579 vty_out(vty
, "%s %s (%s).\n", FRR_FULL_NAME
, FRR_VERSION
,
1580 cmd_hostname_get() ? cmd_hostname_get() : "");
1581 vty_out(vty
, "%s%s\n", FRR_COPYRIGHT
, GIT_INFO
);
1582 vty_out(vty
, "configured with:\n %s\n", FRR_CONFIG_ARGS
);
1587 /* "Set" version ... ignore version tags */
1588 DEFUN (frr_version_defaults
,
1589 frr_version_defaults_cmd
,
1590 "frr <version|defaults> LINE...",
1591 "FRRouting global parameters\n"
1592 "version configuration was written by\n"
1593 "set of configuration defaults used\n"
1599 /* Help display function for all node. */
1603 "Description of the interactive help system\n")
1606 "Quagga VTY provides advanced help feature. When you need help,\n\
1607 anytime at the command line please press '?'.\n\
1609 If nothing matches, the help list will be empty and you must backup\n\
1610 until entering a '?' shows the available options.\n\
1611 Two styles of help are provided:\n\
1612 1. Full help is available when you are ready to enter a\n\
1613 command argument (e.g. 'show ?') and describes each possible\n\
1615 2. Partial help is provided when an abbreviated argument is entered\n\
1616 and you want to know what arguments match the input\n\
1617 (e.g. 'show me?'.)\n\n");
1621 static void permute(struct graph_node
*start
, struct vty
*vty
)
1623 static struct list
*position
= NULL
;
1625 position
= list_new();
1627 struct cmd_token
*stok
= start
->data
;
1628 struct graph_node
*gnn
;
1629 struct listnode
*ln
;
1632 listnode_add(position
, start
);
1633 for (unsigned int i
= 0; i
< vector_active(start
->to
); i
++) {
1634 struct graph_node
*gn
= vector_slot(start
->to
, i
);
1635 struct cmd_token
*tok
= gn
->data
;
1636 if (tok
->attr
== CMD_ATTR_HIDDEN
1637 || tok
->attr
== CMD_ATTR_DEPRECATED
)
1639 else if (tok
->type
== END_TKN
|| gn
== start
) {
1641 for (ALL_LIST_ELEMENTS_RO(position
, ln
, gnn
)) {
1642 struct cmd_token
*tt
= gnn
->data
;
1643 if (tt
->type
< SPECIAL_TKN
)
1644 vty_out(vty
, " %s", tt
->text
);
1647 vty_out(vty
, "...");
1651 if (stok
->type
== FORK_TKN
&& tok
->type
!= FORK_TKN
)
1652 for (ALL_LIST_ELEMENTS_RO(position
, ln
, gnn
))
1661 list_delete_node(position
, listtail(position
));
1664 int cmd_list_cmds(struct vty
*vty
, int do_permute
)
1666 struct cmd_node
*node
= vector_slot(cmdvec
, vty
->node
);
1669 permute(vector_slot(node
->cmdgraph
->nodes
, 0), vty
);
1671 /* loop over all commands at this node */
1672 struct cmd_element
*element
= NULL
;
1673 for (unsigned int i
= 0; i
< vector_active(node
->cmd_vector
);
1675 if ((element
= vector_slot(node
->cmd_vector
, i
))
1676 && element
->attr
!= CMD_ATTR_DEPRECATED
1677 && element
->attr
!= CMD_ATTR_HIDDEN
)
1678 vty_out(vty
, " %s\n", element
->string
);
1683 /* Help display function for all node. */
1686 "list [permutations]",
1687 "Print command list\n"
1688 "Print all possible command permutations\n")
1690 return cmd_list_cmds(vty
, argc
== 2);
1693 DEFUN (show_commandtree
,
1694 show_commandtree_cmd
,
1695 "show commandtree [permutations]",
1697 "Show command tree\n"
1698 "Permutations that we are interested in\n")
1700 return cmd_list_cmds(vty
, argc
== 3);
1703 DEFUN_HIDDEN(show_cli_graph
,
1708 "Dump current command space as DOT graph\n")
1710 struct cmd_node
*cn
= vector_slot(cmdvec
, vty
->node
);
1711 char *dot
= cmd_graph_dump_dot(cn
->cmdgraph
);
1713 vty_out(vty
, "%s\n", dot
);
1714 XFREE(MTYPE_TMP
, dot
);
1718 static int vty_write_config(struct vty
*vty
)
1721 struct cmd_node
*node
;
1726 if (vty
->type
== VTY_TERM
) {
1727 vty_out(vty
, "\nCurrent configuration:\n");
1728 vty_out(vty
, "!\n");
1731 vty_out(vty
, "frr version %s\n", FRR_VER_SHORT
);
1732 vty_out(vty
, "frr defaults %s\n", DFLT_NAME
);
1733 vty_out(vty
, "!\n");
1735 for (i
= 0; i
< vector_active(cmdvec
); i
++)
1736 if ((node
= vector_slot(cmdvec
, i
)) && node
->func
1737 && (node
->vtysh
|| vty
->type
!= VTY_SHELL
)) {
1738 if ((*node
->func
)(vty
))
1739 vty_out(vty
, "!\n");
1742 if (vty
->type
== VTY_TERM
) {
1743 vty_out(vty
, "end\n");
1749 static int file_write_config(struct vty
*vty
)
1752 char *config_file
, *slash
;
1753 char *config_file_tmp
= NULL
;
1754 char *config_file_sav
= NULL
;
1755 int ret
= CMD_WARNING
;
1756 struct vty
*file_vty
;
1757 struct stat conf_stat
;
1762 /* Check and see if we are operating under vtysh configuration */
1763 if (host
.config
== NULL
) {
1765 "Can't save to configuration file, using vtysh.\n");
1770 config_file
= host
.config
;
1773 #define O_DIRECTORY 0
1775 slash
= strrchr(config_file
, '/');
1777 char *config_dir
= XSTRDUP(MTYPE_TMP
, config_file
);
1778 config_dir
[slash
- config_file
] = '\0';
1779 dirfd
= open(config_dir
, O_DIRECTORY
| O_RDONLY
);
1780 XFREE(MTYPE_TMP
, config_dir
);
1782 dirfd
= open(".", O_DIRECTORY
| O_RDONLY
);
1783 /* if dirfd is invalid, directory sync fails, but we're still OK */
1785 config_file_sav
= XMALLOC(
1786 MTYPE_TMP
, strlen(config_file
) + strlen(CONF_BACKUP_EXT
) + 1);
1787 strcpy(config_file_sav
, config_file
);
1788 strcat(config_file_sav
, CONF_BACKUP_EXT
);
1791 config_file_tmp
= XMALLOC(MTYPE_TMP
, strlen(config_file
) + 8);
1792 sprintf(config_file_tmp
, "%s.XXXXXX", config_file
);
1794 /* Open file to configuration write. */
1795 fd
= mkstemp(config_file_tmp
);
1797 vty_out(vty
, "Can't open configuration file %s.\n",
1801 if (fchmod(fd
, CONFIGFILE_MASK
) != 0) {
1802 vty_out(vty
, "Can't chmod configuration file %s: %s (%d).\n",
1803 config_file_tmp
, safe_strerror(errno
), errno
);
1807 /* Make vty for configuration file. */
1808 file_vty
= vty_new();
1810 file_vty
->type
= VTY_FILE
;
1812 /* Config file header print. */
1813 vty_out(file_vty
, "!\n! Zebra configuration saved from vty\n! ");
1814 vty_time_print(file_vty
, 1);
1815 vty_out(file_vty
, "!\n");
1816 vty_write_config(file_vty
);
1817 vty_close(file_vty
);
1819 if (stat(config_file
, &conf_stat
) >= 0) {
1820 if (unlink(config_file_sav
) != 0)
1821 if (errno
!= ENOENT
) {
1823 "Can't unlink backup configuration file %s.\n",
1827 if (link(config_file
, config_file_sav
) != 0) {
1829 "Can't backup old configuration file %s.\n",
1836 if (rename(config_file_tmp
, config_file
) != 0) {
1837 vty_out(vty
, "Can't save configuration file %s.\n",
1844 vty_out(vty
, "Configuration saved to %s\n", config_file
);
1848 if (ret
!= CMD_SUCCESS
)
1849 unlink(config_file_tmp
);
1852 XFREE(MTYPE_TMP
, config_file_tmp
);
1853 XFREE(MTYPE_TMP
, config_file_sav
);
1857 /* Write current configuration into file. */
1859 DEFUN (config_write
,
1861 "write [<file|memory|terminal>]",
1862 "Write running configuration to memory, network, or terminal\n"
1863 "Write to configuration file\n"
1864 "Write configuration currently in memory\n"
1865 "Write configuration to terminal\n")
1867 const int idx_type
= 1;
1869 // if command was 'write terminal' or 'write memory'
1870 if (argc
== 2 && (!strcmp(argv
[idx_type
]->text
, "terminal"))) {
1871 return vty_write_config(vty
);
1874 return file_write_config(vty
);
1877 /* ALIAS_FIXME for 'write <terminal|memory>' */
1878 DEFUN (show_running_config
,
1879 show_running_config_cmd
,
1880 "show running-config",
1882 "running configuration (same as write terminal)\n")
1884 return vty_write_config(vty
);
1887 /* ALIAS_FIXME for 'write file' */
1888 DEFUN (copy_runningconf_startupconf
,
1889 copy_runningconf_startupconf_cmd
,
1890 "copy running-config startup-config",
1891 "Copy configuration\n"
1892 "Copy running config to... \n"
1893 "Copy running config to startup config (same as write file/memory)\n")
1895 return file_write_config(vty
);
1899 /* Write startup configuration into the terminal. */
1900 DEFUN (show_startup_config
,
1901 show_startup_config_cmd
,
1902 "show startup-config",
1904 "Contents of startup configuration\n")
1911 if (host
.config
== NULL
)
1914 confp
= fopen(host
.config
, "r");
1915 if (confp
== NULL
) {
1916 vty_out(vty
, "Can't open configuration file [%s] due to '%s'\n",
1917 host
.config
, safe_strerror(errno
));
1921 while (fgets(buf
, BUFSIZ
, confp
)) {
1924 while (*cp
!= '\r' && *cp
!= '\n' && *cp
!= '\0')
1928 vty_out(vty
, "%s\n", buf
);
1936 int cmd_domainname_set(const char *domainname
)
1938 XFREE(MTYPE_HOST
, host
.domainname
);
1939 host
.domainname
= domainname
? XSTRDUP(MTYPE_HOST
, domainname
) : NULL
;
1943 /* Hostname configuration */
1944 DEFUN(config_domainname
,
1947 "Set system's domain name\n"
1948 "This system's domain name\n")
1950 struct cmd_token
*word
= argv
[1];
1952 if (!isalpha((int)word
->arg
[0])) {
1953 vty_out(vty
, "Please specify string starting with alphabet\n");
1954 return CMD_WARNING_CONFIG_FAILED
;
1957 return cmd_domainname_set(word
->arg
);
1960 DEFUN(config_no_domainname
,
1962 "no domainname [DOMAINNAME]",
1964 "Reset system's domain name\n"
1965 "domain name of this router\n")
1967 return cmd_domainname_set(NULL
);
1970 int cmd_hostname_set(const char *hostname
)
1972 XFREE(MTYPE_HOST
, host
.name
);
1973 host
.name
= hostname
? XSTRDUP(MTYPE_HOST
, hostname
) : NULL
;
1977 /* Hostname configuration */
1978 DEFUN (config_hostname
,
1981 "Set system's network name\n"
1982 "This system's network name\n")
1984 struct cmd_token
*word
= argv
[1];
1986 if (!isalnum((int)word
->arg
[0])) {
1987 vty_out(vty
, "Please specify string starting with alphabet\n");
1988 return CMD_WARNING_CONFIG_FAILED
;
1991 return cmd_hostname_set(word
->arg
);
1994 DEFUN (config_no_hostname
,
1996 "no hostname [HOSTNAME]",
1998 "Reset system's network name\n"
1999 "Host name of this router\n")
2001 return cmd_hostname_set(NULL
);
2004 /* VTY interface password set. */
2005 DEFUN (config_password
,
2007 "password [(8-8)] WORD",
2008 "Modify the terminal connection password\n"
2009 "Specifies a HIDDEN password will follow\n"
2010 "The password string\n")
2014 if (argc
== 3) // '8' was specified
2017 XFREE(MTYPE_HOST
, host
.password
);
2018 host
.password
= NULL
;
2019 if (host
.password_encrypt
)
2020 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2021 host
.password_encrypt
=
2022 XSTRDUP(MTYPE_HOST
, argv
[idx_word
]->arg
);
2026 if (!isalnum((int)argv
[idx_8
]->arg
[0])) {
2028 "Please specify string starting with alphanumeric\n");
2029 return CMD_WARNING_CONFIG_FAILED
;
2033 XFREE(MTYPE_HOST
, host
.password
);
2034 host
.password
= NULL
;
2037 if (host
.password_encrypt
)
2038 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2039 host
.password_encrypt
=
2040 XSTRDUP(MTYPE_HOST
, zencrypt(argv
[idx_8
]->arg
));
2042 host
.password
= XSTRDUP(MTYPE_HOST
, argv
[idx_8
]->arg
);
2047 /* VTY interface password delete. */
2048 DEFUN (no_config_password
,
2052 "Modify the terminal connection password\n")
2054 bool warned
= false;
2056 if (host
.password
) {
2057 if (!vty_shell_serv(vty
)) {
2058 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2061 XFREE(MTYPE_HOST
, host
.password
);
2063 host
.password
= NULL
;
2065 if (host
.password_encrypt
) {
2066 if (!warned
&& !vty_shell_serv(vty
))
2067 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2068 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2070 host
.password_encrypt
= NULL
;
2075 /* VTY enable password set. */
2076 DEFUN (config_enable_password
,
2077 enable_password_cmd
,
2078 "enable password [(8-8)] WORD",
2079 "Modify enable password parameters\n"
2080 "Assign the privileged level password\n"
2081 "Specifies a HIDDEN password will follow\n"
2082 "The HIDDEN 'enable' password string\n")
2087 /* Crypt type is specified. */
2089 if (argv
[idx_8
]->arg
[0] == '8') {
2091 XFREE(MTYPE_HOST
, host
.enable
);
2094 if (host
.enable_encrypt
)
2095 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2096 host
.enable_encrypt
=
2097 XSTRDUP(MTYPE_HOST
, argv
[idx_word
]->arg
);
2101 vty_out(vty
, "Unknown encryption type.\n");
2102 return CMD_WARNING_CONFIG_FAILED
;
2106 if (!isalnum((int)argv
[idx_8
]->arg
[0])) {
2108 "Please specify string starting with alphanumeric\n");
2109 return CMD_WARNING_CONFIG_FAILED
;
2113 XFREE(MTYPE_HOST
, host
.enable
);
2116 /* Plain password input. */
2118 if (host
.enable_encrypt
)
2119 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2120 host
.enable_encrypt
=
2121 XSTRDUP(MTYPE_HOST
, zencrypt(argv
[idx_8
]->arg
));
2123 host
.enable
= XSTRDUP(MTYPE_HOST
, argv
[idx_8
]->arg
);
2128 /* VTY enable password delete. */
2129 DEFUN (no_config_enable_password
,
2130 no_enable_password_cmd
,
2131 "no enable password",
2133 "Modify enable password parameters\n"
2134 "Assign the privileged level password\n")
2136 bool warned
= false;
2139 if (!vty_shell_serv(vty
)) {
2140 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2143 XFREE(MTYPE_HOST
, host
.enable
);
2147 if (host
.enable_encrypt
) {
2148 if (!warned
&& !vty_shell_serv(vty
))
2149 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2150 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2152 host
.enable_encrypt
= NULL
;
2157 DEFUN (service_password_encrypt
,
2158 service_password_encrypt_cmd
,
2159 "service password-encryption",
2160 "Set up miscellaneous service\n"
2161 "Enable encrypted passwords\n")
2168 if (host
.password
) {
2169 if (host
.password_encrypt
)
2170 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2171 host
.password_encrypt
=
2172 XSTRDUP(MTYPE_HOST
, zencrypt(host
.password
));
2175 if (host
.enable_encrypt
)
2176 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2177 host
.enable_encrypt
=
2178 XSTRDUP(MTYPE_HOST
, zencrypt(host
.enable
));
2184 DEFUN (no_service_password_encrypt
,
2185 no_service_password_encrypt_cmd
,
2186 "no service password-encryption",
2188 "Set up miscellaneous service\n"
2189 "Enable encrypted passwords\n")
2196 if (host
.password_encrypt
)
2197 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2198 host
.password_encrypt
= NULL
;
2200 if (host
.enable_encrypt
)
2201 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2202 host
.enable_encrypt
= NULL
;
2207 DEFUN (config_terminal_length
,
2208 config_terminal_length_cmd
,
2209 "terminal length (0-512)",
2210 "Set terminal line parameters\n"
2211 "Set number of lines on a screen\n"
2212 "Number of lines on screen (0 for no pausing)\n")
2216 vty
->lines
= atoi(argv
[idx_number
]->arg
);
2221 DEFUN (config_terminal_no_length
,
2222 config_terminal_no_length_cmd
,
2223 "terminal no length",
2224 "Set terminal line parameters\n"
2226 "Set number of lines on a screen\n")
2232 DEFUN (service_terminal_length
,
2233 service_terminal_length_cmd
,
2234 "service terminal-length (0-512)",
2235 "Set up miscellaneous service\n"
2236 "System wide terminal length configuration\n"
2237 "Number of lines of VTY (0 means no line control)\n")
2241 host
.lines
= atoi(argv
[idx_number
]->arg
);
2246 DEFUN (no_service_terminal_length
,
2247 no_service_terminal_length_cmd
,
2248 "no service terminal-length [(0-512)]",
2250 "Set up miscellaneous service\n"
2251 "System wide terminal length configuration\n"
2252 "Number of lines of VTY (0 means no line control)\n")
2258 DEFUN_HIDDEN (do_echo
,
2261 "Echo a message back to the vty\n"
2262 "The message to echo\n")
2266 vty_out(vty
, "%s\n",
2267 ((message
= argv_concat(argv
, argc
, 1)) ? message
: ""));
2269 XFREE(MTYPE_TMP
, message
);
2273 DEFUN (config_logmsg
,
2275 "logmsg <emergencies|alerts|critical|errors|warnings|notifications|informational|debugging> MESSAGE...",
2276 "Send a message to enabled logging destinations\n"
2278 "The message to send\n")
2280 int idx_log_level
= 1;
2281 int idx_message
= 2;
2285 if ((level
= level_match(argv
[idx_log_level
]->arg
)) == ZLOG_DISABLED
)
2286 return CMD_ERR_NO_MATCH
;
2289 ((message
= argv_concat(argv
, argc
, idx_message
)) ? message
: ""));
2291 XFREE(MTYPE_TMP
, message
);
2296 DEFUN (show_logging
,
2300 "Show current logging configuration\n")
2302 struct zlog
*zl
= zlog_default
;
2304 vty_out(vty
, "Syslog logging: ");
2305 if (zl
->maxlvl
[ZLOG_DEST_SYSLOG
] == ZLOG_DISABLED
)
2306 vty_out(vty
, "disabled");
2308 vty_out(vty
, "level %s, facility %s, ident %s",
2309 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_SYSLOG
]],
2310 facility_name(zl
->facility
), zl
->ident
);
2313 vty_out(vty
, "Stdout logging: ");
2314 if (zl
->maxlvl
[ZLOG_DEST_STDOUT
] == ZLOG_DISABLED
)
2315 vty_out(vty
, "disabled");
2317 vty_out(vty
, "level %s",
2318 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_STDOUT
]]);
2321 vty_out(vty
, "Monitor logging: ");
2322 if (zl
->maxlvl
[ZLOG_DEST_MONITOR
] == ZLOG_DISABLED
)
2323 vty_out(vty
, "disabled");
2325 vty_out(vty
, "level %s",
2326 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_MONITOR
]]);
2329 vty_out(vty
, "File logging: ");
2330 if ((zl
->maxlvl
[ZLOG_DEST_FILE
] == ZLOG_DISABLED
) || !zl
->fp
)
2331 vty_out(vty
, "disabled");
2333 vty_out(vty
, "level %s, filename %s",
2334 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_FILE
]],
2338 vty_out(vty
, "Protocol name: %s\n", zl
->protoname
);
2339 vty_out(vty
, "Record priority: %s\n",
2340 (zl
->record_priority
? "enabled" : "disabled"));
2341 vty_out(vty
, "Timestamp precision: %d\n", zl
->timestamp_precision
);
2346 DEFUN (config_log_stdout
,
2347 config_log_stdout_cmd
,
2348 "log stdout [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2350 "Set stdout logging level\n"
2353 int idx_log_level
= 2;
2355 if (argc
== idx_log_level
) {
2356 zlog_set_level(ZLOG_DEST_STDOUT
, zlog_default
->default_lvl
);
2361 if ((level
= level_match(argv
[idx_log_level
]->arg
)) == ZLOG_DISABLED
)
2362 return CMD_ERR_NO_MATCH
;
2363 zlog_set_level(ZLOG_DEST_STDOUT
, level
);
2367 DEFUN (no_config_log_stdout
,
2368 no_config_log_stdout_cmd
,
2369 "no log stdout [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2372 "Cancel logging to stdout\n"
2375 zlog_set_level(ZLOG_DEST_STDOUT
, ZLOG_DISABLED
);
2379 DEFUN (config_log_monitor
,
2380 config_log_monitor_cmd
,
2381 "log monitor [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2383 "Set terminal line (monitor) logging level\n"
2386 int idx_log_level
= 2;
2388 if (argc
== idx_log_level
) {
2389 zlog_set_level(ZLOG_DEST_MONITOR
, zlog_default
->default_lvl
);
2394 if ((level
= level_match(argv
[idx_log_level
]->arg
)) == ZLOG_DISABLED
)
2395 return CMD_ERR_NO_MATCH
;
2396 zlog_set_level(ZLOG_DEST_MONITOR
, level
);
2400 DEFUN (no_config_log_monitor
,
2401 no_config_log_monitor_cmd
,
2402 "no log monitor [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2405 "Disable terminal line (monitor) logging\n"
2408 zlog_set_level(ZLOG_DEST_MONITOR
, ZLOG_DISABLED
);
2412 static int set_log_file(struct vty
*vty
, const char *fname
, int loglevel
)
2416 const char *fullpath
;
2418 /* Path detection. */
2419 if (!IS_DIRECTORY_SEP(*fname
)) {
2420 char cwd
[MAXPATHLEN
+ 1];
2421 cwd
[MAXPATHLEN
] = '\0';
2423 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
2424 flog_err_sys(EC_LIB_SYSTEM_CALL
,
2425 "config_log_file: Unable to alloc mem!");
2426 return CMD_WARNING_CONFIG_FAILED
;
2429 p
= XMALLOC(MTYPE_TMP
, strlen(cwd
) + strlen(fname
) + 2);
2430 sprintf(p
, "%s/%s", cwd
, fname
);
2435 ret
= zlog_set_file(fullpath
, loglevel
);
2438 XFREE(MTYPE_TMP
, p
);
2442 vty_out(vty
, "can't open logfile %s\n", fname
);
2443 return CMD_WARNING_CONFIG_FAILED
;
2447 XFREE(MTYPE_HOST
, host
.logfile
);
2449 host
.logfile
= XSTRDUP(MTYPE_HOST
, fname
);
2451 #if defined(HAVE_CUMULUS)
2452 if (zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
] != ZLOG_DISABLED
)
2453 zlog_set_level(ZLOG_DEST_SYSLOG
, ZLOG_DISABLED
);
2458 void command_setup_early_logging(const char *dest
, const char *level
)
2463 int nlevel
= level_match(level
);
2465 if (nlevel
!= ZLOG_DISABLED
)
2466 zlog_default
->default_lvl
= nlevel
;
2472 if (strcmp(dest
, "stdout") == 0) {
2473 zlog_set_level(ZLOG_DEST_STDOUT
, zlog_default
->default_lvl
);
2477 if (strcmp(dest
, "syslog") == 0) {
2478 zlog_set_level(ZLOG_DEST_SYSLOG
, zlog_default
->default_lvl
);
2482 token
= strstr(dest
, ":");
2488 set_log_file(NULL
, token
, zlog_default
->default_lvl
);
2491 DEFUN (config_log_file
,
2492 config_log_file_cmd
,
2493 "log file FILENAME [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2496 "Logging filename\n"
2499 int idx_filename
= 2;
2500 int idx_log_levels
= 3;
2503 if ((level
= level_match(argv
[idx_log_levels
]->arg
))
2505 return CMD_ERR_NO_MATCH
;
2506 return set_log_file(vty
, argv
[idx_filename
]->arg
, level
);
2508 return set_log_file(vty
, argv
[idx_filename
]->arg
,
2509 zlog_default
->default_lvl
);
2512 static void disable_log_file(void)
2517 XFREE(MTYPE_HOST
, host
.logfile
);
2519 host
.logfile
= NULL
;
2522 DEFUN (no_config_log_file
,
2523 no_config_log_file_cmd
,
2524 "no log file [FILENAME [LEVEL]]",
2527 "Cancel logging to file\n"
2528 "Logging file name\n"
2535 DEFUN (config_log_syslog
,
2536 config_log_syslog_cmd
,
2537 "log syslog [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2539 "Set syslog logging level\n"
2542 int idx_log_levels
= 2;
2548 if ((level
= level_match(argv
[idx_log_levels
]->arg
))
2550 return CMD_ERR_NO_MATCH
;
2551 zlog_set_level(ZLOG_DEST_SYSLOG
, level
);
2554 zlog_set_level(ZLOG_DEST_SYSLOG
, zlog_default
->default_lvl
);
2559 DEFUN (no_config_log_syslog
,
2560 no_config_log_syslog_cmd
,
2561 "no log syslog [<kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7>] [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2564 "Cancel logging to syslog\n"
2568 zlog_set_level(ZLOG_DEST_SYSLOG
, ZLOG_DISABLED
);
2572 DEFUN (config_log_facility
,
2573 config_log_facility_cmd
,
2574 "log facility <kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7>",
2576 "Facility parameter for syslog messages\n"
2580 int facility
= facility_match(argv
[idx_target
]->arg
);
2582 zlog_default
->facility
= facility
;
2586 DEFUN (no_config_log_facility
,
2587 no_config_log_facility_cmd
,
2588 "no log facility [<kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7>]",
2591 "Reset syslog facility to default (daemon)\n"
2594 zlog_default
->facility
= LOG_DAEMON
;
2598 DEFUN (config_log_record_priority
,
2599 config_log_record_priority_cmd
,
2600 "log record-priority",
2602 "Log the priority of the message within the message\n")
2604 zlog_default
->record_priority
= 1;
2608 DEFUN (no_config_log_record_priority
,
2609 no_config_log_record_priority_cmd
,
2610 "no log record-priority",
2613 "Do not log the priority of the message within the message\n")
2615 zlog_default
->record_priority
= 0;
2619 DEFUN (config_log_timestamp_precision
,
2620 config_log_timestamp_precision_cmd
,
2621 "log timestamp precision (0-6)",
2623 "Timestamp configuration\n"
2624 "Set the timestamp precision\n"
2625 "Number of subsecond digits\n")
2628 zlog_default
->timestamp_precision
=
2629 strtoul(argv
[idx_number
]->arg
, NULL
, 10);
2633 DEFUN (no_config_log_timestamp_precision
,
2634 no_config_log_timestamp_precision_cmd
,
2635 "no log timestamp precision",
2638 "Timestamp configuration\n"
2639 "Reset the timestamp precision to the default value of 0\n")
2641 zlog_default
->timestamp_precision
= 0;
2645 DEFUN (debug_memstats
,
2647 "[no] debug memstats-at-exit",
2650 "Print memory type statistics at exit\n")
2652 debug_memstats_at_exit
= !!strcmp(argv
[0]->text
, "no");
2656 int cmd_banner_motd_file(const char *file
)
2658 int success
= CMD_SUCCESS
;
2663 rpath
= realpath(file
, p
);
2665 return CMD_ERR_NO_FILE
;
2666 in
= strstr(rpath
, SYSCONFDIR
);
2669 XFREE(MTYPE_HOST
, host
.motdfile
);
2670 host
.motdfile
= XSTRDUP(MTYPE_HOST
, file
);
2672 success
= CMD_WARNING_CONFIG_FAILED
;
2677 DEFUN (banner_motd_file
,
2678 banner_motd_file_cmd
,
2679 "banner motd file FILE",
2682 "Banner from a file\n"
2686 const char *filename
= argv
[idx_file
]->arg
;
2687 int cmd
= cmd_banner_motd_file(filename
);
2689 if (cmd
== CMD_ERR_NO_FILE
)
2690 vty_out(vty
, "%s does not exist", filename
);
2691 else if (cmd
== CMD_WARNING_CONFIG_FAILED
)
2692 vty_out(vty
, "%s must be in %s", filename
, SYSCONFDIR
);
2697 DEFUN (banner_motd_default
,
2698 banner_motd_default_cmd
,
2699 "banner motd default",
2700 "Set banner string\n"
2701 "Strings for motd\n"
2704 host
.motd
= default_motd
;
2708 DEFUN (no_banner_motd
,
2712 "Set banner string\n"
2713 "Strings for motd\n")
2717 XFREE(MTYPE_HOST
, host
.motdfile
);
2718 host
.motdfile
= NULL
;
2725 "Find CLI command containing text\n"
2726 "Text to search for\n")
2728 char *text
= argv_concat(argv
, argc
, 1);
2729 const struct cmd_node
*node
;
2730 const struct cmd_element
*cli
;
2733 for (unsigned int i
= 0; i
< vector_active(cmdvec
); i
++) {
2734 node
= vector_slot(cmdvec
, i
);
2737 clis
= node
->cmd_vector
;
2738 for (unsigned int j
= 0; j
< vector_active(clis
); j
++) {
2739 cli
= vector_slot(clis
, j
);
2740 if (strcasestr(cli
->string
, text
))
2741 vty_out(vty
, " (%s) %s\n",
2742 node_names
[node
->node
], cli
->string
);
2746 XFREE(MTYPE_TMP
, text
);
2751 /* Set config filename. Called from vty.c */
2752 void host_config_set(const char *filename
)
2755 XFREE(MTYPE_HOST
, host
.config
);
2756 host
.config
= XSTRDUP(MTYPE_HOST
, filename
);
2759 const char *host_config_get(void)
2764 void install_default(enum node_type node
)
2766 install_element(node
, &config_exit_cmd
);
2767 install_element(node
, &config_quit_cmd
);
2768 install_element(node
, &config_end_cmd
);
2769 install_element(node
, &config_help_cmd
);
2770 install_element(node
, &config_list_cmd
);
2771 install_element(node
, &show_cli_graph_cmd
);
2772 install_element(node
, &find_cmd
);
2774 install_element(node
, &config_write_cmd
);
2775 install_element(node
, &show_running_config_cmd
);
2777 install_element(node
, &autocomplete_cmd
);
2780 /* Initialize command interface. Install basic nodes and commands.
2782 * terminal = 0 -- vtysh / no logging, no config control
2783 * terminal = 1 -- normal daemon
2784 * terminal = -1 -- watchfrr / no logging, but minimal config control */
2785 void cmd_init(int terminal
)
2787 struct utsname names
;
2789 if (array_size(node_names
) != NODE_TYPE_MAX
)
2790 assert(!"Update the CLI node description array!");
2795 /* register command preprocessors */
2796 hook_register(cmd_execute
, handle_pipe_action
);
2797 hook_register(cmd_execute_done
, handle_pipe_action_done
);
2799 varhandlers
= list_new();
2801 /* Allocate initial top vector of commands. */
2802 cmdvec
= vector_init(VECTOR_MIN_SIZE
);
2804 /* Default host value settings. */
2805 host
.name
= XSTRDUP(MTYPE_HOST
, names
.nodename
);
2806 #ifdef HAVE_STRUCT_UTSNAME_DOMAINNAME
2807 if ((strcmp(names
.domainname
, "(none)") == 0))
2808 host
.domainname
= NULL
;
2810 host
.domainname
= XSTRDUP(MTYPE_HOST
, names
.domainname
);
2812 host
.domainname
= NULL
;
2814 host
.password
= NULL
;
2816 host
.logfile
= NULL
;
2818 host
.noconfig
= (terminal
< 0);
2820 host
.motd
= default_motd
;
2821 host
.motdfile
= NULL
;
2823 /* Install top nodes. */
2824 install_node(&view_node
, NULL
);
2825 install_node(&enable_node
, NULL
);
2826 install_node(&auth_node
, NULL
);
2827 install_node(&auth_enable_node
, NULL
);
2828 install_node(&config_node
, config_write_host
);
2830 /* Each node's basic commands. */
2831 install_element(VIEW_NODE
, &show_version_cmd
);
2832 install_element(ENABLE_NODE
, &show_startup_config_cmd
);
2833 install_element(ENABLE_NODE
, &debug_memstats_cmd
);
2836 install_element(VIEW_NODE
, &config_list_cmd
);
2837 install_element(VIEW_NODE
, &config_exit_cmd
);
2838 install_element(VIEW_NODE
, &config_quit_cmd
);
2839 install_element(VIEW_NODE
, &config_help_cmd
);
2840 install_element(VIEW_NODE
, &config_enable_cmd
);
2841 install_element(VIEW_NODE
, &config_terminal_length_cmd
);
2842 install_element(VIEW_NODE
, &config_terminal_no_length_cmd
);
2843 install_element(VIEW_NODE
, &show_logging_cmd
);
2844 install_element(VIEW_NODE
, &show_commandtree_cmd
);
2845 install_element(VIEW_NODE
, &echo_cmd
);
2846 install_element(VIEW_NODE
, &autocomplete_cmd
);
2847 install_element(VIEW_NODE
, &find_cmd
);
2849 install_element(ENABLE_NODE
, &config_end_cmd
);
2850 install_element(ENABLE_NODE
, &config_disable_cmd
);
2851 install_element(ENABLE_NODE
, &config_terminal_cmd
);
2852 install_element(ENABLE_NODE
, ©_runningconf_startupconf_cmd
);
2853 install_element(ENABLE_NODE
, &config_write_cmd
);
2854 install_element(ENABLE_NODE
, &show_running_config_cmd
);
2855 install_element(ENABLE_NODE
, &config_logmsg_cmd
);
2857 install_default(CONFIG_NODE
);
2860 workqueue_cmd_init();
2864 install_element(CONFIG_NODE
, &hostname_cmd
);
2865 install_element(CONFIG_NODE
, &no_hostname_cmd
);
2866 install_element(CONFIG_NODE
, &domainname_cmd
);
2867 install_element(CONFIG_NODE
, &no_domainname_cmd
);
2868 install_element(CONFIG_NODE
, &frr_version_defaults_cmd
);
2869 install_element(CONFIG_NODE
, &debug_memstats_cmd
);
2872 install_element(CONFIG_NODE
, &password_cmd
);
2873 install_element(CONFIG_NODE
, &no_password_cmd
);
2874 install_element(CONFIG_NODE
, &enable_password_cmd
);
2875 install_element(CONFIG_NODE
, &no_enable_password_cmd
);
2877 install_element(CONFIG_NODE
, &config_log_stdout_cmd
);
2878 install_element(CONFIG_NODE
, &no_config_log_stdout_cmd
);
2879 install_element(CONFIG_NODE
, &config_log_monitor_cmd
);
2880 install_element(CONFIG_NODE
, &no_config_log_monitor_cmd
);
2881 install_element(CONFIG_NODE
, &config_log_file_cmd
);
2882 install_element(CONFIG_NODE
, &no_config_log_file_cmd
);
2883 install_element(CONFIG_NODE
, &config_log_syslog_cmd
);
2884 install_element(CONFIG_NODE
, &no_config_log_syslog_cmd
);
2885 install_element(CONFIG_NODE
, &config_log_facility_cmd
);
2886 install_element(CONFIG_NODE
, &no_config_log_facility_cmd
);
2887 install_element(CONFIG_NODE
, &config_log_record_priority_cmd
);
2888 install_element(CONFIG_NODE
,
2889 &no_config_log_record_priority_cmd
);
2890 install_element(CONFIG_NODE
,
2891 &config_log_timestamp_precision_cmd
);
2892 install_element(CONFIG_NODE
,
2893 &no_config_log_timestamp_precision_cmd
);
2894 install_element(CONFIG_NODE
, &service_password_encrypt_cmd
);
2895 install_element(CONFIG_NODE
, &no_service_password_encrypt_cmd
);
2896 install_element(CONFIG_NODE
, &banner_motd_default_cmd
);
2897 install_element(CONFIG_NODE
, &banner_motd_file_cmd
);
2898 install_element(CONFIG_NODE
, &no_banner_motd_cmd
);
2899 install_element(CONFIG_NODE
, &service_terminal_length_cmd
);
2900 install_element(CONFIG_NODE
, &no_service_terminal_length_cmd
);
2902 vrf_install_commands();
2906 grammar_sandbox_init();
2910 void cmd_terminate()
2912 struct cmd_node
*cmd_node
;
2914 hook_unregister(cmd_execute
, handle_pipe_action
);
2915 hook_unregister(cmd_execute_done
, handle_pipe_action_done
);
2918 for (unsigned int i
= 0; i
< vector_active(cmdvec
); i
++)
2919 if ((cmd_node
= vector_slot(cmdvec
, i
)) != NULL
) {
2920 // deleting the graph delets the cmd_element as
2922 graph_delete_graph(cmd_node
->cmdgraph
);
2923 vector_free(cmd_node
->cmd_vector
);
2924 hash_clean(cmd_node
->cmd_hash
, NULL
);
2925 hash_free(cmd_node
->cmd_hash
);
2926 cmd_node
->cmd_hash
= NULL
;
2929 vector_free(cmdvec
);
2934 XFREE(MTYPE_HOST
, host
.name
);
2935 if (host
.domainname
)
2936 XFREE(MTYPE_HOST
, host
.domainname
);
2938 XFREE(MTYPE_HOST
, host
.password
);
2939 if (host
.password_encrypt
)
2940 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2942 XFREE(MTYPE_HOST
, host
.enable
);
2943 if (host
.enable_encrypt
)
2944 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2946 XFREE(MTYPE_HOST
, host
.logfile
);
2948 XFREE(MTYPE_HOST
, host
.motdfile
);
2950 XFREE(MTYPE_HOST
, host
.config
);
2952 list_delete_and_null(&varhandlers
);