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"
49 #include "northbound_cli.h"
51 DEFINE_MTYPE_STATIC(LIB
, HOST
, "Host config")
52 DEFINE_MTYPE(LIB
, COMPLETION
, "Completion item")
59 /* clang-format off */
60 const struct message tokennames
[] = {
65 item(IPV4_PREFIX_TKN
),
67 item(IPV6_PREFIX_TKN
),
77 const char *node_names
[] = {
80 "auth enable", // AUTH_ENABLE_NODE,
81 "enable", // ENABLE_NODE,
82 "config", // CONFIG_NODE,
83 "debug", // DEBUG_NODE,
84 "vrf debug", // VRF_DEBUG_NODE,
85 "northbound debug", // NORTHBOUND_DEBUG_NODE,
86 "vnc debug", // DEBUG_VNC_NODE,
87 "route-map debug", /* RMAP_DEBUG_NODE */
88 "resolver debug", /* RESOLVER_DEBUG_NODE */
90 "keychain", // KEYCHAIN_NODE,
91 "keychain key", // KEYCHAIN_KEY_NODE,
92 "static ip", // IP_NODE,
94 "interface", // INTERFACE_NODE,
95 "nexthop-group", // NH_GROUP_NODE,
96 "zebra", // ZEBRA_NODE,
97 "table", // TABLE_NODE,
99 "ripng", // RIPNG_NODE,
100 "babel", // BABEL_NODE,
101 "eigrp", // EIGRP_NODE,
103 "bgp vpnv4", // BGP_VPNV4_NODE,
104 "bgp vpnv6", // BGP_VPNV6_NODE,
105 "bgp ipv4 unicast", // BGP_IPV4_NODE,
106 "bgp ipv4 multicast", // BGP_IPV4M_NODE,
107 "bgp ipv4 labeled unicast", // BGP_IPV4L_NODE,
108 "bgp ipv6", // BGP_IPV6_NODE,
109 "bgp ipv6 multicast", // BGP_IPV6M_NODE,
110 "bgp ipv6 labeled unicast", // BGP_IPV6L_NODE,
111 "bgp vrf policy", // BGP_VRF_POLICY_NODE,
112 "bgp vnc defaults", // BGP_VNC_DEFAULTS_NODE,
113 "bgp vnc nve", // BGP_VNC_NVE_GROUP_NODE,
114 "bgp vnc l2", // BGP_VNC_L2_GROUP_NODE,
115 "rfp defaults", // RFP_DEFAULTS_NODE,
116 "bgp evpn", // BGP_EVPN_NODE,
117 "ospf", // OSPF_NODE,
118 "ospf6", // OSPF6_NODE,
120 "ldp ipv4", // LDP_IPV4_NODE,
121 "ldp ipv6", // LDP_IPV6_NODE,
122 "ldp ipv4 interface", // LDP_IPV4_IFACE_NODE,
123 "ldp ipv6 interface", // LDP_IPV6_IFACE_NODE,
124 "ldp l2vpn", // LDP_L2VPN_NODE,
125 "ldp", // LDP_PSEUDOWIRE_NODE,
126 "isis", // ISIS_NODE,
127 "ipv4 access list", // ACCESS_NODE,
128 "ipv4 prefix list", // PREFIX_NODE,
129 "ipv6 access list", // ACCESS_IPV6_NODE,
130 "MAC access list", // ACCESS_MAC_NODE,
131 "ipv6 prefix list", // PREFIX_IPV6_NODE,
132 "as list", // AS_LIST_NODE,
133 "community list", // COMMUNITY_LIST_NODE,
134 "routemap", // RMAP_NODE,
135 "pbr-map", // PBRMAP_NODE,
136 "smux", // SMUX_NODE,
137 "dump", // DUMP_NODE,
138 "forwarding", // FORWARDING_NODE,
139 "protocol", // PROTOCOL_NODE,
140 "mpls", // MPLS_NODE,
143 "link-params", // LINK_PARAMS_NODE,
144 "bgp evpn vni", // BGP_EVPN_VNI_NODE,
146 "bgp ipv4 flowspec", /* BGP_FLOWSPECV4_NODE
148 "bgp ipv6 flowspec", /* BGP_FLOWSPECV6_NODE
150 "bfd", /* BFD_NODE */
151 "bfd peer", /* BFD_PEER_NODE */
152 "openfabric", // OPENFABRIC_NODE
153 "vrrp", /* VRRP_NODE */
154 "bmp", /* BMP_NODE */
156 /* clang-format on */
158 /* Command vector which includes some level of command lists. Normally
159 each daemon maintains each own cmdvec. */
160 vector cmdvec
= NULL
;
162 /* Host information structure. */
166 * Returns host.name if any, otherwise
167 * it returns the system hostname.
169 const char *cmd_hostname_get(void)
175 * Returns unix domainname
177 const char *cmd_domainname_get(void)
179 return host
.domainname
;
182 /* Standard command node structures. */
183 static struct cmd_node auth_node
= {
184 AUTH_NODE
, "Password: ",
187 static struct cmd_node view_node
= {
191 static struct cmd_node auth_enable_node
= {
192 AUTH_ENABLE_NODE
, "Password: ",
195 static struct cmd_node enable_node
= {
199 static struct cmd_node config_node
= {CONFIG_NODE
, "%s(config)# ", 1};
201 /* Default motd string. */
202 static const char *default_motd
= FRR_DEFAULT_MOTD
;
204 static const struct facility_map
{
208 } syslog_facilities
[] = {
209 {LOG_KERN
, "kern", 1},
210 {LOG_USER
, "user", 2},
211 {LOG_MAIL
, "mail", 1},
212 {LOG_DAEMON
, "daemon", 1},
213 {LOG_AUTH
, "auth", 1},
214 {LOG_SYSLOG
, "syslog", 1},
216 {LOG_NEWS
, "news", 1},
217 {LOG_UUCP
, "uucp", 2},
218 {LOG_CRON
, "cron", 1},
222 {LOG_LOCAL0
, "local0", 6},
223 {LOG_LOCAL1
, "local1", 6},
224 {LOG_LOCAL2
, "local2", 6},
225 {LOG_LOCAL3
, "local3", 6},
226 {LOG_LOCAL4
, "local4", 6},
227 {LOG_LOCAL5
, "local5", 6},
228 {LOG_LOCAL6
, "local6", 6},
229 {LOG_LOCAL7
, "local7", 6},
233 static const char *facility_name(int facility
)
235 const struct facility_map
*fm
;
237 for (fm
= syslog_facilities
; fm
->name
; fm
++)
238 if (fm
->facility
== facility
)
243 static int facility_match(const char *str
)
245 const struct facility_map
*fm
;
247 for (fm
= syslog_facilities
; fm
->name
; fm
++)
248 if (!strncmp(str
, fm
->name
, fm
->match
))
253 static int level_match(const char *s
)
257 for (level
= 0; zlog_priority
[level
] != NULL
; level
++)
258 if (!strncmp(s
, zlog_priority
[level
], 2))
260 return ZLOG_DISABLED
;
263 /* This is called from main when a daemon is invoked with -v or --version. */
264 void print_version(const char *progname
)
266 printf("%s version %s\n", progname
, FRR_VERSION
);
267 printf("%s\n", FRR_COPYRIGHT
);
268 printf("configured with:\n\t%s\n", FRR_CONFIG_ARGS
);
271 char *argv_concat(struct cmd_token
**argv
, int argc
, int shift
)
273 int cnt
= MAX(argc
- shift
, 0);
274 const char *argstr
[cnt
+ 1];
279 for (int i
= 0; i
< cnt
; i
++)
280 argstr
[i
] = argv
[i
+ shift
]->arg
;
282 return frrstr_join(argstr
, cnt
, " ");
285 vector
cmd_make_strvec(const char *string
)
290 const char *copy
= string
;
292 /* skip leading whitespace */
293 while (isspace((unsigned char)*copy
) && *copy
!= '\0')
296 /* if the entire string was whitespace or a comment, return */
297 if (*copy
== '\0' || *copy
== '!' || *copy
== '#')
300 vector result
= frrstr_split_vec(copy
, "\n\r\t ");
302 for (unsigned int i
= 0; i
< vector_active(result
); i
++) {
303 if (strlen(vector_slot(result
, i
)) == 0) {
304 XFREE(MTYPE_TMP
, vector_slot(result
, i
));
305 vector_unset(result
, i
);
309 vector_compact(result
);
314 void cmd_free_strvec(vector v
)
316 frrstr_strvec_free(v
);
320 * Convenience function for accessing argv data.
324 * @param text definition snippet of the desired token
325 * @param index the starting index, and where to store the
326 * index of the found token if it exists
327 * @return 1 if found, 0 otherwise
329 int argv_find(struct cmd_token
**argv
, int argc
, const char *text
, int *index
)
332 for (int i
= *index
; i
< argc
&& found
== 0; i
++)
333 if ((found
= strmatch(text
, argv
[i
]->text
)))
338 static unsigned int cmd_hash_key(const void *p
)
340 int size
= sizeof(p
);
342 return jhash(p
, size
, 0);
345 static bool cmd_hash_cmp(const void *a
, const void *b
)
350 /* Install top node of command vector. */
351 void install_node(struct cmd_node
*node
, int (*func
)(struct vty
*))
353 vector_set_index(cmdvec
, node
->node
, node
);
355 node
->cmdgraph
= graph_new();
356 node
->cmd_vector
= vector_init(VECTOR_MIN_SIZE
);
358 struct cmd_token
*token
=
359 cmd_token_new(START_TKN
, CMD_ATTR_NORMAL
, NULL
, NULL
);
360 graph_new_node(node
->cmdgraph
, token
,
361 (void (*)(void *)) & cmd_token_del
);
362 node
->cmd_hash
= hash_create_size(16, cmd_hash_key
, cmd_hash_cmp
,
366 /* Return prompt character of specified node. */
367 const char *cmd_prompt(enum node_type node
)
369 struct cmd_node
*cnode
;
371 cnode
= vector_slot(cmdvec
, node
);
372 return cnode
->prompt
;
375 /* Install a command into a node. */
376 void install_element(enum node_type ntype
, struct cmd_element
*cmd
)
378 struct cmd_node
*cnode
;
380 /* cmd_init hasn't been called */
382 fprintf(stderr
, "%s called before cmd_init, breakage likely\n",
387 cnode
= vector_lookup(cmdvec
, ntype
);
392 "\tnode %d (%s) does not exist.\n"
393 "\tplease call install_node() before install_element()\n",
394 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
398 if (hash_lookup(cnode
->cmd_hash
, cmd
) != NULL
) {
401 "\tnode %d (%s) already has this command installed.\n"
402 "\tduplicate install_element call?\n",
403 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
407 assert(hash_get(cnode
->cmd_hash
, cmd
, hash_alloc_intern
));
409 struct graph
*graph
= graph_new();
410 struct cmd_token
*token
=
411 cmd_token_new(START_TKN
, CMD_ATTR_NORMAL
, NULL
, NULL
);
412 graph_new_node(graph
, token
, (void (*)(void *)) & cmd_token_del
);
414 cmd_graph_parse(graph
, cmd
);
415 cmd_graph_names(graph
);
416 cmd_graph_merge(cnode
->cmdgraph
, graph
, +1);
417 graph_delete_graph(graph
);
419 vector_set(cnode
->cmd_vector
, cmd
);
421 if (ntype
== VIEW_NODE
)
422 install_element(ENABLE_NODE
, cmd
);
425 void uninstall_element(enum node_type ntype
, struct cmd_element
*cmd
)
427 struct cmd_node
*cnode
;
429 /* cmd_init hasn't been called */
431 fprintf(stderr
, "%s called before cmd_init, breakage likely\n",
436 cnode
= vector_lookup(cmdvec
, ntype
);
441 "\tnode %d (%s) does not exist.\n"
442 "\tplease call install_node() before uninstall_element()\n",
443 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
447 if (hash_release(cnode
->cmd_hash
, cmd
) == NULL
) {
450 "\tnode %d (%s) does not have this command installed.\n"
451 "\tduplicate uninstall_element call?\n",
452 cmd
->name
, cmd
->string
, ntype
, node_names
[ntype
]);
456 vector_unset_value(cnode
->cmd_vector
, cmd
);
458 struct graph
*graph
= graph_new();
459 struct cmd_token
*token
=
460 cmd_token_new(START_TKN
, CMD_ATTR_NORMAL
, NULL
, NULL
);
461 graph_new_node(graph
, token
, (void (*)(void *)) & cmd_token_del
);
463 cmd_graph_parse(graph
, cmd
);
464 cmd_graph_names(graph
);
465 cmd_graph_merge(cnode
->cmdgraph
, graph
, -1);
466 graph_delete_graph(graph
);
468 if (ntype
== VIEW_NODE
)
469 uninstall_element(ENABLE_NODE
, cmd
);
473 static const unsigned char itoa64
[] =
474 "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
476 static void to64(char *s
, long v
, int n
)
479 *s
++ = itoa64
[v
& 0x3f];
484 static char *zencrypt(const char *passwd
)
488 char *crypt(const char *, const char *);
490 gettimeofday(&tv
, 0);
492 to64(&salt
[0], random(), 3);
493 to64(&salt
[3], tv
.tv_usec
, 3);
496 return crypt(passwd
, salt
);
499 /* This function write configuration of this host. */
500 static int config_write_host(struct vty
*vty
)
502 if (cmd_hostname_get())
503 vty_out(vty
, "hostname %s\n", cmd_hostname_get());
505 if (cmd_domainname_get())
506 vty_out(vty
, "domainname %s\n", cmd_domainname_get());
508 /* The following are all configuration commands that are not sent to
509 * watchfrr. For instance watchfrr is hardcoded to log to syslog so
510 * we would always display 'log syslog informational' in the config
511 * which would cause other daemons to then switch to syslog when they
514 if (strcmp(zlog_default
->protoname
, "WATCHFRR")) {
516 if (host
.password_encrypt
)
517 vty_out(vty
, "password 8 %s\n",
518 host
.password_encrypt
);
519 if (host
.enable_encrypt
)
520 vty_out(vty
, "enable password 8 %s\n",
521 host
.enable_encrypt
);
524 vty_out(vty
, "password %s\n", host
.password
);
526 vty_out(vty
, "enable password %s\n",
531 && (zlog_default
->maxlvl
[ZLOG_DEST_FILE
]
533 vty_out(vty
, "log file %s", host
.logfile
);
534 if (zlog_default
->maxlvl
[ZLOG_DEST_FILE
]
535 != zlog_default
->default_lvl
)
538 [zlog_default
->maxlvl
543 if (zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
] != ZLOG_DISABLED
) {
544 vty_out(vty
, "log stdout");
545 if (zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
]
546 != zlog_default
->default_lvl
)
549 [zlog_default
->maxlvl
550 [ZLOG_DEST_STDOUT
]]);
554 if (zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
] == ZLOG_DISABLED
)
555 vty_out(vty
, "no log monitor\n");
556 else if (zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
]
557 != zlog_default
->default_lvl
)
558 vty_out(vty
, "log monitor %s\n",
559 zlog_priority
[zlog_default
->maxlvl
560 [ZLOG_DEST_MONITOR
]]);
562 if (zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
] != ZLOG_DISABLED
) {
563 vty_out(vty
, "log syslog");
564 if (zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
]
565 != zlog_default
->default_lvl
)
567 zlog_priority
[zlog_default
->maxlvl
568 [ZLOG_DEST_SYSLOG
]]);
572 if (zlog_default
->facility
!= LOG_DAEMON
)
573 vty_out(vty
, "log facility %s\n",
574 facility_name(zlog_default
->facility
));
576 if (zlog_default
->record_priority
== 1)
577 vty_out(vty
, "log record-priority\n");
579 if (zlog_default
->timestamp_precision
> 0)
580 vty_out(vty
, "log timestamp precision %d\n",
581 zlog_default
->timestamp_precision
);
584 vty_out(vty
, "service advanced-vty\n");
587 vty_out(vty
, "service password-encryption\n");
590 vty_out(vty
, "service terminal-length %d\n",
594 vty_out(vty
, "banner motd file %s\n", host
.motdfile
);
596 vty_out(vty
, "no banner motd\n");
599 if (debug_memstats_at_exit
)
600 vty_out(vty
, "!\ndebug memstats-at-exit\n");
605 /* Utility function for getting command graph. */
606 static struct graph
*cmd_node_graph(vector v
, enum node_type ntype
)
608 struct cmd_node
*cnode
= vector_slot(v
, ntype
);
609 return cnode
->cmdgraph
;
612 static int cmd_try_do_shortcut(enum node_type node
, char *first_word
)
614 if (first_word
!= NULL
&& node
!= AUTH_NODE
&& node
!= VIEW_NODE
615 && node
!= AUTH_ENABLE_NODE
&& 0 == strcmp("do", first_word
))
621 * Compare function for cmd_token.
622 * Used with qsort to sort command completions.
624 static int compare_completions(const void *fst
, const void *snd
)
626 const struct cmd_token
*first
= *(const struct cmd_token
* const *)fst
,
627 *secnd
= *(const struct cmd_token
* const *)snd
;
628 return strcmp(first
->text
, secnd
->text
);
632 * Takes a list of completions returned by command_complete,
633 * dedeuplicates them based on both text and description,
634 * sorts them, and returns them as a vector.
636 * @param completions linked list of cmd_token
637 * @return deduplicated and sorted vector with
639 vector
completions_to_vec(struct list
*completions
)
641 vector comps
= vector_init(VECTOR_MIN_SIZE
);
644 struct cmd_token
*token
, *cr
= NULL
;
645 unsigned int i
, exists
;
646 for (ALL_LIST_ELEMENTS_RO(completions
, ln
, token
)) {
647 if (token
->type
== END_TKN
&& (cr
= token
))
650 // linear search for token in completions vector
652 for (i
= 0; i
< vector_active(comps
) && !exists
; i
++) {
653 struct cmd_token
*curr
= vector_slot(comps
, i
);
655 exists
= !strcmp(curr
->text
, token
->text
)
656 && !strcmp(curr
->desc
, token
->desc
);
658 exists
= !strcmp(curr
->text
, token
->text
);
659 #endif /* VTYSH_DEBUG */
663 vector_set(comps
, token
);
667 qsort(comps
->index
, vector_active(comps
), sizeof(void *),
668 &compare_completions
);
670 // make <cr> the first element, if it is present
672 vector_set_index(comps
, vector_active(comps
), NULL
);
673 memmove(comps
->index
+ 1, comps
->index
,
674 (comps
->alloced
- 1) * sizeof(void *));
675 vector_set_index(comps
, 0, cr
);
681 * Generates a vector of cmd_token representing possible completions
682 * on the current input.
684 * @param vline the vectorized input line
685 * @param vty the vty with the node to match on
686 * @param status pointer to matcher status code
687 * @return vector of struct cmd_token * with possible completions
689 static vector
cmd_complete_command_real(vector vline
, struct vty
*vty
,
692 struct list
*completions
;
693 struct graph
*cmdgraph
= cmd_node_graph(cmdvec
, vty
->node
);
695 enum matcher_rv rv
= command_complete(cmdgraph
, vline
, &completions
);
697 if (MATCHER_ERROR(rv
)) {
698 *status
= CMD_ERR_NO_MATCH
;
702 vector comps
= completions_to_vec(completions
);
703 list_delete(&completions
);
705 // set status code appropriately
706 switch (vector_active(comps
)) {
708 *status
= CMD_ERR_NO_MATCH
;
711 *status
= CMD_COMPLETE_FULL_MATCH
;
714 *status
= CMD_COMPLETE_LIST_MATCH
;
720 vector
cmd_describe_command(vector vline
, struct vty
*vty
, int *status
)
724 if (cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0))) {
725 enum node_type onode
;
726 int orig_xpath_index
;
727 vector shifted_vline
;
731 orig_xpath_index
= vty
->xpath_index
;
732 vty
->node
= ENABLE_NODE
;
733 vty
->xpath_index
= 0;
734 /* We can try it on enable node, cos' the vty is authenticated
737 shifted_vline
= vector_init(vector_count(vline
));
739 for (index
= 1; index
< vector_active(vline
); index
++) {
740 vector_set_index(shifted_vline
, index
- 1,
741 vector_lookup(vline
, index
));
744 ret
= cmd_complete_command_real(shifted_vline
, vty
, status
);
746 vector_free(shifted_vline
);
748 vty
->xpath_index
= orig_xpath_index
;
752 return cmd_complete_command_real(vline
, vty
, status
);
755 static struct list
*varhandlers
= NULL
;
757 void cmd_variable_complete(struct cmd_token
*token
, const char *arg
,
761 const struct cmd_variable_handler
*cvh
;
765 tmpcomps
= arg
? vector_init(VECTOR_MIN_SIZE
) : comps
;
767 for (ALL_LIST_ELEMENTS_RO(varhandlers
, ln
, cvh
)) {
768 if (cvh
->tokenname
&& strcmp(cvh
->tokenname
, token
->text
))
770 if (cvh
->varname
&& (!token
->varname
771 || strcmp(cvh
->varname
, token
->varname
)))
773 cvh
->completions(tmpcomps
, token
);
781 for (i
= vector_active(tmpcomps
); i
; i
--) {
782 char *item
= vector_slot(tmpcomps
, i
- 1);
783 if (strlen(item
) >= argsz
&& !strncmp(item
, arg
, argsz
))
784 vector_set(comps
, item
);
786 XFREE(MTYPE_COMPLETION
, item
);
788 vector_free(tmpcomps
);
791 #define AUTOCOMP_INDENT 5
793 char *cmd_variable_comp2str(vector comps
, unsigned short cols
)
796 char *buf
= XCALLOC(MTYPE_TMP
, bsz
);
797 int lc
= AUTOCOMP_INDENT
;
798 size_t cs
= AUTOCOMP_INDENT
;
800 snprintf(buf
, bsz
, "%*s", AUTOCOMP_INDENT
, "");
801 for (size_t j
= 0; j
< vector_active(comps
); j
++) {
802 char *item
= vector_slot(comps
, j
);
803 itemlen
= strlen(item
);
805 if (cs
+ itemlen
+ AUTOCOMP_INDENT
+ 3 >= bsz
)
806 buf
= XREALLOC(MTYPE_TMP
, buf
, (bsz
*= 2));
808 if (lc
+ itemlen
+ 1 >= cols
) {
809 cs
+= snprintf(&buf
[cs
], bsz
- cs
, "\n%*s",
810 AUTOCOMP_INDENT
, "");
811 lc
= AUTOCOMP_INDENT
;
814 size_t written
= snprintf(&buf
[cs
], bsz
- cs
, "%s ", item
);
817 XFREE(MTYPE_COMPLETION
, item
);
818 vector_set_index(comps
, j
, NULL
);
823 void cmd_variable_handler_register(const struct cmd_variable_handler
*cvh
)
828 for (; cvh
->completions
; cvh
++)
829 listnode_add(varhandlers
, (void *)cvh
);
832 DEFUN_HIDDEN (autocomplete
,
834 "autocomplete TYPE TEXT VARNAME",
835 "Autocompletion handler (internal, for vtysh)\n"
838 "cmd_token->varname\n")
840 struct cmd_token tok
;
841 vector comps
= vector_init(32);
844 memset(&tok
, 0, sizeof(tok
));
845 tok
.type
= atoi(argv
[1]->arg
);
846 tok
.text
= argv
[2]->arg
;
847 tok
.varname
= argv
[3]->arg
;
848 if (!strcmp(tok
.varname
, "-"))
851 cmd_variable_complete(&tok
, NULL
, comps
);
853 for (i
= 0; i
< vector_active(comps
); i
++) {
854 char *text
= vector_slot(comps
, i
);
855 vty_out(vty
, "%s\n", text
);
856 XFREE(MTYPE_COMPLETION
, text
);
864 * Generate possible tab-completions for the given input. This function only
865 * returns results that would result in a valid command if used as Readline
866 * completions (as is the case in vtysh). For instance, if the passed vline ends
867 * with '4.3.2', the strings 'A.B.C.D' and 'A.B.C.D/M' will _not_ be returned.
869 * @param vline vectorized input line
871 * @param status location to store matcher status code in
872 * @return set of valid strings for use with Readline as tab-completions.
875 char **cmd_complete_command(vector vline
, struct vty
*vty
, int *status
)
878 int original_node
= vty
->node
;
879 vector input_line
= vector_init(vector_count(vline
));
881 // if the first token is 'do' we'll want to execute the command in the
883 int do_shortcut
= cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0));
884 vty
->node
= do_shortcut
? ENABLE_NODE
: original_node
;
886 // construct the input line we'll be matching on
887 unsigned int offset
= (do_shortcut
) ? 1 : 0;
888 for (unsigned index
= 0; index
+ offset
< vector_active(vline
); index
++)
889 vector_set_index(input_line
, index
,
890 vector_lookup(vline
, index
+ offset
));
892 // get token completions -- this is a copying operation
893 vector comps
= NULL
, initial_comps
;
894 initial_comps
= cmd_complete_command_real(input_line
, vty
, status
);
896 if (!MATCHER_ERROR(*status
)) {
897 assert(initial_comps
);
898 // filter out everything that is not suitable for a
900 comps
= vector_init(VECTOR_MIN_SIZE
);
901 for (unsigned int i
= 0; i
< vector_active(initial_comps
);
903 struct cmd_token
*token
= vector_slot(initial_comps
, i
);
904 if (token
->type
== WORD_TKN
)
905 vector_set(comps
, XSTRDUP(MTYPE_COMPLETION
,
907 else if (IS_VARYING_TOKEN(token
->type
)) {
908 const char *ref
= vector_lookup(
909 vline
, vector_active(vline
) - 1);
910 cmd_variable_complete(token
, ref
, comps
);
913 vector_free(initial_comps
);
915 // since we filtered results, we need to re-set status code
916 switch (vector_active(comps
)) {
918 *status
= CMD_ERR_NO_MATCH
;
921 *status
= CMD_COMPLETE_FULL_MATCH
;
924 *status
= CMD_COMPLETE_LIST_MATCH
;
927 // copy completions text into an array of char*
928 ret
= XMALLOC(MTYPE_TMP
,
929 (vector_active(comps
) + 1) * sizeof(char *));
931 for (i
= 0; i
< vector_active(comps
); i
++) {
932 ret
[i
] = vector_slot(comps
, i
);
934 // set the last element to NULL, because this array is used in
935 // a Readline completion_generator function which expects NULL
936 // as a sentinel value
940 } else if (initial_comps
)
941 vector_free(initial_comps
);
943 // comps should always be null here
946 // free the adjusted input line
947 vector_free(input_line
);
949 // reset vty->node to its original value
950 vty
->node
= original_node
;
955 /* return parent node */
956 /* MUST eventually converge on CONFIG_NODE */
957 enum node_type
node_parent(enum node_type node
)
961 assert(node
> CONFIG_NODE
);
966 case BGP_FLOWSPECV4_NODE
:
967 case BGP_FLOWSPECV6_NODE
:
968 case BGP_VRF_POLICY_NODE
:
969 case BGP_VNC_DEFAULTS_NODE
:
970 case BGP_VNC_NVE_GROUP_NODE
:
971 case BGP_VNC_L2_GROUP_NODE
:
982 case BGP_EVPN_VNI_NODE
:
985 case KEYCHAIN_KEY_NODE
:
988 case LINK_PARAMS_NODE
:
989 ret
= INTERFACE_NODE
;
995 case LDP_IPV4_IFACE_NODE
:
998 case LDP_IPV6_IFACE_NODE
:
1001 case LDP_PSEUDOWIRE_NODE
:
1002 ret
= LDP_L2VPN_NODE
;
1015 /* Execute command by argument vline vector. */
1016 static int cmd_execute_command_real(vector vline
, enum cmd_filter_type filter
,
1018 const struct cmd_element
**cmd
)
1020 struct list
*argv_list
;
1021 enum matcher_rv status
;
1022 const struct cmd_element
*matched_element
= NULL
;
1024 struct graph
*cmdgraph
= cmd_node_graph(cmdvec
, vty
->node
);
1025 status
= command_match(cmdgraph
, vline
, &argv_list
, &matched_element
);
1028 *cmd
= matched_element
;
1030 // if matcher error, return corresponding CMD_ERR
1031 if (MATCHER_ERROR(status
)) {
1033 list_delete(&argv_list
);
1035 case MATCHER_INCOMPLETE
:
1036 return CMD_ERR_INCOMPLETE
;
1037 case MATCHER_AMBIGUOUS
:
1038 return CMD_ERR_AMBIGUOUS
;
1040 return CMD_ERR_NO_MATCH
;
1044 // build argv array from argv list
1045 struct cmd_token
**argv
= XMALLOC(
1046 MTYPE_TMP
, argv_list
->count
* sizeof(struct cmd_token
*));
1047 struct listnode
*ln
;
1048 struct cmd_token
*token
;
1050 for (ALL_LIST_ELEMENTS_RO(argv_list
, ln
, token
))
1053 int argc
= argv_list
->count
;
1056 if (matched_element
->daemon
)
1057 ret
= CMD_SUCCESS_DAEMON
;
1060 /* Clear array of enqueued configuration changes. */
1061 vty
->num_cfg_changes
= 0;
1062 memset(&vty
->cfg_changes
, 0, sizeof(vty
->cfg_changes
));
1064 /* Regenerate candidate configuration if necessary. */
1065 if (frr_get_cli_mode() == FRR_CLI_CLASSIC
1066 && running_config
->version
1067 > vty
->candidate_config
->version
)
1068 nb_config_replace(vty
->candidate_config
,
1069 running_config
, true);
1072 ret
= matched_element
->func(matched_element
, vty
, argc
, argv
);
1075 // delete list and cmd_token's in it
1076 list_delete(&argv_list
);
1077 XFREE(MTYPE_TMP
, argv
);
1083 * Execute a given command, handling things like "do ..." and checking
1084 * whether the given command might apply at a parent node if doesn't
1085 * apply for the current node.
1087 * @param vline Command line input, vector of char* where each element is
1089 * @param vty The vty context in which the command should be executed.
1090 * @param cmd Pointer where the struct cmd_element of the matched command
1091 * will be stored, if any. May be set to NULL if this info is
1093 * @param vtysh If set != 0, don't lookup the command at parent nodes.
1094 * @return The status of the command that has been executed or an error code
1095 * as to why no command could be executed.
1097 int cmd_execute_command(vector vline
, struct vty
*vty
,
1098 const struct cmd_element
**cmd
, int vtysh
)
1100 int ret
, saved_ret
= 0;
1101 enum node_type onode
, try_node
;
1102 int orig_xpath_index
;
1104 onode
= try_node
= vty
->node
;
1105 orig_xpath_index
= vty
->xpath_index
;
1107 if (cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0))) {
1108 vector shifted_vline
;
1111 vty
->node
= ENABLE_NODE
;
1112 vty
->xpath_index
= 0;
1113 /* We can try it on enable node, cos' the vty is authenticated
1116 shifted_vline
= vector_init(vector_count(vline
));
1118 for (index
= 1; index
< vector_active(vline
); index
++)
1119 vector_set_index(shifted_vline
, index
- 1,
1120 vector_lookup(vline
, index
));
1122 ret
= cmd_execute_command_real(shifted_vline
, FILTER_RELAXED
,
1125 vector_free(shifted_vline
);
1127 vty
->xpath_index
= orig_xpath_index
;
1132 cmd_execute_command_real(vline
, FILTER_RELAXED
, vty
, cmd
);
1137 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1138 && ret
!= CMD_NOT_MY_INSTANCE
&& ret
!= CMD_WARNING_CONFIG_FAILED
) {
1139 /* This assumes all nodes above CONFIG_NODE are childs of
1141 while (vty
->node
> CONFIG_NODE
) {
1142 try_node
= node_parent(try_node
);
1143 vty
->node
= try_node
;
1144 if (vty
->xpath_index
> 0)
1146 ret
= cmd_execute_command_real(vline
, FILTER_RELAXED
,
1148 if (ret
== CMD_SUCCESS
|| ret
== CMD_WARNING
1149 || ret
== CMD_NOT_MY_INSTANCE
1150 || ret
== CMD_WARNING_CONFIG_FAILED
)
1153 /* no command succeeded, reset the vty to the original node */
1155 vty
->xpath_index
= orig_xpath_index
;
1158 /* return command status for original node */
1163 * Execute a given command, matching it strictly against the current node.
1164 * This mode is used when reading config files.
1166 * @param vline Command line input, vector of char* where each element is
1168 * @param vty The vty context in which the command should be executed.
1169 * @param cmd Pointer where the struct cmd_element* of the matched command
1170 * will be stored, if any. May be set to NULL if this info is
1172 * @return The status of the command that has been executed or an error code
1173 * as to why no command could be executed.
1175 int cmd_execute_command_strict(vector vline
, struct vty
*vty
,
1176 const struct cmd_element
**cmd
)
1178 return cmd_execute_command_real(vline
, FILTER_STRICT
, vty
, cmd
);
1182 * Hook for preprocessing command string before executing.
1184 * All subscribers are called with the raw command string that is to be
1185 * executed. If any changes are to be made, a new string should be allocated
1186 * with MTYPE_TMP and *cmd_out updated to point to this new string. The caller
1187 * is then responsible for freeing this string.
1189 * All processing functions must be mutually exclusive in their action, i.e. if
1190 * one subscriber decides to modify the command, all others must not modify it
1191 * when called. Feeding the output of one processing command into a subsequent
1192 * one is not supported.
1194 * This hook is intentionally internal to the command processing system.
1197 * The raw command string.
1200 * The result of any processing.
1202 DECLARE_HOOK(cmd_execute
,
1203 (struct vty
*vty
, const char *cmd_in
, char **cmd_out
),
1204 (vty
, cmd_in
, cmd_out
));
1205 DEFINE_HOOK(cmd_execute
, (struct vty
*vty
, const char *cmd_in
, char **cmd_out
),
1206 (vty
, cmd_in
, cmd_out
));
1208 /* Hook executed after a CLI command. */
1209 DECLARE_KOOH(cmd_execute_done
, (struct vty
*vty
, const char *cmd_exec
),
1211 DEFINE_KOOH(cmd_execute_done
, (struct vty
*vty
, const char *cmd_exec
),
1215 * cmd_execute hook subscriber to handle `|` actions.
1217 static int handle_pipe_action(struct vty
*vty
, const char *cmd_in
,
1221 char *orig
, *working
, *token
, *u
;
1222 char *pipe
= strstr(cmd_in
, "| ");
1227 /* duplicate string for processing purposes, not including pipe */
1228 orig
= working
= XSTRDUP(MTYPE_TMP
, pipe
+ 2);
1230 /* retrieve action */
1231 token
= strsep(&working
, " ");
1234 /* match result to known actions */
1235 if (strmatch(token
, "include")) {
1236 /* the remaining text should be a regexp */
1237 char *regexp
= working
;
1240 vty_out(vty
, "%% Need a regexp to filter with\n");
1244 bool succ
= vty_set_include(vty
, regexp
);
1247 vty_out(vty
, "%% Bad regexp '%s'\n", regexp
);
1250 *cmd_out
= XSTRDUP(MTYPE_TMP
, cmd_in
);
1254 vty_out(vty
, "%% Unknown action '%s'\n", token
);
1259 XFREE(MTYPE_TMP
, orig
);
1263 static int handle_pipe_action_done(struct vty
*vty
, const char *cmd_exec
)
1266 vty_set_include(vty
, NULL
);
1271 int cmd_execute(struct vty
*vty
, const char *cmd
,
1272 const struct cmd_element
**matched
, int vtysh
)
1275 char *cmd_out
= NULL
;
1276 const char *cmd_exec
;
1279 hook_call(cmd_execute
, vty
, cmd
, &cmd_out
);
1280 cmd_exec
= cmd_out
? (const char *)cmd_out
: cmd
;
1282 vline
= cmd_make_strvec(cmd_exec
);
1285 ret
= cmd_execute_command(vline
, vty
, matched
, vtysh
);
1286 cmd_free_strvec(vline
);
1291 hook_call(cmd_execute_done
, vty
, cmd_exec
);
1293 XFREE(MTYPE_TMP
, cmd_out
);
1300 * Parse one line of config, walking up the parse tree attempting to find a
1303 * @param vty The vty context in which the command should be executed.
1304 * @param cmd Pointer where the struct cmd_element* of the match command
1305 * will be stored, if any. May be set to NULL if this info is
1307 * @param use_daemon Boolean to control whether or not we match on
1308 * CMD_SUCCESS_DAEMON
1310 * @return The status of the command that has been executed or an error code
1311 * as to why no command could be executed.
1313 int command_config_read_one_line(struct vty
*vty
,
1314 const struct cmd_element
**cmd
,
1315 uint32_t line_num
, int use_daemon
)
1320 vline
= cmd_make_strvec(vty
->buf
);
1322 /* In case of comment line */
1326 /* Execute configuration command : this is strict match */
1327 ret
= cmd_execute_command_strict(vline
, vty
, cmd
);
1329 // Climb the tree and try the command again at each node
1330 if (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1331 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1332 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1333 && ret
!= CMD_NOT_MY_INSTANCE
&& ret
!= CMD_WARNING_CONFIG_FAILED
1334 && vty
->node
!= CONFIG_NODE
) {
1335 int saved_node
= vty
->node
;
1336 int saved_xpath_index
= vty
->xpath_index
;
1338 while (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1339 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1340 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1341 && vty
->node
> CONFIG_NODE
) {
1342 vty
->node
= node_parent(vty
->node
);
1343 if (vty
->xpath_index
> 0)
1345 ret
= cmd_execute_command_strict(vline
, vty
, cmd
);
1348 // If climbing the tree did not work then ignore the command and
1349 // stay at the same node
1350 if (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1351 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1352 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
) {
1353 vty
->node
= saved_node
;
1354 vty
->xpath_index
= saved_xpath_index
;
1358 if (ret
!= CMD_SUCCESS
&&
1359 ret
!= CMD_WARNING
&&
1360 ret
!= CMD_SUCCESS_DAEMON
) {
1361 struct vty_error
*ve
= XCALLOC(MTYPE_TMP
, sizeof(*ve
));
1363 memcpy(ve
->error_buf
, vty
->buf
, VTY_BUFSIZ
);
1364 ve
->line_num
= line_num
;
1366 vty
->error
= list_new();
1368 listnode_add(vty
->error
, ve
);
1371 cmd_free_strvec(vline
);
1376 /* Configuration make from file. */
1377 int config_from_file(struct vty
*vty
, FILE *fp
, unsigned int *line_num
)
1379 int ret
, error_ret
= 0;
1382 while (fgets(vty
->buf
, VTY_BUFSIZ
, fp
)) {
1385 ret
= command_config_read_one_line(vty
, NULL
, *line_num
, 0);
1387 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1388 && ret
!= CMD_ERR_NOTHING_TODO
)
1399 /* Configuration from terminal */
1400 DEFUN (config_terminal
,
1401 config_terminal_cmd
,
1402 "configure [terminal]",
1403 "Configuration from vty interface\n"
1404 "Configuration terminal\n")
1406 return vty_config_enter(vty
, false, false);
1409 /* Enable command */
1413 "Turn on privileged mode command\n")
1415 /* If enable password is NULL, change to ENABLE_NODE */
1416 if ((host
.enable
== NULL
&& host
.enable_encrypt
== NULL
)
1417 || vty
->type
== VTY_SHELL_SERV
)
1418 vty
->node
= ENABLE_NODE
;
1420 vty
->node
= AUTH_ENABLE_NODE
;
1425 /* Disable command */
1429 "Turn off privileged mode command\n")
1431 if (vty
->node
== ENABLE_NODE
)
1432 vty
->node
= VIEW_NODE
;
1436 /* Down vty node level. */
1440 "Exit current mode and down to previous mode\n")
1446 void cmd_exit(struct vty
*vty
)
1448 switch (vty
->node
) {
1454 vty
->status
= VTY_CLOSE
;
1457 vty
->node
= ENABLE_NODE
;
1458 vty_config_exit(vty
);
1460 case INTERFACE_NODE
:
1473 case LDP_L2VPN_NODE
:
1475 case OPENFABRIC_NODE
:
1481 vty
->node
= CONFIG_NODE
;
1484 case BGP_IPV4M_NODE
:
1485 case BGP_IPV4L_NODE
:
1486 case BGP_VPNV4_NODE
:
1487 case BGP_VPNV6_NODE
:
1488 case BGP_FLOWSPECV4_NODE
:
1489 case BGP_FLOWSPECV6_NODE
:
1490 case BGP_VRF_POLICY_NODE
:
1491 case BGP_VNC_DEFAULTS_NODE
:
1492 case BGP_VNC_NVE_GROUP_NODE
:
1493 case BGP_VNC_L2_GROUP_NODE
:
1495 case BGP_IPV6M_NODE
:
1497 case BGP_IPV6L_NODE
:
1499 vty
->node
= BGP_NODE
;
1501 case BGP_EVPN_VNI_NODE
:
1502 vty
->node
= BGP_EVPN_NODE
;
1506 vty
->node
= LDP_NODE
;
1508 case LDP_IPV4_IFACE_NODE
:
1509 vty
->node
= LDP_IPV4_NODE
;
1511 case LDP_IPV6_IFACE_NODE
:
1512 vty
->node
= LDP_IPV6_NODE
;
1514 case LDP_PSEUDOWIRE_NODE
:
1515 vty
->node
= LDP_L2VPN_NODE
;
1517 case KEYCHAIN_KEY_NODE
:
1518 vty
->node
= KEYCHAIN_NODE
;
1520 case LINK_PARAMS_NODE
:
1521 vty
->node
= INTERFACE_NODE
;
1524 vty
->node
= BFD_NODE
;
1530 if (vty
->xpath_index
> 0)
1538 "Exit current mode and down to previous mode\n")
1540 return config_exit(self
, vty
, argc
, argv
);
1544 /* End of configuration. */
1548 "End current mode and change to enable mode.\n")
1551 vty_config_exit(vty
);
1552 vty
->node
= ENABLE_NODE
;
1559 DEFUN (show_version
,
1563 "Displays zebra version\n")
1565 vty_out(vty
, "%s %s (%s).\n", FRR_FULL_NAME
, FRR_VERSION
,
1566 cmd_hostname_get() ? cmd_hostname_get() : "");
1567 vty_out(vty
, "%s%s\n", FRR_COPYRIGHT
, GIT_INFO
);
1568 vty_out(vty
, "configured with:\n %s\n", FRR_CONFIG_ARGS
);
1573 /* "Set" version ... ignore version tags */
1574 DEFUN (frr_version_defaults
,
1575 frr_version_defaults_cmd
,
1576 "frr <version|defaults> LINE...",
1577 "FRRouting global parameters\n"
1578 "version configuration was written by\n"
1579 "set of configuration defaults used\n"
1585 /* Help display function for all node. */
1589 "Description of the interactive help system\n")
1592 "Quagga VTY provides advanced help feature. When you need help,\n\
1593 anytime at the command line please press '?'.\n\
1595 If nothing matches, the help list will be empty and you must backup\n\
1596 until entering a '?' shows the available options.\n\
1597 Two styles of help are provided:\n\
1598 1. Full help is available when you are ready to enter a\n\
1599 command argument (e.g. 'show ?') and describes each possible\n\
1601 2. Partial help is provided when an abbreviated argument is entered\n\
1602 and you want to know what arguments match the input\n\
1603 (e.g. 'show me?'.)\n\n");
1607 static void permute(struct graph_node
*start
, struct vty
*vty
)
1609 static struct list
*position
= NULL
;
1611 position
= list_new();
1613 struct cmd_token
*stok
= start
->data
;
1614 struct graph_node
*gnn
;
1615 struct listnode
*ln
;
1618 listnode_add(position
, start
);
1619 for (unsigned int i
= 0; i
< vector_active(start
->to
); i
++) {
1620 struct graph_node
*gn
= vector_slot(start
->to
, i
);
1621 struct cmd_token
*tok
= gn
->data
;
1622 if (tok
->attr
== CMD_ATTR_HIDDEN
1623 || tok
->attr
== CMD_ATTR_DEPRECATED
)
1625 else if (tok
->type
== END_TKN
|| gn
== start
) {
1627 for (ALL_LIST_ELEMENTS_RO(position
, ln
, gnn
)) {
1628 struct cmd_token
*tt
= gnn
->data
;
1629 if (tt
->type
< SPECIAL_TKN
)
1630 vty_out(vty
, " %s", tt
->text
);
1633 vty_out(vty
, "...");
1637 if (stok
->type
== FORK_TKN
&& tok
->type
!= FORK_TKN
)
1638 for (ALL_LIST_ELEMENTS_RO(position
, ln
, gnn
))
1647 list_delete_node(position
, listtail(position
));
1650 int cmd_list_cmds(struct vty
*vty
, int do_permute
)
1652 struct cmd_node
*node
= vector_slot(cmdvec
, vty
->node
);
1655 permute(vector_slot(node
->cmdgraph
->nodes
, 0), vty
);
1657 /* loop over all commands at this node */
1658 struct cmd_element
*element
= NULL
;
1659 for (unsigned int i
= 0; i
< vector_active(node
->cmd_vector
);
1661 if ((element
= vector_slot(node
->cmd_vector
, i
))
1662 && element
->attr
!= CMD_ATTR_DEPRECATED
1663 && element
->attr
!= CMD_ATTR_HIDDEN
)
1664 vty_out(vty
, " %s\n", element
->string
);
1669 /* Help display function for all node. */
1672 "list [permutations]",
1673 "Print command list\n"
1674 "Print all possible command permutations\n")
1676 return cmd_list_cmds(vty
, argc
== 2);
1679 DEFUN (show_commandtree
,
1680 show_commandtree_cmd
,
1681 "show commandtree [permutations]",
1683 "Show command tree\n"
1684 "Permutations that we are interested in\n")
1686 return cmd_list_cmds(vty
, argc
== 3);
1689 DEFUN_HIDDEN(show_cli_graph
,
1694 "Dump current command space as DOT graph\n")
1696 struct cmd_node
*cn
= vector_slot(cmdvec
, vty
->node
);
1697 char *dot
= cmd_graph_dump_dot(cn
->cmdgraph
);
1699 vty_out(vty
, "%s\n", dot
);
1700 XFREE(MTYPE_TMP
, dot
);
1704 static int vty_write_config(struct vty
*vty
)
1707 struct cmd_node
*node
;
1712 if (vty
->type
== VTY_TERM
) {
1713 vty_out(vty
, "\nCurrent configuration:\n");
1714 vty_out(vty
, "!\n");
1717 vty_out(vty
, "frr version %s\n", FRR_VER_SHORT
);
1718 vty_out(vty
, "frr defaults %s\n", DFLT_NAME
);
1719 vty_out(vty
, "!\n");
1721 for (i
= 0; i
< vector_active(cmdvec
); i
++)
1722 if ((node
= vector_slot(cmdvec
, i
)) && node
->func
1723 && (node
->vtysh
|| vty
->type
!= VTY_SHELL
)) {
1724 if ((*node
->func
)(vty
))
1725 vty_out(vty
, "!\n");
1728 if (vty
->type
== VTY_TERM
) {
1729 vty_out(vty
, "end\n");
1735 static int file_write_config(struct vty
*vty
)
1738 char *config_file
, *slash
;
1739 char *config_file_tmp
= NULL
;
1740 char *config_file_sav
= NULL
;
1741 int ret
= CMD_WARNING
;
1742 struct vty
*file_vty
;
1743 struct stat conf_stat
;
1748 /* Check and see if we are operating under vtysh configuration */
1749 if (host
.config
== NULL
) {
1751 "Can't save to configuration file, using vtysh.\n");
1756 config_file
= host
.config
;
1759 #define O_DIRECTORY 0
1761 slash
= strrchr(config_file
, '/');
1763 char *config_dir
= XSTRDUP(MTYPE_TMP
, config_file
);
1764 config_dir
[slash
- config_file
] = '\0';
1765 dirfd
= open(config_dir
, O_DIRECTORY
| O_RDONLY
);
1766 XFREE(MTYPE_TMP
, config_dir
);
1768 dirfd
= open(".", O_DIRECTORY
| O_RDONLY
);
1769 /* if dirfd is invalid, directory sync fails, but we're still OK */
1771 size_t config_file_sav_sz
= strlen(config_file
) + strlen(CONF_BACKUP_EXT
) + 1;
1772 config_file_sav
= XMALLOC(MTYPE_TMP
, config_file_sav_sz
);
1773 strlcpy(config_file_sav
, config_file
, config_file_sav_sz
);
1774 strlcat(config_file_sav
, CONF_BACKUP_EXT
, config_file_sav_sz
);
1777 config_file_tmp
= XMALLOC(MTYPE_TMP
, strlen(config_file
) + 8);
1778 sprintf(config_file_tmp
, "%s.XXXXXX", config_file
);
1780 /* Open file to configuration write. */
1781 fd
= mkstemp(config_file_tmp
);
1783 vty_out(vty
, "Can't open configuration file %s.\n",
1787 if (fchmod(fd
, CONFIGFILE_MASK
) != 0) {
1788 vty_out(vty
, "Can't chmod configuration file %s: %s (%d).\n",
1789 config_file_tmp
, safe_strerror(errno
), errno
);
1793 /* Make vty for configuration file. */
1794 file_vty
= vty_new();
1796 file_vty
->type
= VTY_FILE
;
1798 /* Config file header print. */
1799 vty_out(file_vty
, "!\n! Zebra configuration saved from vty\n! ");
1800 vty_time_print(file_vty
, 1);
1801 vty_out(file_vty
, "!\n");
1802 vty_write_config(file_vty
);
1803 vty_close(file_vty
);
1805 if (stat(config_file
, &conf_stat
) >= 0) {
1806 if (unlink(config_file_sav
) != 0)
1807 if (errno
!= ENOENT
) {
1809 "Can't unlink backup configuration file %s.\n",
1813 if (link(config_file
, config_file_sav
) != 0) {
1815 "Can't backup old configuration file %s.\n",
1822 if (rename(config_file_tmp
, config_file
) != 0) {
1823 vty_out(vty
, "Can't save configuration file %s.\n",
1830 vty_out(vty
, "Configuration saved to %s\n", config_file
);
1834 if (ret
!= CMD_SUCCESS
)
1835 unlink(config_file_tmp
);
1838 XFREE(MTYPE_TMP
, config_file_tmp
);
1839 XFREE(MTYPE_TMP
, config_file_sav
);
1843 /* Write current configuration into file. */
1845 DEFUN (config_write
,
1847 "write [<file|memory|terminal>]",
1848 "Write running configuration to memory, network, or terminal\n"
1849 "Write to configuration file\n"
1850 "Write configuration currently in memory\n"
1851 "Write configuration to terminal\n")
1853 const int idx_type
= 1;
1855 // if command was 'write terminal' or 'write memory'
1856 if (argc
== 2 && (!strcmp(argv
[idx_type
]->text
, "terminal"))) {
1857 return vty_write_config(vty
);
1860 return file_write_config(vty
);
1863 /* ALIAS_FIXME for 'write <terminal|memory>' */
1864 DEFUN (show_running_config
,
1865 show_running_config_cmd
,
1866 "show running-config",
1868 "running configuration (same as write terminal)\n")
1870 return vty_write_config(vty
);
1873 /* ALIAS_FIXME for 'write file' */
1874 DEFUN (copy_runningconf_startupconf
,
1875 copy_runningconf_startupconf_cmd
,
1876 "copy running-config startup-config",
1877 "Copy configuration\n"
1878 "Copy running config to... \n"
1879 "Copy running config to startup config (same as write file/memory)\n")
1881 return file_write_config(vty
);
1885 /* Write startup configuration into the terminal. */
1886 DEFUN (show_startup_config
,
1887 show_startup_config_cmd
,
1888 "show startup-config",
1890 "Contents of startup configuration\n")
1897 if (host
.config
== NULL
)
1900 confp
= fopen(host
.config
, "r");
1901 if (confp
== NULL
) {
1902 vty_out(vty
, "Can't open configuration file [%s] due to '%s'\n",
1903 host
.config
, safe_strerror(errno
));
1907 while (fgets(buf
, BUFSIZ
, confp
)) {
1910 while (*cp
!= '\r' && *cp
!= '\n' && *cp
!= '\0')
1914 vty_out(vty
, "%s\n", buf
);
1922 int cmd_domainname_set(const char *domainname
)
1924 XFREE(MTYPE_HOST
, host
.domainname
);
1925 host
.domainname
= domainname
? XSTRDUP(MTYPE_HOST
, domainname
) : NULL
;
1929 /* Hostname configuration */
1930 DEFUN(config_domainname
,
1933 "Set system's domain name\n"
1934 "This system's domain name\n")
1936 struct cmd_token
*word
= argv
[1];
1938 if (!isalpha((unsigned char)word
->arg
[0])) {
1939 vty_out(vty
, "Please specify string starting with alphabet\n");
1940 return CMD_WARNING_CONFIG_FAILED
;
1943 return cmd_domainname_set(word
->arg
);
1946 DEFUN(config_no_domainname
,
1948 "no domainname [DOMAINNAME]",
1950 "Reset system's domain name\n"
1951 "domain name of this router\n")
1953 return cmd_domainname_set(NULL
);
1956 int cmd_hostname_set(const char *hostname
)
1958 XFREE(MTYPE_HOST
, host
.name
);
1959 host
.name
= hostname
? XSTRDUP(MTYPE_HOST
, hostname
) : NULL
;
1963 /* Hostname configuration */
1964 DEFUN (config_hostname
,
1967 "Set system's network name\n"
1968 "This system's network name\n")
1970 struct cmd_token
*word
= argv
[1];
1972 if (!isalnum((unsigned char)word
->arg
[0])) {
1974 "Please specify string starting with alphabet or number\n");
1975 return CMD_WARNING_CONFIG_FAILED
;
1978 /* With reference to RFC 1123 Section 2.1 */
1979 if (strlen(word
->arg
) > HOSTNAME_LEN
) {
1980 vty_out(vty
, "Hostname length should be less than %d chars\n",
1982 return CMD_WARNING_CONFIG_FAILED
;
1985 return cmd_hostname_set(word
->arg
);
1988 DEFUN (config_no_hostname
,
1990 "no hostname [HOSTNAME]",
1992 "Reset system's network name\n"
1993 "Host name of this router\n")
1995 return cmd_hostname_set(NULL
);
1998 /* VTY interface password set. */
1999 DEFUN (config_password
,
2001 "password [(8-8)] WORD",
2002 "Modify the terminal connection password\n"
2003 "Specifies a HIDDEN password will follow\n"
2004 "The password string\n")
2008 if (argc
== 3) // '8' was specified
2011 XFREE(MTYPE_HOST
, host
.password
);
2012 host
.password
= NULL
;
2013 if (host
.password_encrypt
)
2014 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2015 host
.password_encrypt
=
2016 XSTRDUP(MTYPE_HOST
, argv
[idx_word
]->arg
);
2020 if (!isalnum((unsigned char)argv
[idx_8
]->arg
[0])) {
2022 "Please specify string starting with alphanumeric\n");
2023 return CMD_WARNING_CONFIG_FAILED
;
2027 XFREE(MTYPE_HOST
, host
.password
);
2028 host
.password
= NULL
;
2031 if (host
.password_encrypt
)
2032 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2033 host
.password_encrypt
=
2034 XSTRDUP(MTYPE_HOST
, zencrypt(argv
[idx_8
]->arg
));
2036 host
.password
= XSTRDUP(MTYPE_HOST
, argv
[idx_8
]->arg
);
2041 /* VTY interface password delete. */
2042 DEFUN (no_config_password
,
2046 "Modify the terminal connection password\n")
2048 bool warned
= false;
2050 if (host
.password
) {
2051 if (!vty_shell_serv(vty
)) {
2052 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2055 XFREE(MTYPE_HOST
, host
.password
);
2057 host
.password
= NULL
;
2059 if (host
.password_encrypt
) {
2060 if (!warned
&& !vty_shell_serv(vty
))
2061 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2062 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2064 host
.password_encrypt
= NULL
;
2069 /* VTY enable password set. */
2070 DEFUN (config_enable_password
,
2071 enable_password_cmd
,
2072 "enable password [(8-8)] WORD",
2073 "Modify enable password parameters\n"
2074 "Assign the privileged level password\n"
2075 "Specifies a HIDDEN password will follow\n"
2076 "The HIDDEN 'enable' password string\n")
2081 /* Crypt type is specified. */
2083 if (argv
[idx_8
]->arg
[0] == '8') {
2085 XFREE(MTYPE_HOST
, host
.enable
);
2088 if (host
.enable_encrypt
)
2089 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2090 host
.enable_encrypt
=
2091 XSTRDUP(MTYPE_HOST
, argv
[idx_word
]->arg
);
2095 vty_out(vty
, "Unknown encryption type.\n");
2096 return CMD_WARNING_CONFIG_FAILED
;
2100 if (!isalnum((unsigned char)argv
[idx_8
]->arg
[0])) {
2102 "Please specify string starting with alphanumeric\n");
2103 return CMD_WARNING_CONFIG_FAILED
;
2107 XFREE(MTYPE_HOST
, host
.enable
);
2110 /* Plain password input. */
2112 if (host
.enable_encrypt
)
2113 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2114 host
.enable_encrypt
=
2115 XSTRDUP(MTYPE_HOST
, zencrypt(argv
[idx_8
]->arg
));
2117 host
.enable
= XSTRDUP(MTYPE_HOST
, argv
[idx_8
]->arg
);
2122 /* VTY enable password delete. */
2123 DEFUN (no_config_enable_password
,
2124 no_enable_password_cmd
,
2125 "no enable password",
2127 "Modify enable password parameters\n"
2128 "Assign the privileged level password\n")
2130 bool warned
= false;
2133 if (!vty_shell_serv(vty
)) {
2134 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2137 XFREE(MTYPE_HOST
, host
.enable
);
2141 if (host
.enable_encrypt
) {
2142 if (!warned
&& !vty_shell_serv(vty
))
2143 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2144 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2146 host
.enable_encrypt
= NULL
;
2151 DEFUN (service_password_encrypt
,
2152 service_password_encrypt_cmd
,
2153 "service password-encryption",
2154 "Set up miscellaneous service\n"
2155 "Enable encrypted passwords\n")
2162 if (host
.password
) {
2163 if (host
.password_encrypt
)
2164 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2165 host
.password_encrypt
=
2166 XSTRDUP(MTYPE_HOST
, zencrypt(host
.password
));
2169 if (host
.enable_encrypt
)
2170 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2171 host
.enable_encrypt
=
2172 XSTRDUP(MTYPE_HOST
, zencrypt(host
.enable
));
2178 DEFUN (no_service_password_encrypt
,
2179 no_service_password_encrypt_cmd
,
2180 "no service password-encryption",
2182 "Set up miscellaneous service\n"
2183 "Enable encrypted passwords\n")
2190 if (host
.password_encrypt
)
2191 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2192 host
.password_encrypt
= NULL
;
2194 if (host
.enable_encrypt
)
2195 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2196 host
.enable_encrypt
= NULL
;
2201 DEFUN (config_terminal_length
,
2202 config_terminal_length_cmd
,
2203 "terminal length (0-512)",
2204 "Set terminal line parameters\n"
2205 "Set number of lines on a screen\n"
2206 "Number of lines on screen (0 for no pausing)\n")
2210 vty
->lines
= atoi(argv
[idx_number
]->arg
);
2215 DEFUN (config_terminal_no_length
,
2216 config_terminal_no_length_cmd
,
2217 "terminal no length",
2218 "Set terminal line parameters\n"
2220 "Set number of lines on a screen\n")
2226 DEFUN (service_terminal_length
,
2227 service_terminal_length_cmd
,
2228 "service terminal-length (0-512)",
2229 "Set up miscellaneous service\n"
2230 "System wide terminal length configuration\n"
2231 "Number of lines of VTY (0 means no line control)\n")
2235 host
.lines
= atoi(argv
[idx_number
]->arg
);
2240 DEFUN (no_service_terminal_length
,
2241 no_service_terminal_length_cmd
,
2242 "no service terminal-length [(0-512)]",
2244 "Set up miscellaneous service\n"
2245 "System wide terminal length configuration\n"
2246 "Number of lines of VTY (0 means no line control)\n")
2252 DEFUN_HIDDEN (do_echo
,
2255 "Echo a message back to the vty\n"
2256 "The message to echo\n")
2260 vty_out(vty
, "%s\n",
2261 ((message
= argv_concat(argv
, argc
, 1)) ? message
: ""));
2263 XFREE(MTYPE_TMP
, message
);
2267 DEFUN (config_logmsg
,
2269 "logmsg <emergencies|alerts|critical|errors|warnings|notifications|informational|debugging> MESSAGE...",
2270 "Send a message to enabled logging destinations\n"
2272 "The message to send\n")
2274 int idx_log_level
= 1;
2275 int idx_message
= 2;
2279 if ((level
= level_match(argv
[idx_log_level
]->arg
)) == ZLOG_DISABLED
)
2280 return CMD_ERR_NO_MATCH
;
2283 ((message
= argv_concat(argv
, argc
, idx_message
)) ? message
: ""));
2285 XFREE(MTYPE_TMP
, message
);
2290 DEFUN (show_logging
,
2294 "Show current logging configuration\n")
2296 struct zlog
*zl
= zlog_default
;
2298 vty_out(vty
, "Syslog logging: ");
2299 if (zl
->maxlvl
[ZLOG_DEST_SYSLOG
] == ZLOG_DISABLED
)
2300 vty_out(vty
, "disabled");
2302 vty_out(vty
, "level %s, facility %s, ident %s",
2303 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_SYSLOG
]],
2304 facility_name(zl
->facility
), zl
->ident
);
2307 vty_out(vty
, "Stdout logging: ");
2308 if (zl
->maxlvl
[ZLOG_DEST_STDOUT
] == ZLOG_DISABLED
)
2309 vty_out(vty
, "disabled");
2311 vty_out(vty
, "level %s",
2312 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_STDOUT
]]);
2315 vty_out(vty
, "Monitor logging: ");
2316 if (zl
->maxlvl
[ZLOG_DEST_MONITOR
] == ZLOG_DISABLED
)
2317 vty_out(vty
, "disabled");
2319 vty_out(vty
, "level %s",
2320 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_MONITOR
]]);
2323 vty_out(vty
, "File logging: ");
2324 if ((zl
->maxlvl
[ZLOG_DEST_FILE
] == ZLOG_DISABLED
) || !zl
->fp
)
2325 vty_out(vty
, "disabled");
2327 vty_out(vty
, "level %s, filename %s",
2328 zlog_priority
[zl
->maxlvl
[ZLOG_DEST_FILE
]],
2332 vty_out(vty
, "Protocol name: %s\n", zl
->protoname
);
2333 vty_out(vty
, "Record priority: %s\n",
2334 (zl
->record_priority
? "enabled" : "disabled"));
2335 vty_out(vty
, "Timestamp precision: %d\n", zl
->timestamp_precision
);
2340 DEFUN (config_log_stdout
,
2341 config_log_stdout_cmd
,
2342 "log stdout [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2344 "Set stdout logging level\n"
2347 int idx_log_level
= 2;
2349 if (argc
== idx_log_level
) {
2350 zlog_set_level(ZLOG_DEST_STDOUT
, zlog_default
->default_lvl
);
2355 if ((level
= level_match(argv
[idx_log_level
]->arg
)) == ZLOG_DISABLED
)
2356 return CMD_ERR_NO_MATCH
;
2357 zlog_set_level(ZLOG_DEST_STDOUT
, level
);
2361 DEFUN (no_config_log_stdout
,
2362 no_config_log_stdout_cmd
,
2363 "no log stdout [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2366 "Cancel logging to stdout\n"
2369 zlog_set_level(ZLOG_DEST_STDOUT
, ZLOG_DISABLED
);
2373 DEFUN (config_log_monitor
,
2374 config_log_monitor_cmd
,
2375 "log monitor [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2377 "Set terminal line (monitor) logging level\n"
2380 int idx_log_level
= 2;
2382 if (argc
== idx_log_level
) {
2383 zlog_set_level(ZLOG_DEST_MONITOR
, zlog_default
->default_lvl
);
2388 if ((level
= level_match(argv
[idx_log_level
]->arg
)) == ZLOG_DISABLED
)
2389 return CMD_ERR_NO_MATCH
;
2390 zlog_set_level(ZLOG_DEST_MONITOR
, level
);
2394 DEFUN (no_config_log_monitor
,
2395 no_config_log_monitor_cmd
,
2396 "no log monitor [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2399 "Disable terminal line (monitor) logging\n"
2402 zlog_set_level(ZLOG_DEST_MONITOR
, ZLOG_DISABLED
);
2406 static int set_log_file(struct vty
*vty
, const char *fname
, int loglevel
)
2410 const char *fullpath
;
2412 /* Path detection. */
2413 if (!IS_DIRECTORY_SEP(*fname
)) {
2414 char cwd
[MAXPATHLEN
+ 1];
2415 cwd
[MAXPATHLEN
] = '\0';
2417 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
2418 flog_err_sys(EC_LIB_SYSTEM_CALL
,
2419 "config_log_file: Unable to alloc mem!");
2420 return CMD_WARNING_CONFIG_FAILED
;
2423 p
= XMALLOC(MTYPE_TMP
, strlen(cwd
) + strlen(fname
) + 2);
2424 sprintf(p
, "%s/%s", cwd
, fname
);
2429 ret
= zlog_set_file(fullpath
, loglevel
);
2431 XFREE(MTYPE_TMP
, p
);
2435 vty_out(vty
, "can't open logfile %s\n", fname
);
2436 return CMD_WARNING_CONFIG_FAILED
;
2439 XFREE(MTYPE_HOST
, host
.logfile
);
2441 host
.logfile
= XSTRDUP(MTYPE_HOST
, fname
);
2443 #if defined(HAVE_CUMULUS)
2444 if (zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
] != ZLOG_DISABLED
)
2445 zlog_set_level(ZLOG_DEST_SYSLOG
, ZLOG_DISABLED
);
2450 void command_setup_early_logging(const char *dest
, const char *level
)
2455 int nlevel
= level_match(level
);
2457 if (nlevel
!= ZLOG_DISABLED
)
2458 zlog_default
->default_lvl
= nlevel
;
2464 if (strcmp(dest
, "stdout") == 0) {
2465 zlog_set_level(ZLOG_DEST_STDOUT
, zlog_default
->default_lvl
);
2469 if (strcmp(dest
, "syslog") == 0) {
2470 zlog_set_level(ZLOG_DEST_SYSLOG
, zlog_default
->default_lvl
);
2474 token
= strstr(dest
, ":");
2480 set_log_file(NULL
, token
, zlog_default
->default_lvl
);
2483 DEFUN (config_log_file
,
2484 config_log_file_cmd
,
2485 "log file FILENAME [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2488 "Logging filename\n"
2491 int idx_filename
= 2;
2492 int idx_log_levels
= 3;
2495 if ((level
= level_match(argv
[idx_log_levels
]->arg
))
2497 return CMD_ERR_NO_MATCH
;
2498 return set_log_file(vty
, argv
[idx_filename
]->arg
, level
);
2500 return set_log_file(vty
, argv
[idx_filename
]->arg
,
2501 zlog_default
->default_lvl
);
2504 static void disable_log_file(void)
2508 XFREE(MTYPE_HOST
, host
.logfile
);
2510 host
.logfile
= NULL
;
2513 DEFUN (no_config_log_file
,
2514 no_config_log_file_cmd
,
2515 "no log file [FILENAME [LEVEL]]",
2518 "Cancel logging to file\n"
2519 "Logging file name\n"
2526 DEFUN (config_log_syslog
,
2527 config_log_syslog_cmd
,
2528 "log syslog [<emergencies|alerts|critical|errors|warnings|notifications|informational|debugging>]",
2530 "Set syslog logging level\n"
2533 int idx_log_levels
= 2;
2537 if ((level
= level_match(argv
[idx_log_levels
]->arg
))
2539 return CMD_ERR_NO_MATCH
;
2540 zlog_set_level(ZLOG_DEST_SYSLOG
, level
);
2543 zlog_set_level(ZLOG_DEST_SYSLOG
, zlog_default
->default_lvl
);
2548 DEFUN (no_config_log_syslog
,
2549 no_config_log_syslog_cmd
,
2550 "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>]",
2553 "Cancel logging to syslog\n"
2557 zlog_set_level(ZLOG_DEST_SYSLOG
, ZLOG_DISABLED
);
2561 DEFUN (config_log_facility
,
2562 config_log_facility_cmd
,
2563 "log facility <kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7>",
2565 "Facility parameter for syslog messages\n"
2569 int facility
= facility_match(argv
[idx_target
]->arg
);
2571 zlog_default
->facility
= facility
;
2575 DEFUN (no_config_log_facility
,
2576 no_config_log_facility_cmd
,
2577 "no log facility [<kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7>]",
2580 "Reset syslog facility to default (daemon)\n"
2583 zlog_default
->facility
= LOG_DAEMON
;
2587 DEFUN (config_log_record_priority
,
2588 config_log_record_priority_cmd
,
2589 "log record-priority",
2591 "Log the priority of the message within the message\n")
2593 zlog_default
->record_priority
= 1;
2597 DEFUN (no_config_log_record_priority
,
2598 no_config_log_record_priority_cmd
,
2599 "no log record-priority",
2602 "Do not log the priority of the message within the message\n")
2604 zlog_default
->record_priority
= 0;
2608 DEFUN (config_log_timestamp_precision
,
2609 config_log_timestamp_precision_cmd
,
2610 "log timestamp precision (0-6)",
2612 "Timestamp configuration\n"
2613 "Set the timestamp precision\n"
2614 "Number of subsecond digits\n")
2617 zlog_default
->timestamp_precision
=
2618 strtoul(argv
[idx_number
]->arg
, NULL
, 10);
2622 DEFUN (no_config_log_timestamp_precision
,
2623 no_config_log_timestamp_precision_cmd
,
2624 "no log timestamp precision",
2627 "Timestamp configuration\n"
2628 "Reset the timestamp precision to the default value of 0\n")
2630 zlog_default
->timestamp_precision
= 0;
2634 DEFUN (debug_memstats
,
2636 "[no] debug memstats-at-exit",
2639 "Print memory type statistics at exit\n")
2641 debug_memstats_at_exit
= !!strcmp(argv
[0]->text
, "no");
2645 int cmd_banner_motd_file(const char *file
)
2647 int success
= CMD_SUCCESS
;
2652 rpath
= realpath(file
, p
);
2654 return CMD_ERR_NO_FILE
;
2655 in
= strstr(rpath
, SYSCONFDIR
);
2657 XFREE(MTYPE_HOST
, host
.motdfile
);
2658 host
.motdfile
= XSTRDUP(MTYPE_HOST
, file
);
2660 success
= CMD_WARNING_CONFIG_FAILED
;
2665 DEFUN (banner_motd_file
,
2666 banner_motd_file_cmd
,
2667 "banner motd file FILE",
2670 "Banner from a file\n"
2674 const char *filename
= argv
[idx_file
]->arg
;
2675 int cmd
= cmd_banner_motd_file(filename
);
2677 if (cmd
== CMD_ERR_NO_FILE
)
2678 vty_out(vty
, "%s does not exist", filename
);
2679 else if (cmd
== CMD_WARNING_CONFIG_FAILED
)
2680 vty_out(vty
, "%s must be in %s", filename
, SYSCONFDIR
);
2685 DEFUN (banner_motd_default
,
2686 banner_motd_default_cmd
,
2687 "banner motd default",
2688 "Set banner string\n"
2689 "Strings for motd\n"
2692 host
.motd
= default_motd
;
2696 DEFUN (no_banner_motd
,
2700 "Set banner string\n"
2701 "Strings for motd\n")
2705 XFREE(MTYPE_HOST
, host
.motdfile
);
2706 host
.motdfile
= NULL
;
2713 "Find CLI command matching a regular expression\n"
2714 "Search pattern (POSIX regex)\n")
2716 char *pattern
= argv
[1]->arg
;
2717 const struct cmd_node
*node
;
2718 const struct cmd_element
*cli
;
2723 int cr
= regcomp(&exp
, pattern
, REG_NOSUB
| REG_EXTENDED
);
2728 vty_out(vty
, "%% Invalid {...} expression\n");
2731 vty_out(vty
, "%% Bad repetition operator\n");
2734 vty_out(vty
, "%% Regex syntax error\n");
2737 vty_out(vty
, "%% Invalid collating element\n");
2740 vty_out(vty
, "%% Invalid character class name\n");
2744 "%% Regex ended with escape character (\\)\n");
2748 "%% Invalid number in \\digit construction\n");
2751 vty_out(vty
, "%% Unbalanced square brackets\n");
2754 vty_out(vty
, "%% Unbalanced parentheses\n");
2757 vty_out(vty
, "%% Unbalanced braces\n");
2761 "%% Invalid endpoint in range expression\n");
2764 vty_out(vty
, "%% Failed to compile (out of memory)\n");
2772 for (unsigned int i
= 0; i
< vector_active(cmdvec
); i
++) {
2773 node
= vector_slot(cmdvec
, i
);
2776 clis
= node
->cmd_vector
;
2777 for (unsigned int j
= 0; j
< vector_active(clis
); j
++) {
2778 cli
= vector_slot(clis
, j
);
2780 if (regexec(&exp
, cli
->string
, 0, NULL
, 0) == 0)
2781 vty_out(vty
, " (%s) %s\n",
2782 node_names
[node
->node
], cli
->string
);
2791 /* Set config filename. Called from vty.c */
2792 void host_config_set(const char *filename
)
2794 XFREE(MTYPE_HOST
, host
.config
);
2795 host
.config
= XSTRDUP(MTYPE_HOST
, filename
);
2798 const char *host_config_get(void)
2803 void install_default(enum node_type node
)
2805 install_element(node
, &config_exit_cmd
);
2806 install_element(node
, &config_quit_cmd
);
2807 install_element(node
, &config_end_cmd
);
2808 install_element(node
, &config_help_cmd
);
2809 install_element(node
, &config_list_cmd
);
2810 install_element(node
, &show_cli_graph_cmd
);
2811 install_element(node
, &find_cmd
);
2813 install_element(node
, &config_write_cmd
);
2814 install_element(node
, &show_running_config_cmd
);
2816 install_element(node
, &autocomplete_cmd
);
2818 nb_cli_install_default(node
);
2821 /* Initialize command interface. Install basic nodes and commands.
2823 * terminal = 0 -- vtysh / no logging, no config control
2824 * terminal = 1 -- normal daemon
2825 * terminal = -1 -- watchfrr / no logging, but minimal config control */
2826 void cmd_init(int terminal
)
2828 struct utsname names
;
2830 if (array_size(node_names
) != NODE_TYPE_MAX
)
2831 assert(!"Update the CLI node description array!");
2836 /* register command preprocessors */
2837 hook_register(cmd_execute
, handle_pipe_action
);
2838 hook_register(cmd_execute_done
, handle_pipe_action_done
);
2840 varhandlers
= list_new();
2842 /* Allocate initial top vector of commands. */
2843 cmdvec
= vector_init(VECTOR_MIN_SIZE
);
2845 /* Default host value settings. */
2846 host
.name
= XSTRDUP(MTYPE_HOST
, names
.nodename
);
2847 #ifdef HAVE_STRUCT_UTSNAME_DOMAINNAME
2848 if ((strcmp(names
.domainname
, "(none)") == 0))
2849 host
.domainname
= NULL
;
2851 host
.domainname
= XSTRDUP(MTYPE_HOST
, names
.domainname
);
2853 host
.domainname
= NULL
;
2855 host
.password
= NULL
;
2857 host
.logfile
= NULL
;
2859 host
.noconfig
= (terminal
< 0);
2861 host
.motd
= default_motd
;
2862 host
.motdfile
= NULL
;
2864 /* Install top nodes. */
2865 install_node(&view_node
, NULL
);
2866 install_node(&enable_node
, NULL
);
2867 install_node(&auth_node
, NULL
);
2868 install_node(&auth_enable_node
, NULL
);
2869 install_node(&config_node
, config_write_host
);
2871 /* Each node's basic commands. */
2872 install_element(VIEW_NODE
, &show_version_cmd
);
2873 install_element(ENABLE_NODE
, &show_startup_config_cmd
);
2876 install_element(ENABLE_NODE
, &debug_memstats_cmd
);
2878 install_element(VIEW_NODE
, &config_list_cmd
);
2879 install_element(VIEW_NODE
, &config_exit_cmd
);
2880 install_element(VIEW_NODE
, &config_quit_cmd
);
2881 install_element(VIEW_NODE
, &config_help_cmd
);
2882 install_element(VIEW_NODE
, &config_enable_cmd
);
2883 install_element(VIEW_NODE
, &config_terminal_length_cmd
);
2884 install_element(VIEW_NODE
, &config_terminal_no_length_cmd
);
2885 install_element(VIEW_NODE
, &show_logging_cmd
);
2886 install_element(VIEW_NODE
, &show_commandtree_cmd
);
2887 install_element(VIEW_NODE
, &echo_cmd
);
2888 install_element(VIEW_NODE
, &autocomplete_cmd
);
2889 install_element(VIEW_NODE
, &find_cmd
);
2891 install_element(ENABLE_NODE
, &config_end_cmd
);
2892 install_element(ENABLE_NODE
, &config_disable_cmd
);
2893 install_element(ENABLE_NODE
, &config_terminal_cmd
);
2894 install_element(ENABLE_NODE
, ©_runningconf_startupconf_cmd
);
2895 install_element(ENABLE_NODE
, &config_write_cmd
);
2896 install_element(ENABLE_NODE
, &show_running_config_cmd
);
2897 install_element(ENABLE_NODE
, &config_logmsg_cmd
);
2899 install_default(CONFIG_NODE
);
2902 workqueue_cmd_init();
2906 install_element(CONFIG_NODE
, &hostname_cmd
);
2907 install_element(CONFIG_NODE
, &no_hostname_cmd
);
2908 install_element(CONFIG_NODE
, &domainname_cmd
);
2909 install_element(CONFIG_NODE
, &no_domainname_cmd
);
2910 install_element(CONFIG_NODE
, &frr_version_defaults_cmd
);
2913 install_element(CONFIG_NODE
, &debug_memstats_cmd
);
2915 install_element(CONFIG_NODE
, &password_cmd
);
2916 install_element(CONFIG_NODE
, &no_password_cmd
);
2917 install_element(CONFIG_NODE
, &enable_password_cmd
);
2918 install_element(CONFIG_NODE
, &no_enable_password_cmd
);
2920 install_element(CONFIG_NODE
, &config_log_stdout_cmd
);
2921 install_element(CONFIG_NODE
, &no_config_log_stdout_cmd
);
2922 install_element(CONFIG_NODE
, &config_log_monitor_cmd
);
2923 install_element(CONFIG_NODE
, &no_config_log_monitor_cmd
);
2924 install_element(CONFIG_NODE
, &config_log_file_cmd
);
2925 install_element(CONFIG_NODE
, &no_config_log_file_cmd
);
2926 install_element(CONFIG_NODE
, &config_log_syslog_cmd
);
2927 install_element(CONFIG_NODE
, &no_config_log_syslog_cmd
);
2928 install_element(CONFIG_NODE
, &config_log_facility_cmd
);
2929 install_element(CONFIG_NODE
, &no_config_log_facility_cmd
);
2930 install_element(CONFIG_NODE
, &config_log_record_priority_cmd
);
2931 install_element(CONFIG_NODE
,
2932 &no_config_log_record_priority_cmd
);
2933 install_element(CONFIG_NODE
,
2934 &config_log_timestamp_precision_cmd
);
2935 install_element(CONFIG_NODE
,
2936 &no_config_log_timestamp_precision_cmd
);
2937 install_element(CONFIG_NODE
, &service_password_encrypt_cmd
);
2938 install_element(CONFIG_NODE
, &no_service_password_encrypt_cmd
);
2939 install_element(CONFIG_NODE
, &banner_motd_default_cmd
);
2940 install_element(CONFIG_NODE
, &banner_motd_file_cmd
);
2941 install_element(CONFIG_NODE
, &no_banner_motd_cmd
);
2942 install_element(CONFIG_NODE
, &service_terminal_length_cmd
);
2943 install_element(CONFIG_NODE
, &no_service_terminal_length_cmd
);
2945 vrf_install_commands();
2949 grammar_sandbox_init();
2953 void cmd_terminate(void)
2955 struct cmd_node
*cmd_node
;
2957 hook_unregister(cmd_execute
, handle_pipe_action
);
2958 hook_unregister(cmd_execute_done
, handle_pipe_action_done
);
2961 for (unsigned int i
= 0; i
< vector_active(cmdvec
); i
++)
2962 if ((cmd_node
= vector_slot(cmdvec
, i
)) != NULL
) {
2963 // deleting the graph delets the cmd_element as
2965 graph_delete_graph(cmd_node
->cmdgraph
);
2966 vector_free(cmd_node
->cmd_vector
);
2967 hash_clean(cmd_node
->cmd_hash
, NULL
);
2968 hash_free(cmd_node
->cmd_hash
);
2969 cmd_node
->cmd_hash
= NULL
;
2972 vector_free(cmdvec
);
2976 XFREE(MTYPE_HOST
, host
.name
);
2977 XFREE(MTYPE_HOST
, host
.domainname
);
2978 XFREE(MTYPE_HOST
, host
.password
);
2979 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2980 XFREE(MTYPE_HOST
, host
.enable
);
2981 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2982 XFREE(MTYPE_HOST
, host
.logfile
);
2983 XFREE(MTYPE_HOST
, host
.motdfile
);
2984 XFREE(MTYPE_HOST
, host
.config
);
2986 list_delete(&varhandlers
);