]> 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
lib: use hash for route-map set/match commands
[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. */
bfaab44d 123 BGP_SRV6_NODE, /* BGP SRv6 node. */
9f36abf9
PZ		 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 */
9f36abf9
PZ		 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. */
ed0e57e3 141 COMMUNITY_ALIAS_NODE, /* Community alias node. */
9f36abf9 142 RMAP_NODE, /* Route map node. */
e5c83d9b 143 PBRMAP_NODE, /* PBR map node. */
9f36abf9
PZ		 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 */
4d7b695d
SM		 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 */
efba0985
SM		 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 */
6c0a7c09
HS		 159 SRV6_NODE, /* SRv6 node */
160 SRV6_LOCS_NODE, /* SRv6 locators node */
161 SRV6_LOC_NODE, /* SRv6 locator node */
9f36abf9 162 VTY_NODE, /* Vty node. */
893d8beb 163 FPM_NODE, /* Dataplane FPM node. */
9f36abf9
PZ		 164 LINK_PARAMS_NODE, /* Link-parameters node */
165 BGP_EVPN_VNI_NODE, /* BGP EVPN VNI */
996c9314
LB		 166 RPKI_NODE, /* RPKI node for configuration of RPKI cache server
167 connections.*/
7c40bf39 168 BGP_FLOWSPECV4_NODE, /* BGP IPv4 FLOWSPEC Address-Family */
169 BGP_FLOWSPECV6_NODE, /* BGP IPv6 FLOWSPEC Address-Family */
c2f29cf3
RZ		 170 BFD_NODE, /* BFD protocol mode. */
171 BFD_PEER_NODE, /* BFD peer configuration mode. */
d40d6c22 172 BFD_PROFILE_NODE, /* BFD profile configuration mode. */
7c0cbd0e 173 OPENFABRIC_NODE, /* OpenFabric router configuration node */
f828842a 174 VRRP_NODE, /* VRRP node */
ed18356f 175 BMP_NODE, /* BMP config under router bgp */
996c9314 176 NODE_TYPE_MAX, /* maximum */
718e3744 177};
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;
718e3744 216};
217
718e3744 218/* Return value of the commands. */
219#define CMD_SUCCESS 0
220#define CMD_WARNING 1
221#define CMD_ERR_NO_MATCH 2
222#define CMD_ERR_AMBIGUOUS 3
223#define CMD_ERR_INCOMPLETE 4
224#define CMD_ERR_EXEED_ARGC_MAX 5
225#define CMD_ERR_NOTHING_TODO 6
226#define CMD_COMPLETE_FULL_MATCH 7
227#define CMD_COMPLETE_MATCH 8
228#define CMD_COMPLETE_LIST_MATCH 9
229#define CMD_SUCCESS_DAEMON 10
1db63918 230#define CMD_ERR_NO_FILE 11
95c4aff2 231#define CMD_SUSPEND 12
f1a05de9 232#define CMD_WARNING_CONFIG_FAILED 13
a3d826f0 233#define CMD_NOT_MY_INSTANCE 14
e3476061 234#define CMD_NO_LEVEL_UP 15
a32f6a10 235#define CMD_ERR_NO_DAEMON 16
718e3744 236
237/* Argc max counts. */
09f6d019 238#define CMD_ARGC_MAX 256
718e3744 239
214d8a60 240/* Turn off these macros when using cpp with extract.pl */
d0bfb22c 241#ifndef VTYSH_EXTRACT_PL
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
269#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
270 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
271 funcdecl_##funcname
272
26d19c83
RW		 273#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
274 DEFPY(funcname, cmdname, cmdstr, helpstr)
275
e31f4dbe
QY		 276#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
277 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
278 funcdecl_##funcname
279
280#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
281 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
282
ca77b518
RW		 283#define DEFPY_YANG(funcname, cmdname, cmdstr, helpstr) \
284 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
285
286#define DEFPY_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
287 DEFPY_YANG(funcname, cmdname, cmdstr, helpstr)
288
d62a17ae 289#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
290 DEFUN_CMD_FUNC_DECL(funcname) \
291 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
292 DEFUN_CMD_FUNC_TEXT(funcname)
293
294#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
295 DEFUN_CMD_FUNC_DECL(funcname) \
296 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
297 DEFUN_CMD_FUNC_TEXT(funcname)
298
299#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
300 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
301
ca77b518
RW		 302#define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr) \
303 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
304
718e3744 305/* DEFUN_NOSH for commands that vtysh should ignore */
d62a17ae 306#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
307 DEFUN(funcname, cmdname, cmdstr, helpstr)
718e3744 308
ca77b518
RW		 309#define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr) \
310 DEFUN_YANG(funcname, cmdname, cmdstr, helpstr)
311
718e3744 312/* DEFSH for vtysh. */
d62a17ae 313#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
314 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
718e3744 315
d62a17ae 316#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
317 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
318 daemon)
abaaab4e 319
ca77b518
RW		 320#define DEFSH_YANG(daemon, cmdname, cmdstr, helpstr) \
321 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, daemon)
322
718e3744 323/* DEFUN + DEFSH */
d62a17ae 324#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
325 DEFUN_CMD_FUNC_DECL(funcname) \
326 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
327 DEFUN_CMD_FUNC_TEXT(funcname)
718e3744 328
274a4a44 329/* DEFUN + DEFSH with attributes */
d62a17ae 330#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
331 DEFUN_CMD_FUNC_DECL(funcname) \
332 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
333 DEFUN_CMD_FUNC_TEXT(funcname)
274a4a44 334
d62a17ae 335#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
336 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
337 CMD_ATTR_HIDDEN)
274a4a44 338
d62a17ae 339#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
340 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
341 CMD_ATTR_DEPRECATED)
274a4a44 342
ca77b518
RW		 343#define DEFUNSH_YANG(daemon, funcname, cmdname, cmdstr, helpstr) \
344 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
345
718e3744 346/* ALIAS macro which define existing command's alias. */
d62a17ae 347#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
348 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
406d6716 349
d62a17ae 350#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
351 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716 352
d62a17ae 353#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
354 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
355 0)
406d6716 356
d62a17ae 357#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
358 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
359 CMD_ATTR_DEPRECATED, 0)
718e3744 360
ca77b518
RW		 361#define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr) \
362 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, 0)
363
d62a17ae 364#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
365 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
274a4a44 366
d62a17ae 367#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
368 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
369 daemon)
274a4a44 370
d62a17ae 371#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
372 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
373 CMD_ATTR_DEPRECATED, daemon)
274a4a44 374
718e3744 375#endif /* VTYSH_EXTRACT_PL */
376
377/* Some macroes */
ba6d273b
DS		 378
379/*
380 * Sometimes #defines create maximum values that
381 * need to have strings created from them that
382 * allow the parser to match against them.
383 * These macros allow that.
384 */
385#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
386#define CMD_CREATE_STR_HELPER(s) #s
6319fd63 387#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b 388
718e3744 389/* Common descriptions. */
390#define SHOW_STR "Show running system information\n"
391#define IP_STR "IP information\n"
392#define IPV6_STR "IPv6 information\n"
31f937fb
SM		 393#define SRTE_STR "SR-TE information\n"
394#define SRTE_COLOR_STR "SR-TE Color information\n"
718e3744 395#define NO_STR "Negate a command or set its defaults\n"
11ca3587 396#define IGNORED_IN_NO_STR "Ignored value in no form\n"
9c42a6eb 397#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744 398#define CLEAR_STR "Reset functions\n"
399#define RIP_STR "RIP information\n"
7f57883e 400#define EIGRP_STR "EIGRP information\n"
718e3744 401#define BGP_STR "BGP information\n"
e0bce756
DS		 402#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
403#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
404#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
405#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744 406#define OSPF_STR "OSPF information\n"
407#define NEIGHBOR_STR "Specify neighbor router\n"
ef7eec74 408#define DEBUG_STR "Debugging functions\n"
718e3744 409#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
410#define ROUTER_STR "Enable a routing process\n"
411#define AS_STR "AS number\n"
377e3565 412#define MAC_STR "MAC address\n"
718e3744 413#define MBGP_STR "MBGP information\n"
414#define MATCH_STR "Match values from routing table\n"
415#define SET_STR "Set values in destination routing protocol\n"
416#define OUT_STR "Filter outgoing routing updates\n"
417#define IN_STR "Filter incoming routing updates\n"
418#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
419#define OSPF6_NUMBER_STR "Specify by number\n"
0437e105 420#define INTERFACE_STR "Interface information\n"
718e3744 421#define IFNAME_STR "Interface name(e.g. ep0)\n"
422#define IP6_STR "IPv6 Information\n"
423#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c 424#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b 425#define SECONDS_STR "Seconds\n"
718e3744 426#define ROUTE_STR "Routing Table\n"
427#define PREFIX_LIST_STR "Build a prefix list\n"
d62a17ae 428#define OSPF6_DUMP_TYPE_LIST \
429 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
9e867fe6 430#define AREA_TAG_STR "[area tag]\n"
d0bfb22c 431#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
07b37df9
DA		 432#define COMMUNITY_VAL_STR \
433 "Community number in AA:NN format (where AA and NN are (0-65535)) or local-AS|no-advertise|no-export|internet|graceful-shutdown|accept-own-nexthop|accept-own|route-filter-translated-v4|route-filter-v4|route-filter-translated-v6|route-filter-v6|llgr-stale|no-llgr|blackhole|no-peer or additive\n"
16f1b9ee
OD		 434#define MPLS_TE_STR "MPLS-TE specific commands\n"
435#define LINK_PARAMS_STR "Configure interface link parameters\n"
436#define OSPF_RI_STR "OSPF Router Information specific commands\n"
437#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3 438#define MPLS_STR "MPLS information\n"
cf9b9f77 439#define SR_STR "Segment-Routing specific commands\n"
dff13b6f 440#define WATCHFRR_STR "watchfrr information\n"
41e7fb80 441#define ZEBRA_STR "Zebra information\n"
f73126c3 442#define FILTER_LOG_STR "Filter Logs\n"
d40d6c22
RZ		 443#define BFD_PROFILE_STR "BFD profile.\n"
444#define BFD_PROFILE_NAME_STR "BFD profile name.\n"
478ff17b 445#define SHARP_STR "Sharp Routing Protocol\n"
10514170
RW		 446#define OSPF_GR_STR \
447 "OSPF non-stop forwarding (NSF) also known as OSPF Graceful Restart\n"
718e3744 448
093e3f23 449#define CMD_VNI_RANGE "(1-16777215)"
718e3744 450#define CONF_BACKUP_EXT ".sav"
24e7c5c8
KS		 451#define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC\n"
452#define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC\n"
453#define MPLS_LDP_SYNC_HOLDDOWN_STR \
454 "Time to wait for LDP-SYNC to occur before restoring if cost\n"
455#define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable\n"
718e3744 456
4911ca9c
PM		 457/* Command warnings. */
458#define NO_PASSWD_CMD_WARNING \
459 "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
460
718e3744 461/* IPv4 only machine should not accept IPv6 address for peer's IP
462 address. So we replace VTY command string like below. */
718e3744 463#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece
DS		 464#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
465#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744 466
b0965c44 467/* Graceful Restart cli help strings */
b0965c44 468#define GR_CMD "Global Graceful Restart command\n"
469#define NO_GR_CMD "Undo Global Graceful Restart command\n"
470#define GR "Global Graceful Restart - GR Mode\n"
471#define GR_DISABLE "Global Graceful Restart - Disable Mode\n"
472#define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode\n"
473#define GR_DEBUG "Graceful Restart - Enable Debug Logs\n"
474#define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode\n"
475#define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor\n"
476#define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor\n"
477#define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor\n"
478#define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor\n"
479#define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor\n"
480#define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor\n"
481
3717389c
SW		 482/* EVPN help Strings */
483#define EVPN_RT_HELP_STR "EVPN route information\n"
484#define EVPN_RT_DIST_HELP_STR "Route Distinguisher\n"
485#define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX\n"
486#define EVPN_TYPE_HELP_STR "Specify Route type\n"
487#define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route\n"
488#define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route\n"
489#define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route\n"
490#define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route\n"
491#define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route\n"
247fb57d
SW		 492#define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
493#define EVPN_TYPE_ALL_LIST_HELP_STR \
494 EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR \
495 EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR \
496 EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR \
497 EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR \
498 EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
499
3717389c 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
512#ifndef VTYSH_EXTRACT_PL
513#define install_element(node_type_, cmd_element_) do { \
514 static const struct xref_install_element _xref \
515 __attribute__((used)) = { \
516 .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL, \
517 __func__), \
518 .cmd_element = cmd_element_, \
519 .node_type = node_type_, \
520 }; \
521 XREF_LINK(_xref.xref); \
522 _install_element(node_type_, cmd_element_); \
523 } while (0)
524#endif
525
526extern void _install_element(enum node_type, const struct cmd_element *);
718e3744 527
de8f7a39
DL		 528/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
529 * deprecated/hidden) are not reversed. */
154e9ca1 530extern void uninstall_element(enum node_type, const struct cmd_element *);
de8f7a39 531
0e06eb8b
DL		 532/* construct CLI tree only when entering nodes */
533extern void cmd_defer_tree(bool val);
534
535/* finish CLI tree for node when above is true (noop otherwise) */
536extern void cmd_finalize_node(struct cmd_node *node);
537
f6834d4c 538/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
539 string with a space between each element (allocated using
540 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d62a17ae 541extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
b286ddb0
DS		 542
543/*
544 * It is preferred that you set the index initial value
545 * to a 0. This way in the future if you modify the
546 * cli then there is no need to modify the initial
547 * value of the index
548 */
d62a17ae 549extern int argv_find(struct cmd_token **argv, int argc, const char *text,
550 int *index);
551
552extern vector cmd_make_strvec(const char *);
553extern void cmd_free_strvec(vector);
554extern vector cmd_describe_command(vector, struct vty *, int *status);
555extern char **cmd_complete_command(vector, struct vty *, int *status);
556extern const char *cmd_prompt(enum node_type);
557extern int command_config_read_one_line(struct vty *vty,
558 const struct cmd_element **,
7ab57d19 559 uint32_t line_num, int use_config_node);
d62a17ae 560extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
561extern enum node_type node_parent(enum node_type);
01e24c4a
QY		 562/*
563 * Execute command under the given vty context.
564 *
565 * vty
566 * The vty context to execute under.
567 *
568 * cmd
569 * The command string to execute.
570 *
571 * matched
572 * If non-null and a match was found, the address of the matched command is
573 * stored here. No action otherwise.
574 *
575 * vtysh
576 * Whether or not this is being called from vtysh. If this is nonzero,
577 * XXX: then what?
578 *
579 * Returns:
580 * XXX: what does it return
581 */
582extern int cmd_execute(struct vty *vty, const char *cmd,
583 const struct cmd_element **matched, int vtysh);
d62a17ae 584extern int cmd_execute_command(vector, struct vty *,
585 const struct cmd_element **, int);
586extern int cmd_execute_command_strict(vector, struct vty *,
587 const struct cmd_element **);
f8e6ada8 588extern void cmd_init(int terminal);
62b43962
IR		 589extern void cmd_init_config_callbacks(void (*start_config_cb)(void),
590 void (*end_config_cb)(void));
d62a17ae 591extern void cmd_terminate(void);
592extern void cmd_exit(struct vty *vty);
593extern int cmd_list_cmds(struct vty *vty, int do_permute);
c2278962 594extern int cmd_find_cmds(struct vty *vty, struct cmd_token **argv, int argc);
d62a17ae 595
6b3ee3a0 596extern int cmd_domainname_set(const char *domainname);
d62a17ae 597extern int cmd_hostname_set(const char *hostname);
6b3ee3a0
MK		 598extern const char *cmd_hostname_get(void);
599extern const char *cmd_domainname_get(void);
bff9c3e9 600
af2567b6 601/* NOT safe for general use; call this only if DEV_BUILD! */
d62a17ae 602extern void grammar_sandbox_init(void);
af2567b6 603
d62a17ae 604extern vector completions_to_vec(struct list *completions);
2ab40270 605
718e3744 606/* Export typical functions. */
d62a17ae 607extern const char *host_config_get(void);
608extern void host_config_set(const char *);
6590f2c3 609
d62a17ae 610extern void print_version(const char *);
86228fde 611
d62a17ae 612extern int cmd_banner_motd_file(const char *);
19d61463 613extern void cmd_banner_motd_line(const char *line);
7cfc61d3 614
86228fde 615/* struct host global, ick */
d0bfb22c
QY		 616extern struct host host;
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
RW		 630
631#ifdef __cplusplus
632}
633#endif
634
718e3744 635#endif /* _ZEBRA_COMMAND_H */
FRRouting mirror