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