]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.h
projects / mirror_frr.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge pull request #13649 from donaldsharp/unlock_the_node_or_else
[mirror_frr.git] / lib / command.h
CommitLineData
acddc0ed 1// SPDX-License-Identifier: GPL-2.0-or-later
718e3744 2/*
3 * Zebra configuration command interface routine
4 * Copyright (C) 1997, 98 Kunihiro Ishiguro
718e3744 5 */
6
7#ifndef _ZEBRA_COMMAND_H
8#define _ZEBRA_COMMAND_H
9
10#include "vector.h"
11#include "vty.h"
9c42a6eb 12#include "lib/route_types.h"
d0bfb22c 13#include "graph.h"
4a1ab8e4 14#include "memory.h"
274f29b2 15#include "hash.h"
5894e76d 16#include "command_graph.h"
4a1ab8e4 17
5e244469
RW		 18#ifdef __cplusplus
19extern "C" {
20#endif
21
bf8d3d6a 22DECLARE_MTYPE(COMPLETION);
4a1ab8e4 23
63e653a2
LK		 24/*
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.
29 *
30 * Host software MUST handle host names of up to 63 characters and
31 * SHOULD handle host names of up to 255 characters.
32 */
33#define HOSTNAME_LEN 255
34
718e3744 35/* Host configuration variable */
d62a17ae 36struct host {
37 /* Host name of this router. */
38 char *name;
718e3744 39
6f9d219a 40 /* Domainname of this router */
419cd5a0
MK		 41 char *domainname;
42
46b48b33
DS		 43 /*
44 * Some extra system data that is useful
45 */
46 char *system;
47 char *release;
48 char *version;
49
d62a17ae 50 /* Password for vty interface. */
51 char *password;
52 char *password_encrypt;
718e3744 53
d62a17ae 54 /* Enable password */
55 char *enable;
56 char *enable_encrypt;
718e3744 57
d62a17ae 58 /* System wide terminal lines. */
59 int lines;
718e3744 60
d62a17ae 61 /* config file name of this host */
62 char *config;
63 int noconfig;
718e3744 64
d62a17ae 65 /* Flags for services */
66 int advanced;
67 int encrypt;
718e3744 68
d62a17ae 69 /* Banner configuration. */
19d61463 70 char *motd;
d62a17ae 71 char *motdfile;
ac156aec
DA		 72
73 /* Allow using IPv4 (Class E) reserved IP space */
74 bool allow_reserved_ranges;
718e3744 75};
76
cf6c83e7 77/* List of CLI nodes. Please remember to update the name array in command.c. */
05a12619 78/* clang-format off */
d62a17ae 79enum node_type {
9f36abf9
PZ		 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. */
9f36abf9
PZ		 85 DEBUG_NODE, /* Debug node. */
86 VRF_DEBUG_NODE, /* Vrf Debug node. */
1c2facd1 87 NORTHBOUND_DEBUG_NODE, /* Northbound Debug node. */
9f36abf9 88 DEBUG_VNC_NODE, /* Debug VNC node. */
e3ab8170 89 RMAP_DEBUG_NODE, /* Route-map debug node */
fe9e7b71 90 RESOLVER_DEBUG_NODE, /* Resolver debug node */
9f36abf9 91 AAA_NODE, /* AAA node. */
1c6261a9 92 EXTLOG_NODE, /* RFC5424 & co. extended syslog */
9f36abf9
PZ		 93 KEYCHAIN_NODE, /* Key-chain node. */
94 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
05a12619 95 AFFMAP_NODE, /* Affinity map node. */
9f46cc36 96 IP_NODE, /* Static ip route node. */
9f36abf9
PZ		 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. */
bfaab44d 121 BGP_SRV6_NODE, /* BGP SRv6 node. */
9f36abf9
PZ		 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 */
46fb37cf 132 ISIS_FLEX_ALGO_NODE, /* ISIS Flex Algo mode */
9f36abf9
PZ		 133 ACCESS_NODE, /* Access list node. */
134 PREFIX_NODE, /* Prefix list node. */
135 ACCESS_IPV6_NODE, /* Access list node. */
136 ACCESS_MAC_NODE, /* MAC access list node*/
137 PREFIX_IPV6_NODE, /* Prefix list node. */
138 AS_LIST_NODE, /* AS list node. */
139 COMMUNITY_LIST_NODE, /* Community list node. */
ed0e57e3 140 COMMUNITY_ALIAS_NODE, /* Community alias node. */
9f36abf9 141 RMAP_NODE, /* Route map node. */
e5c83d9b 142 PBRMAP_NODE, /* PBR map node. */
9f36abf9
PZ		 143 SMUX_NODE, /* SNMP configuration node. */
144 DUMP_NODE, /* Packet dump node. */
145 FORWARDING_NODE, /* IP forwarding node. */
146 PROTOCOL_NODE, /* protocol filtering node */
147 MPLS_NODE, /* MPLS config node */
148 PW_NODE, /* Pseudowire config node */
4d7b695d
SM		 149 SEGMENT_ROUTING_NODE, /* Segment routing root node */
150 SR_TRAFFIC_ENG_NODE, /* SR Traffic Engineering node */
151 SR_SEGMENT_LIST_NODE, /* SR segment list config node */
152 SR_POLICY_NODE, /* SR policy config node */
153 SR_CANDIDATE_DYN_NODE, /* SR dynamic candidate path config node */
efba0985
SM		 154 PCEP_NODE, /* PCEP node */
155 PCEP_PCE_CONFIG_NODE, /* PCE shared configuration node */
156 PCEP_PCE_NODE, /* PCE configuration node */
157 PCEP_PCC_NODE, /* PCC configuration node */
6c0a7c09
HS		 158 SRV6_NODE, /* SRv6 node */
159 SRV6_LOCS_NODE, /* SRv6 locators node */
160 SRV6_LOC_NODE, /* SRv6 locator node */
9f36abf9 161 VTY_NODE, /* Vty node. */
893d8beb 162 FPM_NODE, /* Dataplane FPM node. */
9f36abf9
PZ		 163 LINK_PARAMS_NODE, /* Link-parameters node */
164 BGP_EVPN_VNI_NODE, /* BGP EVPN VNI */
996c9314
LB		 165 RPKI_NODE, /* RPKI node for configuration of RPKI cache server
166 connections.*/
7c40bf39 167 BGP_FLOWSPECV4_NODE, /* BGP IPv4 FLOWSPEC Address-Family */
168 BGP_FLOWSPECV6_NODE, /* BGP IPv6 FLOWSPEC Address-Family */
c2f29cf3
RZ		 169 BFD_NODE, /* BFD protocol mode. */
170 BFD_PEER_NODE, /* BFD peer configuration mode. */
d40d6c22 171 BFD_PROFILE_NODE, /* BFD profile configuration mode. */
7c0cbd0e 172 OPENFABRIC_NODE, /* OpenFabric router configuration node */
f828842a 173 VRRP_NODE, /* VRRP node */
ed18356f 174 BMP_NODE, /* BMP config under router bgp */
996c9314 175 NODE_TYPE_MAX, /* maximum */
718e3744 176};
05a12619 177/* clang-format on */
718e3744 178
cf6c83e7 179extern vector cmdvec;
26fbe472 180extern const struct message tokennames[];
a83a5331 181
d1b221f6
DL		 182/* for external users depending on struct layout */
183#define FRR_CMD_NODE_20200416
a83a5331 184
718e3744 185/* Node which has some commands and prompt string and configuration
186 function pointer . */
d62a17ae 187struct cmd_node {
f4b8291f
DL		 188 const char *name;
189
d62a17ae 190 /* Node index. */
191 enum node_type node;
24389580 192 enum node_type parent_node;
718e3744 193
d62a17ae 194 /* Prompt character at vty interface. */
195 const char *prompt;
718e3744 196
d62a17ae 197 /* Node's configuration write function */
612c2c15 198 int (*config_write)(struct vty *);
718e3744 199
791ded4a
DL		 200 /* called when leaving the node on a VTY session.
201 * return 1 if normal exit processing should happen, 0 to suppress
202 */
203 int (*node_exit)(struct vty *);
718e3744 204
d62a17ae 205 /* Node's command graph */
206 struct graph *cmdgraph;
d0bfb22c 207
d62a17ae 208 /* Vector of this node's command list. */
209 vector cmd_vector;
274f29b2 210
d62a17ae 211 /* Hashed index of command node list, for de-dupping primarily */
212 struct hash *cmd_hash;
0e06eb8b
DL		 213
214 /* set as soon as any command is in cmdgraph */
215 bool graph_built;
dd2c81b8
DL		 216
217 /* don't decrement vty->xpath_index on leaving this node */
218 bool no_xpath;
718e3744 219};
220
718e3744 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
1db63918 233#define CMD_ERR_NO_FILE 11
95c4aff2 234#define CMD_SUSPEND 12
f1a05de9 235#define CMD_WARNING_CONFIG_FAILED 13
a3d826f0 236#define CMD_NOT_MY_INSTANCE 14
e3476061 237#define CMD_NO_LEVEL_UP 15
a32f6a10 238#define CMD_ERR_NO_DAEMON 16
718e3744 239
240/* Argc max counts. */
09f6d019 241#define CMD_ARGC_MAX 256
718e3744 242
406d6716 243/* helper defines for end-user DEFUN* macros */
d62a17ae 244#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
154e9ca1 245 static const struct cmd_element cmdname = { \
d62a17ae 246 .string = cmdstr, \
247 .func = funcname, \
248 .doc = helpstr, \
249 .attr = attrs, \
250 .daemon = dnum, \
251 .name = #cmdname, \
feb06e7a
DL		 252 .xref = XREF_INIT(XREFT_DEFUN, NULL, #funcname), \
253 }; \
254 XREF_LINK(cmdname.xref); \
255 /* end */
256
d62a17ae 257
258#define DEFUN_CMD_FUNC_DECL(funcname) \
259 static int funcname(const struct cmd_element *, struct vty *, int, \
260 struct cmd_token *[]);
261
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)))
268
ba31dc30 269/* DEFPY variants */
26d19c83 270
e31f4dbe
QY		 271#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
272 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
273 funcdecl_##funcname
274
ba31dc30
DL		 275#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
276 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, 0)
277
278#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
3df57644 279 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_NOSH)
ba31dc30 280
e31f4dbe
QY		 281#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
282 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
283
ca77b518
RW		 284#define DEFPY_YANG(funcname, cmdname, cmdstr, helpstr) \
285 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
286
287#define DEFPY_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
3df57644
DL		 288 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, \
289 CMD_ATTR_YANG | CMD_ATTR_NOSH)
ca77b518 290
ba31dc30 291/* DEFUN variants */
d62a17ae 292
293#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
294 DEFUN_CMD_FUNC_DECL(funcname) \
295 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
296 DEFUN_CMD_FUNC_TEXT(funcname)
297
ba31dc30
DL		 298#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
299 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, 0)
300
d62a17ae 301#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
302 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
303
ca77b518
RW		 304#define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr) \
305 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
306
718e3744 307/* DEFUN_NOSH for commands that vtysh should ignore */
d62a17ae 308#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
3df57644 309 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_NOSH)
718e3744 310
ca77b518 311#define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
3df57644
DL		 312 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, \
313 CMD_ATTR_YANG | CMD_ATTR_NOSH)
ca77b518 314
718e3744 315/* DEFSH for vtysh. */
ba31dc30
DL		 316#define DEFSH_ATTR(daemon, cmdname, cmdstr, helpstr, attr) \
317 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, attr, daemon)
318
d62a17ae 319#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
ba31dc30 320 DEFSH_ATTR(daemon, cmdname, cmdstr, helpstr, 0)
718e3744 321
d62a17ae 322#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
ba31dc30 323 DEFSH_ATTR(daemon, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
ca77b518 324
718e3744 325/* DEFUN + DEFSH */
d62a17ae 326#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
327 DEFUN_CMD_FUNC_DECL(funcname) \
328 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
329 DEFUN_CMD_FUNC_TEXT(funcname)
274a4a44 330
ba31dc30
DL		 331#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
332 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, 0)
333
d62a17ae 334#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
335 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
336 CMD_ATTR_HIDDEN)
274a4a44 337
718e3744 338/* ALIAS macro which define existing command's alias. */
d62a17ae 339#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
340 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 341
ba31dc30
DL		 342#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
343 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, 0)
344
d62a17ae 345#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
ba31dc30 346 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
406d6716 347
9eebf97e
DL		 348/* note: DEPRECATED implies HIDDEN, and other than that there is currently no
349 * difference. It's purely for expressing intent in the source code - a
350 * DEPRECATED command is supposed to go away, a HIDDEN one is likely to stay.
351 */
d62a17ae 352#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
ba31dc30
DL		 353 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, \
354 CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN)
718e3744 355
ca77b518 356#define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr) \
ba31dc30 357 ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
274a4a44 358
718e3744 359/* Some macroes */
ba6d273b
DS		 360
361/*
362 * Sometimes #defines create maximum values that
363 * need to have strings created from them that
364 * allow the parser to match against them.
365 * These macros allow that.
366 */
367#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
368#define CMD_CREATE_STR_HELPER(s) #s
6319fd63 369#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b 370
718e3744 371/* Common descriptions. */
372#define SHOW_STR "Show running system information\n"
373#define IP_STR "IP information\n"
374#define IPV6_STR "IPv6 information\n"
852d9f97
SW		 375#define IP_ADDR_STR "IPv4 Address\n"
376#define IP6_ADDR_STR "IPv6 Address\n"
31f937fb
SM		 377#define SRTE_STR "SR-TE information\n"
378#define SRTE_COLOR_STR "SR-TE Color information\n"
718e3744 379#define NO_STR "Negate a command or set its defaults\n"
11ca3587 380#define IGNORED_IN_NO_STR "Ignored value in no form\n"
9c42a6eb 381#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 382#define CLEAR_STR "Reset functions\n"
383#define RIP_STR "RIP information\n"
7f57883e 384#define EIGRP_STR "EIGRP information\n"
718e3744 385#define BGP_STR "BGP information\n"
e0bce756
DS		 386#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
387#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
388#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
389#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 390#define OSPF_STR "OSPF information\n"
391#define NEIGHBOR_STR "Specify neighbor router\n"
ef7eec74 392#define DEBUG_STR "Debugging functions\n"
718e3744 393#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
394#define ROUTER_STR "Enable a routing process\n"
8079a413
PG		 395#define AS_STR \
396 "AS number in plain <1-4294967295> or dotted <0-65535>.<0-65535> format\n"
377e3565 397#define MAC_STR "MAC address\n"
718e3744 398#define MBGP_STR "MBGP information\n"
399#define MATCH_STR "Match values from routing table\n"
400#define SET_STR "Set values in destination routing protocol\n"
401#define OUT_STR "Filter outgoing routing updates\n"
402#define IN_STR "Filter incoming routing updates\n"
403#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
404#define OSPF6_NUMBER_STR "Specify by number\n"
0437e105 405#define INTERFACE_STR "Interface information\n"
718e3744 406#define IFNAME_STR "Interface name(e.g. ep0)\n"
407#define IP6_STR "IPv6 Information\n"
408#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c 409#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b 410#define SECONDS_STR "Seconds\n"
718e3744 411#define ROUTE_STR "Routing Table\n"
412#define PREFIX_LIST_STR "Build a prefix list\n"
d62a17ae 413#define OSPF6_DUMP_TYPE_LIST \
414 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
9e867fe6 415#define AREA_TAG_STR "[area tag]\n"
d0bfb22c 416#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
07b37df9
DA		 417#define COMMUNITY_VAL_STR \
418 "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"
16f1b9ee
OD		 419#define MPLS_TE_STR "MPLS-TE specific commands\n"
420#define LINK_PARAMS_STR "Configure interface link parameters\n"
421#define OSPF_RI_STR "OSPF Router Information specific commands\n"
422#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3 423#define MPLS_STR "MPLS information\n"
cf9b9f77 424#define SR_STR "Segment-Routing specific commands\n"
dff13b6f 425#define WATCHFRR_STR "watchfrr information\n"
41e7fb80 426#define ZEBRA_STR "Zebra information\n"
f73126c3 427#define FILTER_LOG_STR "Filter Logs\n"
d40d6c22
RZ		 428#define BFD_PROFILE_STR "BFD profile.\n"
429#define BFD_PROFILE_NAME_STR "BFD profile name.\n"
478ff17b 430#define SHARP_STR "Sharp Routing Protocol\n"
10514170
RW		 431#define OSPF_GR_STR \
432 "OSPF non-stop forwarding (NSF) also known as OSPF Graceful Restart\n"
1c84efe4
CH		 433#define MGMTD_STR "Management Daemon (MGMTD) information\n"
434#define MGMTD_BE_ADAPTER_STR "MGMTD Backend Adapter information\n"
435#define MGMTD_FE_ADAPTER_STR "MGMTD Frontend Adapter information\n"
436#define MGMTD_TXN_STR "MGMTD Transaction information\n"
437#define MGMTD_DS_STR "MGMTD Datastore information\n"
718e3744 438
093e3f23 439#define CMD_VNI_RANGE "(1-16777215)"
718e3744 440#define CONF_BACKUP_EXT ".sav"
24e7c5c8
KS		 441#define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC\n"
442#define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC\n"
443#define MPLS_LDP_SYNC_HOLDDOWN_STR \
444 "Time to wait for LDP-SYNC to occur before restoring if cost\n"
445#define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable\n"
718e3744 446
4911ca9c
PM		 447/* Command warnings. */
448#define NO_PASSWD_CMD_WARNING \
449 "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
450
718e3744 451/* IPv4 only machine should not accept IPv6 address for peer's IP
452 address. So we replace VTY command string like below. */
718e3744 453#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece
DS		 454#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
455#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 456
b0965c44 457/* Graceful Restart cli help strings */
b0965c44 458#define GR_CMD "Global Graceful Restart command\n"
459#define NO_GR_CMD "Undo Global Graceful Restart command\n"
460#define GR "Global Graceful Restart - GR Mode\n"
461#define GR_DISABLE "Global Graceful Restart - Disable Mode\n"
462#define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode\n"
463#define GR_DEBUG "Graceful Restart - Enable Debug Logs\n"
464#define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode\n"
465#define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor\n"
466#define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor\n"
467#define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor\n"
468#define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor\n"
469#define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor\n"
470#define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor\n"
471
3717389c
SW		 472/* EVPN help Strings */
473#define EVPN_RT_HELP_STR "EVPN route information\n"
474#define EVPN_RT_DIST_HELP_STR "Route Distinguisher\n"
475#define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX\n"
476#define EVPN_TYPE_HELP_STR "Specify Route type\n"
477#define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route\n"
478#define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route\n"
479#define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route\n"
480#define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route\n"
481#define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route\n"
247fb57d
SW		 482#define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
483#define EVPN_TYPE_ALL_LIST_HELP_STR \
484 EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR \
485 EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR \
486 EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR \
487 EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR \
488 EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
489
d864dd9e
EB		 490/* Describing roles */
491#define ROLE_STR \
492 "Providing transit\nRoute server\nRS client\nUsing transit\nPublic/private peering\n"
3717389c 493
e280279d
RZ		 494/* BFD protocol integration strings. */
495#define BFD_INTEGRATION_STR "BFD monitoring\n"
496#define BFD_INTEGRATION_MULTI_HOP_STR "Use BFD multi hop session\n"
497#define BFD_INTEGRATION_SOURCE_STR "Use source for BFD session\n"
498#define BFD_INTEGRATION_SOURCEV4_STR "Use IPv4 source for BFD session\n"
499#define BFD_INTEGRATION_SOURCEV6_STR "Use IPv4 source for BFD session\n"
500
718e3744 501/* Prototypes. */
612c2c15 502extern void install_node(struct cmd_node *node);
d62a17ae 503extern void install_default(enum node_type);
01485adb
DL		 504
505struct xref_install_element {
506 struct xref xref;
507
508 const struct cmd_element *cmd_element;
509 enum node_type node_type;
510};
511
01485adb
DL		 512#define install_element(node_type_, cmd_element_) do { \
513 static const struct xref_install_element _xref \
514 __attribute__((used)) = { \
515 .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL, \
516 __func__), \
517 .cmd_element = cmd_element_, \
518 .node_type = node_type_, \
519 }; \
520 XREF_LINK(_xref.xref); \
521 _install_element(node_type_, cmd_element_); \
522 } while (0)
01485adb
DL		 523
524extern void _install_element(enum node_type, const struct cmd_element *);
718e3744 525
de8f7a39
DL		 526/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
527 * deprecated/hidden) are not reversed. */
154e9ca1 528extern void uninstall_element(enum node_type, const struct cmd_element *);
de8f7a39 529
0e06eb8b
DL		 530/* construct CLI tree only when entering nodes */
531extern void cmd_defer_tree(bool val);
532
533/* finish CLI tree for node when above is true (noop otherwise) */
534extern void cmd_finalize_node(struct cmd_node *node);
535
f6834d4c 536/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
537 string with a space between each element (allocated using
538 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d62a17ae 539extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
b286ddb0
DS		 540
541/*
542 * It is preferred that you set the index initial value
543 * to a 0. This way in the future if you modify the
544 * cli then there is no need to modify the initial
545 * value of the index
546 */
d62a17ae 547extern int argv_find(struct cmd_token **argv, int argc, const char *text,
548 int *index);
549
550extern vector cmd_make_strvec(const char *);
551extern void cmd_free_strvec(vector);
552extern vector cmd_describe_command(vector, struct vty *, int *status);
553extern char **cmd_complete_command(vector, struct vty *, int *status);
554extern const char *cmd_prompt(enum node_type);
555extern int command_config_read_one_line(struct vty *vty,
556 const struct cmd_element **,
7ab57d19 557 uint32_t line_num, int use_config_node);
d62a17ae 558extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
559extern enum node_type node_parent(enum node_type);
01e24c4a
QY		 560/*
561 * Execute command under the given vty context.
562 *
563 * vty
564 * The vty context to execute under.
565 *
566 * cmd
567 * The command string to execute.
568 *
569 * matched
570 * If non-null and a match was found, the address of the matched command is
571 * stored here. No action otherwise.
572 *
573 * vtysh
574 * Whether or not this is being called from vtysh. If this is nonzero,
575 * XXX: then what?
576 *
577 * Returns:
578 * XXX: what does it return
579 */
580extern int cmd_execute(struct vty *vty, const char *cmd,
581 const struct cmd_element **matched, int vtysh);
d62a17ae 582extern int cmd_execute_command(vector, struct vty *,
583 const struct cmd_element **, int);
584extern int cmd_execute_command_strict(vector, struct vty *,
585 const struct cmd_element **);
f8e6ada8 586extern void cmd_init(int terminal);
62b43962
IR		 587extern void cmd_init_config_callbacks(void (*start_config_cb)(void),
588 void (*end_config_cb)(void));
d62a17ae 589extern void cmd_terminate(void);
590extern void cmd_exit(struct vty *vty);
591extern int cmd_list_cmds(struct vty *vty, int do_permute);
c2278962 592extern int cmd_find_cmds(struct vty *vty, struct cmd_token **argv, int argc);
d62a17ae 593
6b3ee3a0 594extern int cmd_domainname_set(const char *domainname);
d62a17ae 595extern int cmd_hostname_set(const char *hostname);
6b3ee3a0
MK		 596extern const char *cmd_hostname_get(void);
597extern const char *cmd_domainname_get(void);
46b48b33
DS		 598extern const char *cmd_system_get(void);
599extern const char *cmd_release_get(void);
600extern const char *cmd_version_get(void);
234f6fd4 601extern const char *cmd_software_version_get(void);
ac156aec 602extern bool cmd_allow_reserved_ranges_get(void);
bff9c3e9 603
af2567b6 604/* NOT safe for general use; call this only if DEV_BUILD! */
d62a17ae 605extern void grammar_sandbox_init(void);
af2567b6 606
d62a17ae 607extern vector completions_to_vec(struct list *completions);
2ab40270 608
718e3744 609/* Export typical functions. */
d62a17ae 610extern const char *host_config_get(void);
611extern void host_config_set(const char *);
6590f2c3 612
d62a17ae 613extern void print_version(const char *);
86228fde 614
d62a17ae 615extern int cmd_banner_motd_file(const char *);
19d61463 616extern void cmd_banner_motd_line(const char *line);
7cfc61d3 617
70d44c5c 618struct cmd_variable_handler {
d62a17ae 619 const char *tokenname, *varname;
620 void (*completions)(vector out, struct cmd_token *token);
70d44c5c
DL		 621};
622
d62a17ae 623extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
624 vector comps);
625extern void
626cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
627extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
228da428 628
e9b4e74a 629extern void command_setup_early_logging(const char *dest, const char *level);
5e244469 630
cf00164b
DS		 631/*
632 * Allow a mechanism for `debug XXX` commands that live
633 * under the lib directory to output their debug status
634 */
635extern void cmd_show_lib_debugs(struct vty *vty);
636
5e244469
RW		 637#ifdef __cplusplus
638}
639#endif
640
718e3744 641#endif /* _ZEBRA_COMMAND_H */
FRRouting mirror