]>
git.proxmox.com Git - mirror_frr.git/blob - lib/command.h
2 * Zebra configuration command interface routine
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published
9 * by the Free Software Foundation; either version 2, or (at your
10 * option) any later version.
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef _ZEBRA_COMMAND_H
23 #define _ZEBRA_COMMAND_H
27 #include "lib/route_types.h"
31 #include "command_graph.h"
37 DECLARE_MTYPE ( COMPLETION
);
40 * From RFC 1123 (Requirements for Internet Hosts), Section 2.1 on hostnames:
41 * One aspect of host name syntax is hereby changed: the restriction on
42 * the first character is relaxed to allow either a letter or a digit.
43 * Host software MUST support this more liberal syntax.
45 * Host software MUST handle host names of up to 63 characters and
46 * SHOULD handle host names of up to 255 characters.
48 #define HOSTNAME_LEN 255
50 /* Host configuration variable */
52 /* Host name of this router. */
55 /* Domainname of this router */
58 /* Password for vty interface. */
60 char * password_encrypt
;
66 /* System wide terminal lines. */
69 /* config file name of this host */
73 /* Flags for services */
77 /* Banner configuration. */
82 /* List of CLI nodes. Please remember to update the name array in command.c. */
84 AUTH_NODE
, /* Authentication mode of vty interface. */
85 VIEW_NODE
, /* View node. Default mode of vty interface. */
86 AUTH_ENABLE_NODE
, /* Authentication mode for change enable. */
87 ENABLE_NODE
, /* Enable node. */
88 CONFIG_NODE
, /* Config node. Default mode of config file. */
89 DEBUG_NODE
, /* Debug node. */
90 VRF_DEBUG_NODE
, /* Vrf Debug node. */
91 NORTHBOUND_DEBUG_NODE
, /* Northbound Debug node. */
92 DEBUG_VNC_NODE
, /* Debug VNC node. */
93 RMAP_DEBUG_NODE
, /* Route-map debug node */
94 RESOLVER_DEBUG_NODE
, /* Resolver debug node */
95 AAA_NODE
, /* AAA node. */
96 KEYCHAIN_NODE
, /* Key-chain node. */
97 KEYCHAIN_KEY_NODE
, /* Key-chain key node. */
98 IP_NODE
, /* Static ip route node. */
99 VRF_NODE
, /* VRF mode node. */
100 INTERFACE_NODE
, /* Interface mode node. */
101 NH_GROUP_NODE
, /* Nexthop-Group mode node. */
102 ZEBRA_NODE
, /* zebra connection node. */
103 TABLE_NODE
, /* rtm_table selection node. */
104 RIP_NODE
, /* RIP protocol mode node. */
105 RIPNG_NODE
, /* RIPng protocol mode node. */
106 BABEL_NODE
, /* BABEL protocol mode node. */
107 EIGRP_NODE
, /* EIGRP protocol mode node. */
108 BGP_NODE
, /* BGP protocol mode which includes BGP4+ */
109 BGP_VPNV4_NODE
, /* BGP MPLS-VPN PE exchange. */
110 BGP_VPNV6_NODE
, /* BGP MPLS-VPN PE exchange. */
111 BGP_IPV4_NODE
, /* BGP IPv4 unicast address family. */
112 BGP_IPV4M_NODE
, /* BGP IPv4 multicast address family. */
113 BGP_IPV4L_NODE
, /* BGP IPv4 labeled unicast address family. */
114 BGP_IPV6_NODE
, /* BGP IPv6 address family */
115 BGP_IPV6M_NODE
, /* BGP IPv6 multicast address family. */
116 BGP_IPV6L_NODE
, /* BGP IPv6 labeled unicast address family. */
117 BGP_VRF_POLICY_NODE
, /* BGP VRF policy */
118 BGP_VNC_DEFAULTS_NODE
, /* BGP VNC nve defaults */
119 BGP_VNC_NVE_GROUP_NODE
, /* BGP VNC nve group */
120 BGP_VNC_L2_GROUP_NODE
, /* BGP VNC L2 group */
121 RFP_DEFAULTS_NODE
, /* RFP defaults node */
122 BGP_EVPN_NODE
, /* BGP EVPN node. */
123 BGP_SRV6_NODE
, /* BGP SRv6 node. */
124 OSPF_NODE
, /* OSPF protocol mode */
125 OSPF6_NODE
, /* OSPF protocol for IPv6 mode */
126 LDP_NODE
, /* LDP protocol mode */
127 LDP_IPV4_NODE
, /* LDP IPv4 address family */
128 LDP_IPV6_NODE
, /* LDP IPv6 address family */
129 LDP_IPV4_IFACE_NODE
, /* LDP IPv4 Interface */
130 LDP_IPV6_IFACE_NODE
, /* LDP IPv6 Interface */
131 LDP_L2VPN_NODE
, /* LDP L2VPN node */
132 LDP_PSEUDOWIRE_NODE
, /* LDP Pseudowire node */
133 ISIS_NODE
, /* ISIS protocol mode */
134 ACCESS_NODE
, /* Access list node. */
135 PREFIX_NODE
, /* Prefix list node. */
136 ACCESS_IPV6_NODE
, /* Access list node. */
137 ACCESS_MAC_NODE
, /* MAC access list node*/
138 PREFIX_IPV6_NODE
, /* Prefix list node. */
139 AS_LIST_NODE
, /* AS list node. */
140 COMMUNITY_LIST_NODE
, /* Community list node. */
141 COMMUNITY_ALIAS_NODE
, /* Community alias node. */
142 RMAP_NODE
, /* Route map node. */
143 PBRMAP_NODE
, /* PBR map node. */
144 SMUX_NODE
, /* SNMP configuration node. */
145 DUMP_NODE
, /* Packet dump node. */
146 FORWARDING_NODE
, /* IP forwarding node. */
147 PROTOCOL_NODE
, /* protocol filtering node */
148 MPLS_NODE
, /* MPLS config node */
149 PW_NODE
, /* Pseudowire config node */
150 SEGMENT_ROUTING_NODE
, /* Segment routing root node */
151 SR_TRAFFIC_ENG_NODE
, /* SR Traffic Engineering node */
152 SR_SEGMENT_LIST_NODE
, /* SR segment list config node */
153 SR_POLICY_NODE
, /* SR policy config node */
154 SR_CANDIDATE_DYN_NODE
, /* SR dynamic candidate path config node */
155 PCEP_NODE
, /* PCEP node */
156 PCEP_PCE_CONFIG_NODE
, /* PCE shared configuration node */
157 PCEP_PCE_NODE
, /* PCE configuration node */
158 PCEP_PCC_NODE
, /* PCC configuration node */
159 SRV6_NODE
, /* SRv6 node */
160 SRV6_LOCS_NODE
, /* SRv6 locators node */
161 SRV6_LOC_NODE
, /* SRv6 locator node */
162 VTY_NODE
, /* Vty node. */
163 FPM_NODE
, /* Dataplane FPM node. */
164 LINK_PARAMS_NODE
, /* Link-parameters node */
165 BGP_EVPN_VNI_NODE
, /* BGP EVPN VNI */
166 RPKI_NODE
, /* RPKI node for configuration of RPKI cache server
168 BGP_FLOWSPECV4_NODE
, /* BGP IPv4 FLOWSPEC Address-Family */
169 BGP_FLOWSPECV6_NODE
, /* BGP IPv6 FLOWSPEC Address-Family */
170 BFD_NODE
, /* BFD protocol mode. */
171 BFD_PEER_NODE
, /* BFD peer configuration mode. */
172 BFD_PROFILE_NODE
, /* BFD profile configuration mode. */
173 OPENFABRIC_NODE
, /* OpenFabric router configuration node */
174 VRRP_NODE
, /* VRRP node */
175 BMP_NODE
, /* BMP config under router bgp */
176 NODE_TYPE_MAX
, /* maximum */
179 extern vector cmdvec
;
180 extern const struct message tokennames
[];
182 /* for external users depending on struct layout */
183 #define FRR_CMD_NODE_20200416
185 /* Node which has some commands and prompt string and configuration
186 function pointer . */
192 enum node_type parent_node
;
194 /* Prompt character at vty interface. */
197 /* Node's configuration write function */
198 int (* config_write
)( struct vty
*);
200 /* called when leaving the node on a VTY session.
201 * return 1 if normal exit processing should happen, 0 to suppress
203 int (* node_exit
)( struct vty
*);
205 /* Node's command graph */
206 struct graph
* cmdgraph
;
208 /* Vector of this node's command list. */
211 /* Hashed index of command node list, for de-dupping primarily */
212 struct hash
* cmd_hash
;
214 /* set as soon as any command is in cmdgraph */
218 /* Return value of the commands. */
219 #define CMD_SUCCESS 0
220 #define CMD_WARNING 1
221 #define CMD_ERR_NO_MATCH 2
222 #define CMD_ERR_AMBIGUOUS 3
223 #define CMD_ERR_INCOMPLETE 4
224 #define CMD_ERR_EXEED_ARGC_MAX 5
225 #define CMD_ERR_NOTHING_TODO 6
226 #define CMD_COMPLETE_FULL_MATCH 7
227 #define CMD_COMPLETE_MATCH 8
228 #define CMD_COMPLETE_LIST_MATCH 9
229 #define CMD_SUCCESS_DAEMON 10
230 #define CMD_ERR_NO_FILE 11
231 #define CMD_SUSPEND 12
232 #define CMD_WARNING_CONFIG_FAILED 13
233 #define CMD_NOT_MY_INSTANCE 14
234 #define CMD_NO_LEVEL_UP 15
235 #define CMD_ERR_NO_DAEMON 16
237 /* Argc max counts. */
238 #define CMD_ARGC_MAX 256
240 /* Turn off these macros when using cpp with extract.pl */
241 #ifndef VTYSH_EXTRACT_PL
243 /* helper defines for end-user DEFUN* macros */
244 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
245 static const struct cmd_element cmdname = { \
252 .xref = XREF_INIT(XREFT_DEFUN, NULL, #funcname), \
254 XREF_LINK(cmdname.xref); \
258 #define DEFUN_CMD_FUNC_DECL(funcname) \
259 static int funcname(const struct cmd_element *, struct vty *, int, \
260 struct cmd_token *[]);
262 #define DEFUN_CMD_FUNC_TEXT(funcname) \
263 static int funcname(const struct cmd_element *self \
264 __attribute__((unused)), \
265 struct vty *vty __attribute__((unused)), \
266 int argc __attribute__((unused)), \
267 struct cmd_token *argv[] __attribute__((unused)))
269 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
270 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
273 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
274 DEFPY(funcname, cmdname, cmdstr, helpstr)
276 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
277 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
280 #define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
281 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
283 #define DEFPY_YANG(funcname, cmdname, cmdstr, helpstr) \
284 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
286 #define DEFPY_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
287 DEFPY_YANG(funcname, cmdname, cmdstr, helpstr)
289 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
290 DEFUN_CMD_FUNC_DECL(funcname) \
291 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
292 DEFUN_CMD_FUNC_TEXT(funcname)
294 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
295 DEFUN_CMD_FUNC_DECL(funcname) \
296 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
297 DEFUN_CMD_FUNC_TEXT(funcname)
299 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
300 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
302 #define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr) \
303 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
305 /* DEFUN_NOSH for commands that vtysh should ignore */
306 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
307 DEFUN(funcname, cmdname, cmdstr, helpstr)
309 #define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
310 DEFUN_YANG(funcname, cmdname, cmdstr, helpstr)
312 /* DEFSH for vtysh. */
313 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
314 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
316 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
317 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
320 #define DEFSH_YANG(daemon, cmdname, cmdstr, helpstr) \
321 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, daemon)
324 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
325 DEFUN_CMD_FUNC_DECL(funcname) \
326 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
327 DEFUN_CMD_FUNC_TEXT(funcname)
329 /* DEFUN + DEFSH with attributes */
330 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
331 DEFUN_CMD_FUNC_DECL(funcname) \
332 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
333 DEFUN_CMD_FUNC_TEXT(funcname)
335 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
336 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
339 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
340 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
343 #define DEFUNSH_YANG(daemon, funcname, cmdname, cmdstr, helpstr) \
344 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
346 /* ALIAS macro which define existing command's alias. */
347 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
348 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
350 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
351 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
353 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
354 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
357 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
358 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
359 CMD_ATTR_DEPRECATED, 0)
361 #define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr) \
362 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, 0)
364 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
365 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
367 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
368 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
371 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
372 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
373 CMD_ATTR_DEPRECATED, daemon)
375 #endif /* VTYSH_EXTRACT_PL */
380 * Sometimes #defines create maximum values that
381 * need to have strings created from them that
382 * allow the parser to match against them.
383 * These macros allow that.
385 #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
386 #define CMD_CREATE_STR_HELPER(s) #s
387 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
389 /* Common descriptions. */
390 #define SHOW_STR "Show running system information \n "
391 #define IP_STR "IP information \n "
392 #define IPV6_STR "IPv6 information \n "
393 #define SRTE_STR "SR-TE information \n "
394 #define SRTE_COLOR_STR "SR-TE Color information \n "
395 #define NO_STR "Negate a command or set its defaults \n "
396 #define IGNORED_IN_NO_STR "Ignored value in no form \n "
397 #define REDIST_STR "Redistribute information from another routing protocol \n "
398 #define CLEAR_STR "Reset functions \n "
399 #define RIP_STR "RIP information \n "
400 #define EIGRP_STR "EIGRP information \n "
401 #define BGP_STR "BGP information \n "
402 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates \n "
403 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound' \n "
404 #define BGP_SOFT_OUT_STR "Resend all outbound updates \n "
405 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB \n "
406 #define OSPF_STR "OSPF information \n "
407 #define NEIGHBOR_STR "Specify neighbor router \n "
408 #define DEBUG_STR "Debugging functions \n "
409 #define UNDEBUG_STR "Disable debugging functions (see also 'debug') \n "
410 #define ROUTER_STR "Enable a routing process \n "
411 #define AS_STR "AS number \n "
412 #define MAC_STR "MAC address \n "
413 #define MBGP_STR "MBGP information \n "
414 #define MATCH_STR "Match values from routing table \n "
415 #define SET_STR "Set values in destination routing protocol \n "
416 #define OUT_STR "Filter outgoing routing updates \n "
417 #define IN_STR "Filter incoming routing updates \n "
418 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0) \n "
419 #define OSPF6_NUMBER_STR "Specify by number \n "
420 #define INTERFACE_STR "Interface information \n "
421 #define IFNAME_STR "Interface name(e.g. ep0) \n "
422 #define IP6_STR "IPv6 Information \n "
423 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6 \n "
424 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID \n "
425 #define SECONDS_STR "Seconds \n "
426 #define ROUTE_STR "Routing Table \n "
427 #define PREFIX_LIST_STR "Build a prefix list \n "
428 #define OSPF6_DUMP_TYPE_LIST \
429 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
430 #define AREA_TAG_STR "[area tag] \n "
431 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535) \n "
432 #define COMMUNITY_VAL_STR \
433 "Community number in AA:NN format (where AA and NN are (0-65535)) or local-AS|no-advertise|no-export|internet|graceful-shutdown|accept-own-nexthop|accept-own|route-filter-translated-v4|route-filter-v4|route-filter-translated-v6|route-filter-v6|llgr-stale|no-llgr|blackhole|no-peer or additive \n "
434 #define MPLS_TE_STR "MPLS-TE specific commands \n "
435 #define LINK_PARAMS_STR "Configure interface link parameters \n "
436 #define OSPF_RI_STR "OSPF Router Information specific commands \n "
437 #define PCE_STR "PCE Router Information specific commands \n "
438 #define MPLS_STR "MPLS information \n "
439 #define SR_STR "Segment-Routing specific commands \n "
440 #define WATCHFRR_STR "watchfrr information \n "
441 #define ZEBRA_STR "Zebra information \n "
442 #define FILTER_LOG_STR "Filter Logs \n "
443 #define BFD_PROFILE_STR "BFD profile. \n "
444 #define BFD_PROFILE_NAME_STR "BFD profile name. \n "
445 #define SHARP_STR "Sharp Routing Protocol \n "
446 #define OSPF_GR_STR \
447 "OSPF non-stop forwarding (NSF) also known as OSPF Graceful Restart \n "
449 #define CMD_VNI_RANGE "(1-16777215)"
450 #define CONF_BACKUP_EXT ".sav"
451 #define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC \n "
452 #define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC \n "
453 #define MPLS_LDP_SYNC_HOLDDOWN_STR \
454 "Time to wait for LDP-SYNC to occur before restoring if cost \n "
455 #define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable \n "
457 /* Command warnings. */
458 #define NO_PASSWD_CMD_WARNING \
459 "Please be aware that removing the password is a security risk and you should think twice about this command. \n "
461 /* IPv4 only machine should not accept IPv6 address for peer's IP
462 address. So we replace VTY command string like below. */
463 #define NEIGHBOR_ADDR_STR "Neighbor address \n IPv6 address \n "
464 #define NEIGHBOR_ADDR_STR2 "Neighbor address \n Neighbor IPv6 address \n Interface name or neighbor tag \n "
465 #define NEIGHBOR_ADDR_STR3 "Neighbor address \n IPv6 address \n Interface name \n "
467 /* Graceful Restart cli help strings */
468 #define GR_CMD "Global Graceful Restart command \n "
469 #define NO_GR_CMD "Undo Global Graceful Restart command \n "
470 #define GR "Global Graceful Restart - GR Mode \n "
471 #define GR_DISABLE "Global Graceful Restart - Disable Mode \n "
472 #define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode \n "
473 #define GR_DEBUG "Graceful Restart - Enable Debug Logs \n "
474 #define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode \n "
475 #define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor \n "
476 #define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor \n "
477 #define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor \n "
478 #define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor \n "
479 #define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor \n "
480 #define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor \n "
482 /* EVPN help Strings */
483 #define EVPN_RT_HELP_STR "EVPN route information \n "
484 #define EVPN_RT_DIST_HELP_STR "Route Distinguisher \n "
485 #define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX \n "
486 #define EVPN_TYPE_HELP_STR "Specify Route type \n "
487 #define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route \n "
488 #define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route \n "
489 #define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route \n "
490 #define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route \n "
491 #define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route \n "
492 #define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
493 #define EVPN_TYPE_ALL_LIST_HELP_STR \
494 EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR \
495 EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR \
496 EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR \
497 EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR \
498 EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
502 extern void install_node ( struct cmd_node
* node
);
503 extern void install_default ( enum node_type
);
505 struct xref_install_element
{
508 const struct cmd_element
* cmd_element
;
509 enum node_type node_type
;
512 #ifndef VTYSH_EXTRACT_PL
513 #define install_element(node_type_, cmd_element_) do { \
514 static const struct xref_install_element _xref \
515 __attribute__((used)) = { \
516 .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL, \
518 .cmd_element = cmd_element_, \
519 .node_type = node_type_, \
521 XREF_LINK(_xref.xref); \
522 _install_element(node_type_, cmd_element_); \
526 extern void _install_element ( enum node_type
, const struct cmd_element
*);
528 /* known issue with uninstall_element: changes to cmd_token->attr (i.e.
529 * deprecated/hidden) are not reversed. */
530 extern void uninstall_element ( enum node_type
, const struct cmd_element
*);
532 /* construct CLI tree only when entering nodes */
533 extern void cmd_defer_tree ( bool val
);
535 /* finish CLI tree for node when above is true (noop otherwise) */
536 extern void cmd_finalize_node ( struct cmd_node
* node
);
538 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
539 string with a space between each element (allocated using
540 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
541 extern char * argv_concat ( struct cmd_token
** argv
, int argc
, int shift
);
544 * It is preferred that you set the index initial value
545 * to a 0. This way in the future if you modify the
546 * cli then there is no need to modify the initial
549 extern int argv_find ( struct cmd_token
** argv
, int argc
, const char * text
,
552 extern vector
cmd_make_strvec ( const char *);
553 extern void cmd_free_strvec ( vector
);
554 extern vector
cmd_describe_command ( vector
, struct vty
*, int * status
);
555 extern char ** cmd_complete_command ( vector
, struct vty
*, int * status
);
556 extern const char * cmd_prompt ( enum node_type
);
557 extern int command_config_read_one_line ( struct vty
* vty
,
558 const struct cmd_element
**,
559 uint32_t line_num
, int use_config_node
);
560 extern int config_from_file ( struct vty
*, FILE *, unsigned int * line_num
);
561 extern enum node_type
node_parent ( enum node_type
);
563 * Execute command under the given vty context.
566 * The vty context to execute under.
569 * The command string to execute.
572 * If non-null and a match was found, the address of the matched command is
573 * stored here. No action otherwise.
576 * Whether or not this is being called from vtysh. If this is nonzero,
580 * XXX: what does it return
582 extern int cmd_execute ( struct vty
* vty
, const char * cmd
,
583 const struct cmd_element
** matched
, int vtysh
);
584 extern int cmd_execute_command ( vector
, struct vty
*,
585 const struct cmd_element
**, int );
586 extern int cmd_execute_command_strict ( vector
, struct vty
*,
587 const struct cmd_element
**);
588 extern void cmd_init ( int terminal
);
589 extern void cmd_init_config_callbacks ( void (* start_config_cb
)( void ),
590 void (* end_config_cb
)( void ));
591 extern void cmd_terminate ( void );
592 extern void cmd_exit ( struct vty
* vty
);
593 extern int cmd_list_cmds ( struct vty
* vty
, int do_permute
);
594 extern int cmd_find_cmds ( struct vty
* vty
, struct cmd_token
** argv
, int argc
);
596 extern int cmd_domainname_set ( const char * domainname
);
597 extern int cmd_hostname_set ( const char * hostname
);
598 extern const char * cmd_hostname_get ( void );
599 extern const char * cmd_domainname_get ( void );
601 /* NOT safe for general use; call this only if DEV_BUILD! */
602 extern void grammar_sandbox_init ( void );
604 extern vector
completions_to_vec ( struct list
* completions
);
606 /* Export typical functions. */
607 extern const char * host_config_get ( void );
608 extern void host_config_set ( const char *);
610 extern void print_version ( const char *);
612 extern int cmd_banner_motd_file ( const char *);
613 extern void cmd_banner_motd_line ( const char * line
);
615 /* struct host global, ick */
616 extern struct host host
;
618 struct cmd_variable_handler
{
619 const char * tokenname
, * varname
;
620 void (* completions
)( vector out
, struct cmd_token
* token
);
623 extern void cmd_variable_complete ( struct cmd_token
* token
, const char * arg
,
626 cmd_variable_handler_register ( const struct cmd_variable_handler
* cvh
);
627 extern char * cmd_variable_comp2str ( vector comps
, unsigned short cols
);
629 extern void command_setup_early_logging ( const char * dest
, const char * level
);
635 #endif /* _ZEBRA_COMMAND_H */