]> 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 #8619 from donaldsharp/sharp_redistribute
[mirror_frr.git] / lib / command.h
CommitLineData
718e3744 1/*
2 * Zebra configuration command interface routine
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
4 *
5 * This file is part of GNU Zebra.
6 *
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.
d0bfb22c 11 *
718e3744 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.
16 *
896014f4
DL		 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
718e3744 20 */
21
22#ifndef _ZEBRA_COMMAND_H
23#define _ZEBRA_COMMAND_H
24
25#include "vector.h"
26#include "vty.h"
9c42a6eb 27#include "lib/route_types.h"
d0bfb22c 28#include "graph.h"
4a1ab8e4 29#include "memory.h"
274f29b2 30#include "hash.h"
5894e76d 31#include "command_graph.h"
4a1ab8e4 32
5e244469
RW		 33#ifdef __cplusplus
34extern "C" {
35#endif
36
bf8d3d6a 37DECLARE_MTYPE(COMPLETION);
4a1ab8e4 38
63e653a2
LK		 39/*
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.
44 *
45 * Host software MUST handle host names of up to 63 characters and
46 * SHOULD handle host names of up to 255 characters.
47 */
48#define HOSTNAME_LEN 255
49
718e3744 50/* Host configuration variable */
d62a17ae 51struct host {
52 /* Host name of this router. */
53 char *name;
718e3744 54
6f9d219a 55 /* Domainname of this router */
419cd5a0
MK		 56 char *domainname;
57
d62a17ae 58 /* Password for vty interface. */
59 char *password;
60 char *password_encrypt;
718e3744 61
d62a17ae 62 /* Enable password */
63 char *enable;
64 char *enable_encrypt;
718e3744 65
d62a17ae 66 /* System wide terminal lines. */
67 int lines;
718e3744 68
d62a17ae 69 /* config file name of this host */
70 char *config;
71 int noconfig;
718e3744 72
d62a17ae 73 /* Flags for services */
74 int advanced;
75 int encrypt;
718e3744 76
d62a17ae 77 /* Banner configuration. */
19d61463 78 char *motd;
d62a17ae 79 char *motdfile;
718e3744 80};
81
cf6c83e7 82/* List of CLI nodes. Please remember to update the name array in command.c. */
d62a17ae 83enum node_type {
9f36abf9
PZ		 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. */
9f36abf9
PZ		 89 DEBUG_NODE, /* Debug node. */
90 VRF_DEBUG_NODE, /* Vrf Debug node. */
1c2facd1 91 NORTHBOUND_DEBUG_NODE, /* Northbound Debug node. */
9f36abf9 92 DEBUG_VNC_NODE, /* Debug VNC node. */
e3ab8170 93 RMAP_DEBUG_NODE, /* Route-map debug node */
fe9e7b71 94 RESOLVER_DEBUG_NODE, /* Resolver debug node */
9f36abf9
PZ		 95 AAA_NODE, /* AAA node. */
96 KEYCHAIN_NODE, /* Key-chain node. */
97 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
9f46cc36 98 IP_NODE, /* Static ip route node. */
9f36abf9
PZ		 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. */
9f36abf9
PZ		 123 OSPF_NODE, /* OSPF protocol mode */
124 OSPF6_NODE, /* OSPF protocol for IPv6 mode */
125 LDP_NODE, /* LDP protocol mode */
126 LDP_IPV4_NODE, /* LDP IPv4 address family */
127 LDP_IPV6_NODE, /* LDP IPv6 address family */
128 LDP_IPV4_IFACE_NODE, /* LDP IPv4 Interface */
129 LDP_IPV6_IFACE_NODE, /* LDP IPv6 Interface */
130 LDP_L2VPN_NODE, /* LDP L2VPN node */
131 LDP_PSEUDOWIRE_NODE, /* LDP Pseudowire node */
132 ISIS_NODE, /* ISIS protocol 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. */
140 RMAP_NODE, /* Route map node. */
e5c83d9b 141 PBRMAP_NODE, /* PBR map node. */
9f36abf9
PZ		 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 */
4d7b695d
SM		 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 */
efba0985
SM		 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 */
9f36abf9 157 VTY_NODE, /* Vty node. */
893d8beb 158 FPM_NODE, /* Dataplane FPM node. */
9f36abf9
PZ		 159 LINK_PARAMS_NODE, /* Link-parameters node */
160 BGP_EVPN_VNI_NODE, /* BGP EVPN VNI */
996c9314
LB		 161 RPKI_NODE, /* RPKI node for configuration of RPKI cache server
162 connections.*/
7c40bf39 163 BGP_FLOWSPECV4_NODE, /* BGP IPv4 FLOWSPEC Address-Family */
164 BGP_FLOWSPECV6_NODE, /* BGP IPv6 FLOWSPEC Address-Family */
c2f29cf3
RZ		 165 BFD_NODE, /* BFD protocol mode. */
166 BFD_PEER_NODE, /* BFD peer configuration mode. */
d40d6c22 167 BFD_PROFILE_NODE, /* BFD profile configuration mode. */
7c0cbd0e 168 OPENFABRIC_NODE, /* OpenFabric router configuration node */
f828842a 169 VRRP_NODE, /* VRRP node */
ed18356f 170 BMP_NODE, /* BMP config under router bgp */
996c9314 171 NODE_TYPE_MAX, /* maximum */
718e3744 172};
173
cf6c83e7 174extern vector cmdvec;
26fbe472 175extern const struct message tokennames[];
a83a5331 176
d1b221f6
DL		 177/* for external users depending on struct layout */
178#define FRR_CMD_NODE_20200416
a83a5331 179
718e3744 180/* Node which has some commands and prompt string and configuration
181 function pointer . */
d62a17ae 182struct cmd_node {
f4b8291f
DL		 183 const char *name;
184
d62a17ae 185 /* Node index. */
186 enum node_type node;
24389580 187 enum node_type parent_node;
718e3744 188
d62a17ae 189 /* Prompt character at vty interface. */
190 const char *prompt;
718e3744 191
d62a17ae 192 /* Node's configuration write function */
612c2c15 193 int (*config_write)(struct vty *);
718e3744 194
791ded4a
DL		 195 /* called when leaving the node on a VTY session.
196 * return 1 if normal exit processing should happen, 0 to suppress
197 */
198 int (*node_exit)(struct vty *);
718e3744 199
d62a17ae 200 /* Node's command graph */
201 struct graph *cmdgraph;
d0bfb22c 202
d62a17ae 203 /* Vector of this node's command list. */
204 vector cmd_vector;
274f29b2 205
d62a17ae 206 /* Hashed index of command node list, for de-dupping primarily */
207 struct hash *cmd_hash;
718e3744 208};
209
718e3744 210/* Return value of the commands. */
211#define CMD_SUCCESS 0
212#define CMD_WARNING 1
213#define CMD_ERR_NO_MATCH 2
214#define CMD_ERR_AMBIGUOUS 3
215#define CMD_ERR_INCOMPLETE 4
216#define CMD_ERR_EXEED_ARGC_MAX 5
217#define CMD_ERR_NOTHING_TODO 6
218#define CMD_COMPLETE_FULL_MATCH 7
219#define CMD_COMPLETE_MATCH 8
220#define CMD_COMPLETE_LIST_MATCH 9
221#define CMD_SUCCESS_DAEMON 10
1db63918 222#define CMD_ERR_NO_FILE 11
95c4aff2 223#define CMD_SUSPEND 12
f1a05de9 224#define CMD_WARNING_CONFIG_FAILED 13
a3d826f0 225#define CMD_NOT_MY_INSTANCE 14
e3476061 226#define CMD_NO_LEVEL_UP 15
718e3744 227
228/* Argc max counts. */
09f6d019 229#define CMD_ARGC_MAX 256
718e3744 230
231/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c 232#ifndef VTYSH_EXTRACT_PL
718e3744 233
406d6716 234/* helper defines for end-user DEFUN* macros */
d62a17ae 235#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
154e9ca1 236 static const struct cmd_element cmdname = { \
d62a17ae 237 .string = cmdstr, \
238 .func = funcname, \
239 .doc = helpstr, \
240 .attr = attrs, \
241 .daemon = dnum, \
242 .name = #cmdname, \
feb06e7a
DL		 243 .xref = XREF_INIT(XREFT_DEFUN, NULL, #funcname), \
244 }; \
245 XREF_LINK(cmdname.xref); \
246 /* end */
247
d62a17ae 248
249#define DEFUN_CMD_FUNC_DECL(funcname) \
250 static int funcname(const struct cmd_element *, struct vty *, int, \
251 struct cmd_token *[]);
252
253#define DEFUN_CMD_FUNC_TEXT(funcname) \
254 static int funcname(const struct cmd_element *self \
255 __attribute__((unused)), \
256 struct vty *vty __attribute__((unused)), \
257 int argc __attribute__((unused)), \
258 struct cmd_token *argv[] __attribute__((unused)))
259
260#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
261 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
262 funcdecl_##funcname
263
26d19c83
RW		 264#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
265 DEFPY(funcname, cmdname, cmdstr, helpstr)
266
e31f4dbe
QY		 267#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
268 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
269 funcdecl_##funcname
270
271#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
272 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
273
ca77b518
RW		 274#define DEFPY_YANG(funcname, cmdname, cmdstr, helpstr) \
275 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
276
277#define DEFPY_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
278 DEFPY_YANG(funcname, cmdname, cmdstr, helpstr)
279
d62a17ae 280#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
281 DEFUN_CMD_FUNC_DECL(funcname) \
282 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
283 DEFUN_CMD_FUNC_TEXT(funcname)
284
285#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
286 DEFUN_CMD_FUNC_DECL(funcname) \
287 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
288 DEFUN_CMD_FUNC_TEXT(funcname)
289
290#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
291 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
292
ca77b518
RW		 293#define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr) \
294 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
295
718e3744 296/* DEFUN_NOSH for commands that vtysh should ignore */
d62a17ae 297#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
298 DEFUN(funcname, cmdname, cmdstr, helpstr)
718e3744 299
ca77b518
RW		 300#define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
301 DEFUN_YANG(funcname, cmdname, cmdstr, helpstr)
302
718e3744 303/* DEFSH for vtysh. */
d62a17ae 304#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
305 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
718e3744 306
d62a17ae 307#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
308 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
309 daemon)
abaaab4e 310
ca77b518
RW		 311#define DEFSH_YANG(daemon, cmdname, cmdstr, helpstr) \
312 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, daemon)
313
718e3744 314/* DEFUN + DEFSH */
d62a17ae 315#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
316 DEFUN_CMD_FUNC_DECL(funcname) \
317 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
318 DEFUN_CMD_FUNC_TEXT(funcname)
718e3744 319
274a4a44 320/* DEFUN + DEFSH with attributes */
d62a17ae 321#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
322 DEFUN_CMD_FUNC_DECL(funcname) \
323 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
324 DEFUN_CMD_FUNC_TEXT(funcname)
274a4a44 325
d62a17ae 326#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
327 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
328 CMD_ATTR_HIDDEN)
274a4a44 329
d62a17ae 330#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
331 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
332 CMD_ATTR_DEPRECATED)
274a4a44 333
ca77b518
RW		 334#define DEFUNSH_YANG(daemon, funcname, cmdname, cmdstr, helpstr) \
335 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
336
718e3744 337/* ALIAS macro which define existing command's alias. */
d62a17ae 338#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
339 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
406d6716 340
d62a17ae 341#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
342 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 343
d62a17ae 344#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
345 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
346 0)
406d6716 347
d62a17ae 348#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
349 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
350 CMD_ATTR_DEPRECATED, 0)
718e3744 351
ca77b518
RW		 352#define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr) \
353 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, 0)
354
d62a17ae 355#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
356 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
274a4a44 357
d62a17ae 358#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
359 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
360 daemon)
274a4a44 361
d62a17ae 362#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
363 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
364 CMD_ATTR_DEPRECATED, daemon)
274a4a44 365
718e3744 366#endif /* VTYSH_EXTRACT_PL */
367
368/* Some macroes */
ba6d273b
DS		 369
370/*
371 * Sometimes #defines create maximum values that
372 * need to have strings created from them that
373 * allow the parser to match against them.
374 * These macros allow that.
375 */
376#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
377#define CMD_CREATE_STR_HELPER(s) #s
6319fd63 378#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b 379
718e3744 380/* Common descriptions. */
381#define SHOW_STR "Show running system information\n"
382#define IP_STR "IP information\n"
383#define IPV6_STR "IPv6 information\n"
31f937fb
SM		 384#define SRTE_STR "SR-TE information\n"
385#define SRTE_COLOR_STR "SR-TE Color information\n"
718e3744 386#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb 387#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 388#define CLEAR_STR "Reset functions\n"
389#define RIP_STR "RIP information\n"
7f57883e 390#define EIGRP_STR "EIGRP information\n"
718e3744 391#define BGP_STR "BGP information\n"
e0bce756
DS		 392#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
393#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
394#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
395#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 396#define OSPF_STR "OSPF information\n"
397#define NEIGHBOR_STR "Specify neighbor router\n"
ef7eec74 398#define DEBUG_STR "Debugging functions\n"
718e3744 399#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
400#define ROUTER_STR "Enable a routing process\n"
401#define AS_STR "AS number\n"
377e3565 402#define MAC_STR "MAC address\n"
718e3744 403#define MBGP_STR "MBGP information\n"
404#define MATCH_STR "Match values from routing table\n"
405#define SET_STR "Set values in destination routing protocol\n"
406#define OUT_STR "Filter outgoing routing updates\n"
407#define IN_STR "Filter incoming routing updates\n"
408#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
409#define OSPF6_NUMBER_STR "Specify by number\n"
0437e105 410#define INTERFACE_STR "Interface information\n"
718e3744 411#define IFNAME_STR "Interface name(e.g. ep0)\n"
412#define IP6_STR "IPv6 Information\n"
413#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c 414#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b 415#define SECONDS_STR "Seconds\n"
718e3744 416#define ROUTE_STR "Routing Table\n"
417#define PREFIX_LIST_STR "Build a prefix list\n"
d62a17ae 418#define OSPF6_DUMP_TYPE_LIST \
419 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
9e867fe6 420#define AREA_TAG_STR "[area tag]\n"
d0bfb22c 421#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
07b37df9
DA		 422#define COMMUNITY_VAL_STR \
423 "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		 424#define MPLS_TE_STR "MPLS-TE specific commands\n"
425#define LINK_PARAMS_STR "Configure interface link parameters\n"
426#define OSPF_RI_STR "OSPF Router Information specific commands\n"
427#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3 428#define MPLS_STR "MPLS information\n"
cf9b9f77 429#define SR_STR "Segment-Routing specific commands\n"
dff13b6f 430#define WATCHFRR_STR "watchfrr information\n"
41e7fb80 431#define ZEBRA_STR "Zebra information\n"
f73126c3 432#define FILTER_LOG_STR "Filter Logs\n"
d40d6c22
RZ		 433#define BFD_PROFILE_STR "BFD profile.\n"
434#define BFD_PROFILE_NAME_STR "BFD profile name.\n"
478ff17b 435#define SHARP_STR "Sharp Routing Protocol\n"
718e3744 436
093e3f23 437#define CMD_VNI_RANGE "(1-16777215)"
718e3744 438#define CONF_BACKUP_EXT ".sav"
24e7c5c8
KS		 439#define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC\n"
440#define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC\n"
441#define MPLS_LDP_SYNC_HOLDDOWN_STR \
442 "Time to wait for LDP-SYNC to occur before restoring if cost\n"
443#define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable\n"
718e3744 444
4911ca9c
PM		 445/* Command warnings. */
446#define NO_PASSWD_CMD_WARNING \
447 "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
448
718e3744 449/* IPv4 only machine should not accept IPv6 address for peer's IP
450 address. So we replace VTY command string like below. */
718e3744 451#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece
DS		 452#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
453#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 454
b0965c44 455/* Graceful Restart cli help strings */
b0965c44 456#define GR_CMD "Global Graceful Restart command\n"
457#define NO_GR_CMD "Undo Global Graceful Restart command\n"
458#define GR "Global Graceful Restart - GR Mode\n"
459#define GR_DISABLE "Global Graceful Restart - Disable Mode\n"
460#define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode\n"
461#define GR_DEBUG "Graceful Restart - Enable Debug Logs\n"
462#define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode\n"
463#define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor\n"
464#define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor\n"
465#define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor\n"
466#define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor\n"
467#define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor\n"
468#define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor\n"
469
3717389c
SW		 470/* EVPN help Strings */
471#define EVPN_RT_HELP_STR "EVPN route information\n"
472#define EVPN_RT_DIST_HELP_STR "Route Distinguisher\n"
473#define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX\n"
474#define EVPN_TYPE_HELP_STR "Specify Route type\n"
475#define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route\n"
476#define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route\n"
477#define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route\n"
478#define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route\n"
479#define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route\n"
247fb57d
SW		 480#define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
481#define EVPN_TYPE_ALL_LIST_HELP_STR \
482 EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR \
483 EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR \
484 EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR \
485 EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR \
486 EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
487
3717389c 488
718e3744 489/* Prototypes. */
612c2c15 490extern void install_node(struct cmd_node *node);
d62a17ae 491extern void install_default(enum node_type);
01485adb
DL		 492
493struct xref_install_element {
494 struct xref xref;
495
496 const struct cmd_element *cmd_element;
497 enum node_type node_type;
498};
499
500#ifndef VTYSH_EXTRACT_PL
501#define install_element(node_type_, cmd_element_) do { \
502 static const struct xref_install_element _xref \
503 __attribute__((used)) = { \
504 .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL, \
505 __func__), \
506 .cmd_element = cmd_element_, \
507 .node_type = node_type_, \
508 }; \
509 XREF_LINK(_xref.xref); \
510 _install_element(node_type_, cmd_element_); \
511 } while (0)
512#endif
513
514extern void _install_element(enum node_type, const struct cmd_element *);
718e3744 515
de8f7a39
DL		 516/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
517 * deprecated/hidden) are not reversed. */
154e9ca1 518extern void uninstall_element(enum node_type, const struct cmd_element *);
de8f7a39 519
f6834d4c 520/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
521 string with a space between each element (allocated using
522 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d62a17ae 523extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
b286ddb0
DS		 524
525/*
526 * It is preferred that you set the index initial value
527 * to a 0. This way in the future if you modify the
528 * cli then there is no need to modify the initial
529 * value of the index
530 */
d62a17ae 531extern int argv_find(struct cmd_token **argv, int argc, const char *text,
532 int *index);
533
534extern vector cmd_make_strvec(const char *);
535extern void cmd_free_strvec(vector);
536extern vector cmd_describe_command(vector, struct vty *, int *status);
537extern char **cmd_complete_command(vector, struct vty *, int *status);
538extern const char *cmd_prompt(enum node_type);
539extern int command_config_read_one_line(struct vty *vty,
540 const struct cmd_element **,
7ab57d19 541 uint32_t line_num, int use_config_node);
d62a17ae 542extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
543extern enum node_type node_parent(enum node_type);
01e24c4a
QY		 544/*
545 * Execute command under the given vty context.
546 *
547 * vty
548 * The vty context to execute under.
549 *
550 * cmd
551 * The command string to execute.
552 *
553 * matched
554 * If non-null and a match was found, the address of the matched command is
555 * stored here. No action otherwise.
556 *
557 * vtysh
558 * Whether or not this is being called from vtysh. If this is nonzero,
559 * XXX: then what?
560 *
561 * Returns:
562 * XXX: what does it return
563 */
564extern int cmd_execute(struct vty *vty, const char *cmd,
565 const struct cmd_element **matched, int vtysh);
d62a17ae 566extern int cmd_execute_command(vector, struct vty *,
567 const struct cmd_element **, int);
568extern int cmd_execute_command_strict(vector, struct vty *,
569 const struct cmd_element **);
f8e6ada8 570extern void cmd_init(int terminal);
62b43962
IR		 571extern void cmd_init_config_callbacks(void (*start_config_cb)(void),
572 void (*end_config_cb)(void));
d62a17ae 573extern void cmd_terminate(void);
574extern void cmd_exit(struct vty *vty);
575extern int cmd_list_cmds(struct vty *vty, int do_permute);
576
6b3ee3a0 577extern int cmd_domainname_set(const char *domainname);
d62a17ae 578extern int cmd_hostname_set(const char *hostname);
6b3ee3a0
MK		 579extern const char *cmd_hostname_get(void);
580extern const char *cmd_domainname_get(void);
bff9c3e9 581
af2567b6 582/* NOT safe for general use; call this only if DEV_BUILD! */
d62a17ae 583extern void grammar_sandbox_init(void);
af2567b6 584
d62a17ae 585extern vector completions_to_vec(struct list *completions);
2ab40270 586
718e3744 587/* Export typical functions. */
d62a17ae 588extern const char *host_config_get(void);
589extern void host_config_set(const char *);
6590f2c3 590
d62a17ae 591extern void print_version(const char *);
86228fde 592
d62a17ae 593extern int cmd_banner_motd_file(const char *);
19d61463 594extern void cmd_banner_motd_line(const char *line);
7cfc61d3 595
86228fde 596/* struct host global, ick */
d0bfb22c
QY		 597extern struct host host;
598
70d44c5c 599struct cmd_variable_handler {
d62a17ae 600 const char *tokenname, *varname;
601 void (*completions)(vector out, struct cmd_token *token);
70d44c5c
DL		 602};
603
d62a17ae 604extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
605 vector comps);
606extern void
607cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
608extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
228da428 609
e9b4e74a 610extern void command_setup_early_logging(const char *dest, const char *level);
5e244469
RW		 611
612#ifdef __cplusplus
613}
614#endif
615
718e3744 616#endif /* _ZEBRA_COMMAND_H */
FRRouting mirror