]>
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 */
217 /* don't decrement vty->xpath_index on leaving this node */
221 /* Return value of the commands. */
222 #define CMD_SUCCESS 0
223 #define CMD_WARNING 1
224 #define CMD_ERR_NO_MATCH 2
225 #define CMD_ERR_AMBIGUOUS 3
226 #define CMD_ERR_INCOMPLETE 4
227 #define CMD_ERR_EXEED_ARGC_MAX 5
228 #define CMD_ERR_NOTHING_TODO 6
229 #define CMD_COMPLETE_FULL_MATCH 7
230 #define CMD_COMPLETE_MATCH 8
231 #define CMD_COMPLETE_LIST_MATCH 9
232 #define CMD_SUCCESS_DAEMON 10
233 #define CMD_ERR_NO_FILE 11
234 #define CMD_SUSPEND 12
235 #define CMD_WARNING_CONFIG_FAILED 13
236 #define CMD_NOT_MY_INSTANCE 14
237 #define CMD_NO_LEVEL_UP 15
238 #define CMD_ERR_NO_DAEMON 16
240 /* Argc max counts. */
241 #define CMD_ARGC_MAX 256
243 /* Turn off these macros when using cpp with extract.pl */
244 #ifndef VTYSH_EXTRACT_PL
246 /* helper defines for end-user DEFUN* macros */
247 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
248 static const struct cmd_element cmdname = { \
255 .xref = XREF_INIT(XREFT_DEFUN, NULL, #funcname), \
257 XREF_LINK(cmdname.xref); \
261 #define DEFUN_CMD_FUNC_DECL(funcname) \
262 static int funcname(const struct cmd_element *, struct vty *, int, \
263 struct cmd_token *[]);
265 #define DEFUN_CMD_FUNC_TEXT(funcname) \
266 static int funcname(const struct cmd_element *self \
267 __attribute__((unused)), \
268 struct vty *vty __attribute__((unused)), \
269 int argc __attribute__((unused)), \
270 struct cmd_token *argv[] __attribute__((unused)))
272 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
273 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
276 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
277 DEFPY(funcname, cmdname, cmdstr, helpstr)
279 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
280 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
283 #define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
284 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
286 #define DEFPY_YANG(funcname, cmdname, cmdstr, helpstr) \
287 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
289 #define DEFPY_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
290 DEFPY_YANG(funcname, cmdname, cmdstr, helpstr)
292 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
293 DEFUN_CMD_FUNC_DECL(funcname) \
294 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
295 DEFUN_CMD_FUNC_TEXT(funcname)
297 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
298 DEFUN_CMD_FUNC_DECL(funcname) \
299 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
300 DEFUN_CMD_FUNC_TEXT(funcname)
302 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
303 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
305 #define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr) \
306 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
308 /* DEFUN_NOSH for commands that vtysh should ignore */
309 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
310 DEFUN(funcname, cmdname, cmdstr, helpstr)
312 #define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
313 DEFUN_YANG(funcname, cmdname, cmdstr, helpstr)
315 /* DEFSH for vtysh. */
316 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
317 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
319 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
320 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
323 #define DEFSH_YANG(daemon, cmdname, cmdstr, helpstr) \
324 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, daemon)
327 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
328 DEFUN_CMD_FUNC_DECL(funcname) \
329 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
330 DEFUN_CMD_FUNC_TEXT(funcname)
332 /* DEFUN + DEFSH with attributes */
333 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
334 DEFUN_CMD_FUNC_DECL(funcname) \
335 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
336 DEFUN_CMD_FUNC_TEXT(funcname)
338 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
339 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
342 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
343 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
346 #define DEFUNSH_YANG(daemon, funcname, cmdname, cmdstr, helpstr) \
347 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
349 /* ALIAS macro which define existing command's alias. */
350 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
351 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
353 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
354 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
356 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
357 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
360 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
361 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
362 CMD_ATTR_DEPRECATED, 0)
364 #define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr) \
365 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, 0)
367 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
368 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
370 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
371 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
374 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
375 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
376 CMD_ATTR_DEPRECATED, daemon)
378 #endif /* VTYSH_EXTRACT_PL */
383 * Sometimes #defines create maximum values that
384 * need to have strings created from them that
385 * allow the parser to match against them.
386 * These macros allow that.
388 #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
389 #define CMD_CREATE_STR_HELPER(s) #s
390 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
392 /* Common descriptions. */
393 #define SHOW_STR "Show running system information \n "
394 #define IP_STR "IP information \n "
395 #define IPV6_STR "IPv6 information \n "
396 #define SRTE_STR "SR-TE information \n "
397 #define SRTE_COLOR_STR "SR-TE Color information \n "
398 #define NO_STR "Negate a command or set its defaults \n "
399 #define IGNORED_IN_NO_STR "Ignored value in no form \n "
400 #define REDIST_STR "Redistribute information from another routing protocol \n "
401 #define CLEAR_STR "Reset functions \n "
402 #define RIP_STR "RIP information \n "
403 #define EIGRP_STR "EIGRP information \n "
404 #define BGP_STR "BGP information \n "
405 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates \n "
406 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound' \n "
407 #define BGP_SOFT_OUT_STR "Resend all outbound updates \n "
408 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB \n "
409 #define OSPF_STR "OSPF information \n "
410 #define NEIGHBOR_STR "Specify neighbor router \n "
411 #define DEBUG_STR "Debugging functions \n "
412 #define UNDEBUG_STR "Disable debugging functions (see also 'debug') \n "
413 #define ROUTER_STR "Enable a routing process \n "
414 #define AS_STR "AS number \n "
415 #define MAC_STR "MAC address \n "
416 #define MBGP_STR "MBGP information \n "
417 #define MATCH_STR "Match values from routing table \n "
418 #define SET_STR "Set values in destination routing protocol \n "
419 #define OUT_STR "Filter outgoing routing updates \n "
420 #define IN_STR "Filter incoming routing updates \n "
421 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0) \n "
422 #define OSPF6_NUMBER_STR "Specify by number \n "
423 #define INTERFACE_STR "Interface information \n "
424 #define IFNAME_STR "Interface name(e.g. ep0) \n "
425 #define IP6_STR "IPv6 Information \n "
426 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6 \n "
427 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID \n "
428 #define SECONDS_STR "Seconds \n "
429 #define ROUTE_STR "Routing Table \n "
430 #define PREFIX_LIST_STR "Build a prefix list \n "
431 #define OSPF6_DUMP_TYPE_LIST \
432 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
433 #define AREA_TAG_STR "[area tag] \n "
434 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535) \n "
435 #define COMMUNITY_VAL_STR \
436 "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 "
437 #define MPLS_TE_STR "MPLS-TE specific commands \n "
438 #define LINK_PARAMS_STR "Configure interface link parameters \n "
439 #define OSPF_RI_STR "OSPF Router Information specific commands \n "
440 #define PCE_STR "PCE Router Information specific commands \n "
441 #define MPLS_STR "MPLS information \n "
442 #define SR_STR "Segment-Routing specific commands \n "
443 #define WATCHFRR_STR "watchfrr information \n "
444 #define ZEBRA_STR "Zebra information \n "
445 #define FILTER_LOG_STR "Filter Logs \n "
446 #define BFD_PROFILE_STR "BFD profile. \n "
447 #define BFD_PROFILE_NAME_STR "BFD profile name. \n "
448 #define SHARP_STR "Sharp Routing Protocol \n "
449 #define OSPF_GR_STR \
450 "OSPF non-stop forwarding (NSF) also known as OSPF Graceful Restart \n "
452 #define CMD_VNI_RANGE "(1-16777215)"
453 #define CONF_BACKUP_EXT ".sav"
454 #define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC \n "
455 #define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC \n "
456 #define MPLS_LDP_SYNC_HOLDDOWN_STR \
457 "Time to wait for LDP-SYNC to occur before restoring if cost \n "
458 #define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable \n "
460 /* Command warnings. */
461 #define NO_PASSWD_CMD_WARNING \
462 "Please be aware that removing the password is a security risk and you should think twice about this command. \n "
464 /* IPv4 only machine should not accept IPv6 address for peer's IP
465 address. So we replace VTY command string like below. */
466 #define NEIGHBOR_ADDR_STR "Neighbor address \n IPv6 address \n "
467 #define NEIGHBOR_ADDR_STR2 "Neighbor address \n Neighbor IPv6 address \n Interface name or neighbor tag \n "
468 #define NEIGHBOR_ADDR_STR3 "Neighbor address \n IPv6 address \n Interface name \n "
470 /* Graceful Restart cli help strings */
471 #define GR_CMD "Global Graceful Restart command \n "
472 #define NO_GR_CMD "Undo Global Graceful Restart command \n "
473 #define GR "Global Graceful Restart - GR Mode \n "
474 #define GR_DISABLE "Global Graceful Restart - Disable Mode \n "
475 #define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode \n "
476 #define GR_DEBUG "Graceful Restart - Enable Debug Logs \n "
477 #define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode \n "
478 #define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor \n "
479 #define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor \n "
480 #define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor \n "
481 #define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor \n "
482 #define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor \n "
483 #define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor \n "
485 /* EVPN help Strings */
486 #define EVPN_RT_HELP_STR "EVPN route information \n "
487 #define EVPN_RT_DIST_HELP_STR "Route Distinguisher \n "
488 #define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX \n "
489 #define EVPN_TYPE_HELP_STR "Specify Route type \n "
490 #define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route \n "
491 #define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route \n "
492 #define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route \n "
493 #define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route \n "
494 #define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route \n "
495 #define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
496 #define EVPN_TYPE_ALL_LIST_HELP_STR \
497 EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR \
498 EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR \
499 EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR \
500 EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR \
501 EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
505 extern void install_node ( struct cmd_node
* node
);
506 extern void install_default ( enum node_type
);
508 struct xref_install_element
{
511 const struct cmd_element
* cmd_element
;
512 enum node_type node_type
;
515 #ifndef VTYSH_EXTRACT_PL
516 #define install_element(node_type_, cmd_element_) do { \
517 static const struct xref_install_element _xref \
518 __attribute__((used)) = { \
519 .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL, \
521 .cmd_element = cmd_element_, \
522 .node_type = node_type_, \
524 XREF_LINK(_xref.xref); \
525 _install_element(node_type_, cmd_element_); \
529 extern void _install_element ( enum node_type
, const struct cmd_element
*);
531 /* known issue with uninstall_element: changes to cmd_token->attr (i.e.
532 * deprecated/hidden) are not reversed. */
533 extern void uninstall_element ( enum node_type
, const struct cmd_element
*);
535 /* construct CLI tree only when entering nodes */
536 extern void cmd_defer_tree ( bool val
);
538 /* finish CLI tree for node when above is true (noop otherwise) */
539 extern void cmd_finalize_node ( struct cmd_node
* node
);
541 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
542 string with a space between each element (allocated using
543 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
544 extern char * argv_concat ( struct cmd_token
** argv
, int argc
, int shift
);
547 * It is preferred that you set the index initial value
548 * to a 0. This way in the future if you modify the
549 * cli then there is no need to modify the initial
552 extern int argv_find ( struct cmd_token
** argv
, int argc
, const char * text
,
555 extern vector
cmd_make_strvec ( const char *);
556 extern void cmd_free_strvec ( vector
);
557 extern vector
cmd_describe_command ( vector
, struct vty
*, int * status
);
558 extern char ** cmd_complete_command ( vector
, struct vty
*, int * status
);
559 extern const char * cmd_prompt ( enum node_type
);
560 extern int command_config_read_one_line ( struct vty
* vty
,
561 const struct cmd_element
**,
562 uint32_t line_num
, int use_config_node
);
563 extern int config_from_file ( struct vty
*, FILE *, unsigned int * line_num
);
564 extern enum node_type
node_parent ( enum node_type
);
566 * Execute command under the given vty context.
569 * The vty context to execute under.
572 * The command string to execute.
575 * If non-null and a match was found, the address of the matched command is
576 * stored here. No action otherwise.
579 * Whether or not this is being called from vtysh. If this is nonzero,
583 * XXX: what does it return
585 extern int cmd_execute ( struct vty
* vty
, const char * cmd
,
586 const struct cmd_element
** matched
, int vtysh
);
587 extern int cmd_execute_command ( vector
, struct vty
*,
588 const struct cmd_element
**, int );
589 extern int cmd_execute_command_strict ( vector
, struct vty
*,
590 const struct cmd_element
**);
591 extern void cmd_init ( int terminal
);
592 extern void cmd_init_config_callbacks ( void (* start_config_cb
)( void ),
593 void (* end_config_cb
)( void ));
594 extern void cmd_terminate ( void );
595 extern void cmd_exit ( struct vty
* vty
);
596 extern int cmd_list_cmds ( struct vty
* vty
, int do_permute
);
597 extern int cmd_find_cmds ( struct vty
* vty
, struct cmd_token
** argv
, int argc
);
599 extern int cmd_domainname_set ( const char * domainname
);
600 extern int cmd_hostname_set ( const char * hostname
);
601 extern const char * cmd_hostname_get ( void );
602 extern const char * cmd_domainname_get ( void );
604 /* NOT safe for general use; call this only if DEV_BUILD! */
605 extern void grammar_sandbox_init ( void );
607 extern vector
completions_to_vec ( struct list
* completions
);
609 /* Export typical functions. */
610 extern const char * host_config_get ( void );
611 extern void host_config_set ( const char *);
613 extern void print_version ( const char *);
615 extern int cmd_banner_motd_file ( const char *);
616 extern void cmd_banner_motd_line ( const char * line
);
618 /* struct host global, ick */
619 extern struct host host
;
621 struct cmd_variable_handler
{
622 const char * tokenname
, * varname
;
623 void (* completions
)( vector out
, struct cmd_token
* token
);
626 extern void cmd_variable_complete ( struct cmd_token
* token
, const char * arg
,
629 cmd_variable_handler_register ( const struct cmd_variable_handler
* cvh
);
630 extern char * cmd_variable_comp2str ( vector comps
, unsigned short cols
);
632 extern void command_setup_early_logging ( const char * dest
, const char * level
);
638 #endif /* _ZEBRA_COMMAND_H */