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