]>
git.proxmox.com Git - mirror_frr.git/blob - lib/command.h
1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Zebra configuration command interface routine
4 * Copyright (C) 1997, 98 Kunihiro Ishiguro
7 #ifndef _ZEBRA_COMMAND_H
8 #define _ZEBRA_COMMAND_H
12 #include "lib/route_types.h"
16 #include "command_graph.h"
22 DECLARE_MTYPE ( COMPLETION
);
25 * From RFC 1123 (Requirements for Internet Hosts), Section 2.1 on hostnames:
26 * One aspect of host name syntax is hereby changed: the restriction on
27 * the first character is relaxed to allow either a letter or a digit.
28 * Host software MUST support this more liberal syntax.
30 * Host software MUST handle host names of up to 63 characters and
31 * SHOULD handle host names of up to 255 characters.
33 #define HOSTNAME_LEN 255
35 /* Host configuration variable */
37 /* Host name of this router. */
40 /* Domainname of this router */
44 * Some extra system data that is useful
50 /* Password for vty interface. */
52 char * password_encrypt
;
58 /* System wide terminal lines. */
61 /* config file name of this host */
65 /* Flags for services */
69 /* Banner configuration. */
73 /* Allow using IPv4 (Class E) reserved IP space */
74 bool allow_reserved_ranges
;
77 /* List of CLI nodes. Please remember to update the name array in command.c. */
78 /* clang-format off */
80 AUTH_NODE
, /* Authentication mode of vty interface. */
81 VIEW_NODE
, /* View node. Default mode of vty interface. */
82 AUTH_ENABLE_NODE
, /* Authentication mode for change enable. */
83 ENABLE_NODE
, /* Enable node. */
84 CONFIG_NODE
, /* Config node. Default mode of config file. */
85 DEBUG_NODE
, /* Debug node. */
86 VRF_DEBUG_NODE
, /* Vrf Debug node. */
87 NORTHBOUND_DEBUG_NODE
, /* Northbound Debug node. */
88 DEBUG_VNC_NODE
, /* Debug VNC node. */
89 RMAP_DEBUG_NODE
, /* Route-map debug node */
90 RESOLVER_DEBUG_NODE
, /* Resolver debug node */
91 AAA_NODE
, /* AAA node. */
92 EXTLOG_NODE
, /* RFC5424 & co. extended syslog */
93 KEYCHAIN_NODE
, /* Key-chain node. */
94 KEYCHAIN_KEY_NODE
, /* Key-chain key node. */
95 AFFMAP_NODE
, /* Affinity map node. */
96 IP_NODE
, /* Static ip route node. */
97 VRF_NODE
, /* VRF mode node. */
98 INTERFACE_NODE
, /* Interface mode node. */
99 NH_GROUP_NODE
, /* Nexthop-Group mode node. */
100 ZEBRA_NODE
, /* zebra connection node. */
101 TABLE_NODE
, /* rtm_table selection node. */
102 RIP_NODE
, /* RIP protocol mode node. */
103 RIPNG_NODE
, /* RIPng protocol mode node. */
104 BABEL_NODE
, /* BABEL protocol mode node. */
105 EIGRP_NODE
, /* EIGRP protocol mode node. */
106 BGP_NODE
, /* BGP protocol mode which includes BGP4+ */
107 BGP_VPNV4_NODE
, /* BGP MPLS-VPN PE exchange. */
108 BGP_VPNV6_NODE
, /* BGP MPLS-VPN PE exchange. */
109 BGP_IPV4_NODE
, /* BGP IPv4 unicast address family. */
110 BGP_IPV4M_NODE
, /* BGP IPv4 multicast address family. */
111 BGP_IPV4L_NODE
, /* BGP IPv4 labeled unicast address family. */
112 BGP_IPV6_NODE
, /* BGP IPv6 address family */
113 BGP_IPV6M_NODE
, /* BGP IPv6 multicast address family. */
114 BGP_IPV6L_NODE
, /* BGP IPv6 labeled unicast address family. */
115 BGP_VRF_POLICY_NODE
, /* BGP VRF policy */
116 BGP_VNC_DEFAULTS_NODE
, /* BGP VNC nve defaults */
117 BGP_VNC_NVE_GROUP_NODE
, /* BGP VNC nve group */
118 BGP_VNC_L2_GROUP_NODE
, /* BGP VNC L2 group */
119 RFP_DEFAULTS_NODE
, /* RFP defaults node */
120 BGP_EVPN_NODE
, /* BGP EVPN node. */
121 BGP_SRV6_NODE
, /* BGP SRv6 node. */
122 OSPF_NODE
, /* OSPF protocol mode */
123 OSPF6_NODE
, /* OSPF protocol for IPv6 mode */
124 LDP_NODE
, /* LDP protocol mode */
125 LDP_IPV4_NODE
, /* LDP IPv4 address family */
126 LDP_IPV6_NODE
, /* LDP IPv6 address family */
127 LDP_IPV4_IFACE_NODE
, /* LDP IPv4 Interface */
128 LDP_IPV6_IFACE_NODE
, /* LDP IPv6 Interface */
129 LDP_L2VPN_NODE
, /* LDP L2VPN node */
130 LDP_PSEUDOWIRE_NODE
, /* LDP Pseudowire node */
131 ISIS_NODE
, /* ISIS protocol mode */
132 ACCESS_NODE
, /* Access list node. */
133 PREFIX_NODE
, /* Prefix list node. */
134 ACCESS_IPV6_NODE
, /* Access list node. */
135 ACCESS_MAC_NODE
, /* MAC access list node*/
136 PREFIX_IPV6_NODE
, /* Prefix list node. */
137 AS_LIST_NODE
, /* AS list node. */
138 COMMUNITY_LIST_NODE
, /* Community list node. */
139 COMMUNITY_ALIAS_NODE
, /* Community alias node. */
140 RMAP_NODE
, /* Route map node. */
141 PBRMAP_NODE
, /* PBR map node. */
142 SMUX_NODE
, /* SNMP configuration node. */
143 DUMP_NODE
, /* Packet dump node. */
144 FORWARDING_NODE
, /* IP forwarding node. */
145 PROTOCOL_NODE
, /* protocol filtering node */
146 MPLS_NODE
, /* MPLS config node */
147 PW_NODE
, /* Pseudowire config node */
148 SEGMENT_ROUTING_NODE
, /* Segment routing root node */
149 SR_TRAFFIC_ENG_NODE
, /* SR Traffic Engineering node */
150 SR_SEGMENT_LIST_NODE
, /* SR segment list config node */
151 SR_POLICY_NODE
, /* SR policy config node */
152 SR_CANDIDATE_DYN_NODE
, /* SR dynamic candidate path config node */
153 PCEP_NODE
, /* PCEP node */
154 PCEP_PCE_CONFIG_NODE
, /* PCE shared configuration node */
155 PCEP_PCE_NODE
, /* PCE configuration node */
156 PCEP_PCC_NODE
, /* PCC configuration node */
157 SRV6_NODE
, /* SRv6 node */
158 SRV6_LOCS_NODE
, /* SRv6 locators node */
159 SRV6_LOC_NODE
, /* SRv6 locator node */
160 VTY_NODE
, /* Vty node. */
161 FPM_NODE
, /* Dataplane FPM node. */
162 LINK_PARAMS_NODE
, /* Link-parameters node */
163 BGP_EVPN_VNI_NODE
, /* BGP EVPN VNI */
164 RPKI_NODE
, /* RPKI node for configuration of RPKI cache server
166 BGP_FLOWSPECV4_NODE
, /* BGP IPv4 FLOWSPEC Address-Family */
167 BGP_FLOWSPECV6_NODE
, /* BGP IPv6 FLOWSPEC Address-Family */
168 BFD_NODE
, /* BFD protocol mode. */
169 BFD_PEER_NODE
, /* BFD peer configuration mode. */
170 BFD_PROFILE_NODE
, /* BFD profile configuration mode. */
171 OPENFABRIC_NODE
, /* OpenFabric router configuration node */
172 VRRP_NODE
, /* VRRP node */
173 BMP_NODE
, /* BMP config under router bgp */
174 NODE_TYPE_MAX
, /* maximum */
176 /* clang-format on */
178 extern vector cmdvec
;
179 extern const struct message tokennames
[];
181 /* for external users depending on struct layout */
182 #define FRR_CMD_NODE_20200416
184 /* Node which has some commands and prompt string and configuration
185 function pointer . */
191 enum node_type parent_node
;
193 /* Prompt character at vty interface. */
196 /* Node's configuration write function */
197 int (* config_write
)( struct vty
*);
199 /* called when leaving the node on a VTY session.
200 * return 1 if normal exit processing should happen, 0 to suppress
202 int (* node_exit
)( struct vty
*);
204 /* Node's command graph */
205 struct graph
* cmdgraph
;
207 /* Vector of this node's command list. */
210 /* Hashed index of command node list, for de-dupping primarily */
211 struct hash
* cmd_hash
;
213 /* set as soon as any command is in cmdgraph */
216 /* don't decrement vty->xpath_index on leaving this node */
220 /* Return value of the commands. */
221 #define CMD_SUCCESS 0
222 #define CMD_WARNING 1
223 #define CMD_ERR_NO_MATCH 2
224 #define CMD_ERR_AMBIGUOUS 3
225 #define CMD_ERR_INCOMPLETE 4
226 #define CMD_ERR_EXEED_ARGC_MAX 5
227 #define CMD_ERR_NOTHING_TODO 6
228 #define CMD_COMPLETE_FULL_MATCH 7
229 #define CMD_COMPLETE_MATCH 8
230 #define CMD_COMPLETE_LIST_MATCH 9
231 #define CMD_SUCCESS_DAEMON 10
232 #define CMD_ERR_NO_FILE 11
233 #define CMD_SUSPEND 12
234 #define CMD_WARNING_CONFIG_FAILED 13
235 #define CMD_NOT_MY_INSTANCE 14
236 #define CMD_NO_LEVEL_UP 15
237 #define CMD_ERR_NO_DAEMON 16
239 /* Argc max counts. */
240 #define CMD_ARGC_MAX 256
242 /* helper defines for end-user DEFUN* macros */
243 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
244 static const struct cmd_element cmdname = { \
251 .xref = XREF_INIT(XREFT_DEFUN, NULL, #funcname), \
253 XREF_LINK(cmdname.xref); \
257 #define DEFUN_CMD_FUNC_DECL(funcname) \
258 static int funcname(const struct cmd_element *, struct vty *, int, \
259 struct cmd_token *[]);
261 #define DEFUN_CMD_FUNC_TEXT(funcname) \
262 static int funcname(const struct cmd_element *self \
263 __attribute__((unused)), \
264 struct vty *vty __attribute__((unused)), \
265 int argc __attribute__((unused)), \
266 struct cmd_token *argv[] __attribute__((unused)))
270 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
271 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
274 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
275 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, 0)
277 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
278 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_NOSH)
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_ATTR(funcname, cmdname, cmdstr, helpstr, \
288 CMD_ATTR_YANG | CMD_ATTR_NOSH)
292 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
293 DEFUN_CMD_FUNC_DECL(funcname) \
294 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
295 DEFUN_CMD_FUNC_TEXT(funcname)
297 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
298 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, 0)
300 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
301 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
303 #define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr) \
304 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
306 /* DEFUN_NOSH for commands that vtysh should ignore */
307 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
308 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_NOSH)
310 #define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
311 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, \
312 CMD_ATTR_YANG | CMD_ATTR_NOSH)
314 /* DEFSH for vtysh. */
315 #define DEFSH_ATTR(daemon, cmdname, cmdstr, helpstr, attr) \
316 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, attr, daemon)
318 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
319 DEFSH_ATTR(daemon, cmdname, cmdstr, helpstr, 0)
321 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
322 DEFSH_ATTR(daemon, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
325 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
326 DEFUN_CMD_FUNC_DECL(funcname) \
327 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
328 DEFUN_CMD_FUNC_TEXT(funcname)
330 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
331 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, 0)
333 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
334 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
337 /* ALIAS macro which define existing command's alias. */
338 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
339 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
341 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
342 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, 0)
344 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
345 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
347 /* note: DEPRECATED implies HIDDEN, and other than that there is currently no
348 * difference. It's purely for expressing intent in the source code - a
349 * DEPRECATED command is supposed to go away, a HIDDEN one is likely to stay.
351 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
352 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, \
353 CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN)
355 #define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr) \
356 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
361 * Sometimes #defines create maximum values that
362 * need to have strings created from them that
363 * allow the parser to match against them.
364 * These macros allow that.
366 #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
367 #define CMD_CREATE_STR_HELPER(s) #s
368 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
370 /* Common descriptions. */
371 #define SHOW_STR "Show running system information \n "
372 #define IP_STR "IP information \n "
373 #define IPV6_STR "IPv6 information \n "
374 #define IP_ADDR_STR "IPv4 Address \n "
375 #define IP6_ADDR_STR "IPv6 Address \n "
376 #define SRTE_STR "SR-TE information \n "
377 #define SRTE_COLOR_STR "SR-TE Color information \n "
378 #define NO_STR "Negate a command or set its defaults \n "
379 #define IGNORED_IN_NO_STR "Ignored value in no form \n "
380 #define REDIST_STR "Redistribute information from another routing protocol \n "
381 #define CLEAR_STR "Reset functions \n "
382 #define RIP_STR "RIP information \n "
383 #define EIGRP_STR "EIGRP information \n "
384 #define BGP_STR "BGP information \n "
385 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates \n "
386 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound' \n "
387 #define BGP_SOFT_OUT_STR "Resend all outbound updates \n "
388 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB \n "
389 #define OSPF_STR "OSPF information \n "
390 #define NEIGHBOR_STR "Specify neighbor router \n "
391 #define DEBUG_STR "Debugging functions \n "
392 #define UNDEBUG_STR "Disable debugging functions (see also 'debug') \n "
393 #define ROUTER_STR "Enable a routing process \n "
395 "AS number in plain <1-4294967295> or dotted <0-65535>.<0-65535> format \n "
396 #define MAC_STR "MAC address \n "
397 #define MBGP_STR "MBGP information \n "
398 #define MATCH_STR "Match values from routing table \n "
399 #define SET_STR "Set values in destination routing protocol \n "
400 #define OUT_STR "Filter outgoing routing updates \n "
401 #define IN_STR "Filter incoming routing updates \n "
402 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0) \n "
403 #define OSPF6_NUMBER_STR "Specify by number \n "
404 #define INTERFACE_STR "Interface information \n "
405 #define IFNAME_STR "Interface name(e.g. ep0) \n "
406 #define IP6_STR "IPv6 Information \n "
407 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6 \n "
408 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID \n "
409 #define SECONDS_STR "Seconds \n "
410 #define ROUTE_STR "Routing Table \n "
411 #define PREFIX_LIST_STR "Build a prefix list \n "
412 #define OSPF6_DUMP_TYPE_LIST \
413 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
414 #define AREA_TAG_STR "[area tag] \n "
415 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535) \n "
416 #define COMMUNITY_VAL_STR \
417 "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 "
418 #define MPLS_TE_STR "MPLS-TE specific commands \n "
419 #define LINK_PARAMS_STR "Configure interface link parameters \n "
420 #define OSPF_RI_STR "OSPF Router Information specific commands \n "
421 #define PCE_STR "PCE Router Information specific commands \n "
422 #define MPLS_STR "MPLS information \n "
423 #define SR_STR "Segment-Routing specific commands \n "
424 #define WATCHFRR_STR "watchfrr information \n "
425 #define ZEBRA_STR "Zebra information \n "
426 #define FILTER_LOG_STR "Filter Logs \n "
427 #define BFD_PROFILE_STR "BFD profile. \n "
428 #define BFD_PROFILE_NAME_STR "BFD profile name. \n "
429 #define SHARP_STR "Sharp Routing Protocol \n "
430 #define OSPF_GR_STR \
431 "OSPF non-stop forwarding (NSF) also known as OSPF Graceful Restart \n "
433 #define CMD_VNI_RANGE "(1-16777215)"
434 #define CONF_BACKUP_EXT ".sav"
435 #define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC \n "
436 #define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC \n "
437 #define MPLS_LDP_SYNC_HOLDDOWN_STR \
438 "Time to wait for LDP-SYNC to occur before restoring if cost \n "
439 #define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable \n "
441 /* Command warnings. */
442 #define NO_PASSWD_CMD_WARNING \
443 "Please be aware that removing the password is a security risk and you should think twice about this command. \n "
445 /* IPv4 only machine should not accept IPv6 address for peer's IP
446 address. So we replace VTY command string like below. */
447 #define NEIGHBOR_ADDR_STR "Neighbor address \n IPv6 address \n "
448 #define NEIGHBOR_ADDR_STR2 "Neighbor address \n Neighbor IPv6 address \n Interface name or neighbor tag \n "
449 #define NEIGHBOR_ADDR_STR3 "Neighbor address \n IPv6 address \n Interface name \n "
451 /* Graceful Restart cli help strings */
452 #define GR_CMD "Global Graceful Restart command \n "
453 #define NO_GR_CMD "Undo Global Graceful Restart command \n "
454 #define GR "Global Graceful Restart - GR Mode \n "
455 #define GR_DISABLE "Global Graceful Restart - Disable Mode \n "
456 #define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode \n "
457 #define GR_DEBUG "Graceful Restart - Enable Debug Logs \n "
458 #define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode \n "
459 #define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor \n "
460 #define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor \n "
461 #define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor \n "
462 #define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor \n "
463 #define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor \n "
464 #define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor \n "
466 /* EVPN help Strings */
467 #define EVPN_RT_HELP_STR "EVPN route information \n "
468 #define EVPN_RT_DIST_HELP_STR "Route Distinguisher \n "
469 #define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX \n "
470 #define EVPN_TYPE_HELP_STR "Specify Route type \n "
471 #define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route \n "
472 #define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route \n "
473 #define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route \n "
474 #define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route \n "
475 #define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route \n "
476 #define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
477 #define EVPN_TYPE_ALL_LIST_HELP_STR \
478 EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR \
479 EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR \
480 EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR \
481 EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR \
482 EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
484 /* Describing roles */
486 "Providing transit \n Route server \n RS client \n Using transit \n Public/private peering \n "
488 /* BFD protocol integration strings. */
489 #define BFD_INTEGRATION_STR "BFD monitoring \n "
490 #define BFD_INTEGRATION_MULTI_HOP_STR "Use BFD multi hop session \n "
491 #define BFD_INTEGRATION_SOURCE_STR "Use source for BFD session \n "
492 #define BFD_INTEGRATION_SOURCEV4_STR "Use IPv4 source for BFD session \n "
493 #define BFD_INTEGRATION_SOURCEV6_STR "Use IPv4 source for BFD session \n "
496 extern void install_node ( struct cmd_node
* node
);
497 extern void install_default ( enum node_type
);
499 struct xref_install_element
{
502 const struct cmd_element
* cmd_element
;
503 enum node_type node_type
;
506 #define install_element(node_type_, cmd_element_) do { \
507 static const struct xref_install_element _xref \
508 __attribute__((used)) = { \
509 .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL, \
511 .cmd_element = cmd_element_, \
512 .node_type = node_type_, \
514 XREF_LINK(_xref.xref); \
515 _install_element(node_type_, cmd_element_); \
518 extern void _install_element ( enum node_type
, const struct cmd_element
*);
520 /* known issue with uninstall_element: changes to cmd_token->attr (i.e.
521 * deprecated/hidden) are not reversed. */
522 extern void uninstall_element ( enum node_type
, const struct cmd_element
*);
524 /* construct CLI tree only when entering nodes */
525 extern void cmd_defer_tree ( bool val
);
527 /* finish CLI tree for node when above is true (noop otherwise) */
528 extern void cmd_finalize_node ( struct cmd_node
* node
);
530 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
531 string with a space between each element (allocated using
532 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
533 extern char * argv_concat ( struct cmd_token
** argv
, int argc
, int shift
);
536 * It is preferred that you set the index initial value
537 * to a 0. This way in the future if you modify the
538 * cli then there is no need to modify the initial
541 extern int argv_find ( struct cmd_token
** argv
, int argc
, const char * text
,
544 extern vector
cmd_make_strvec ( const char *);
545 extern void cmd_free_strvec ( vector
);
546 extern vector
cmd_describe_command ( vector
, struct vty
*, int * status
);
547 extern char ** cmd_complete_command ( vector
, struct vty
*, int * status
);
548 extern const char * cmd_prompt ( enum node_type
);
549 extern int command_config_read_one_line ( struct vty
* vty
,
550 const struct cmd_element
**,
551 uint32_t line_num
, int use_config_node
);
552 extern int config_from_file ( struct vty
*, FILE *, unsigned int * line_num
);
553 extern enum node_type
node_parent ( enum node_type
);
555 * Execute command under the given vty context.
558 * The vty context to execute under.
561 * The command string to execute.
564 * If non-null and a match was found, the address of the matched command is
565 * stored here. No action otherwise.
568 * Whether or not this is being called from vtysh. If this is nonzero,
572 * XXX: what does it return
574 extern int cmd_execute ( struct vty
* vty
, const char * cmd
,
575 const struct cmd_element
** matched
, int vtysh
);
576 extern int cmd_execute_command ( vector
, struct vty
*,
577 const struct cmd_element
**, int );
578 extern int cmd_execute_command_strict ( vector
, struct vty
*,
579 const struct cmd_element
**);
580 extern void cmd_init ( int terminal
);
581 extern void cmd_init_config_callbacks ( void (* start_config_cb
)( void ),
582 void (* end_config_cb
)( void ));
583 extern void cmd_terminate ( void );
584 extern void cmd_exit ( struct vty
* vty
);
585 extern int cmd_list_cmds ( struct vty
* vty
, int do_permute
);
586 extern int cmd_find_cmds ( struct vty
* vty
, struct cmd_token
** argv
, int argc
);
588 extern int cmd_domainname_set ( const char * domainname
);
589 extern int cmd_hostname_set ( const char * hostname
);
590 extern const char * cmd_hostname_get ( void );
591 extern const char * cmd_domainname_get ( void );
592 extern const char * cmd_system_get ( void );
593 extern const char * cmd_release_get ( void );
594 extern const char * cmd_version_get ( void );
595 extern const char * cmd_software_version_get ( void );
596 extern bool cmd_allow_reserved_ranges_get ( void );
598 /* NOT safe for general use; call this only if DEV_BUILD! */
599 extern void grammar_sandbox_init ( void );
601 extern vector
completions_to_vec ( struct list
* completions
);
603 /* Export typical functions. */
604 extern const char * host_config_get ( void );
605 extern void host_config_set ( const char *);
607 extern void print_version ( const char *);
609 extern int cmd_banner_motd_file ( const char *);
610 extern void cmd_banner_motd_line ( const char * line
);
612 struct cmd_variable_handler
{
613 const char * tokenname
, * varname
;
614 void (* completions
)( vector out
, struct cmd_token
* token
);
617 extern void cmd_variable_complete ( struct cmd_token
* token
, const char * arg
,
620 cmd_variable_handler_register ( const struct cmd_variable_handler
* cvh
);
621 extern char * cmd_variable_comp2str ( vector comps
, unsigned short cols
);
623 extern void command_setup_early_logging ( const char * dest
, const char * level
);
626 * Allow a mechanism for `debug XXX` commands that live
627 * under the lib directory to output their debug status
629 extern void cmd_show_lib_debugs ( struct vty
* vty
);
635 #endif /* _ZEBRA_COMMAND_H */