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