]>
git.proxmox.com Git - mirror_frr.git/blob - lib/command.h
2 * Zebra configuration command interface routine
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
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.
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.
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
22 #ifndef _ZEBRA_COMMAND_H
23 #define _ZEBRA_COMMAND_H
27 #include "lib/route_types.h"
31 #include "command_graph.h"
34 DECLARE_MTYPE ( COMPLETION
)
36 /* Host configuration variable */
38 /* Host name of this router. */
41 /* Domainname of this router */
44 /* Password for vty interface. */
46 char * password_encrypt
;
52 /* System wide terminal lines. */
58 /* config file name of this host */
62 /* Flags for services */
66 /* Banner configuration. */
71 /* List of CLI nodes. Please remember to update the name array in command.c. */
73 AUTH_NODE
, /* Authentication mode of vty interface. */
74 VIEW_NODE
, /* View node. Default mode of vty interface. */
75 AUTH_ENABLE_NODE
, /* Authentication mode for change enable. */
76 ENABLE_NODE
, /* Enable node. */
77 CONFIG_NODE
, /* Config node. Default mode of config file. */
78 DEBUG_NODE
, /* Debug node. */
79 VRF_DEBUG_NODE
, /* Vrf Debug node. */
80 NORTHBOUND_DEBUG_NODE
, /* Northbound Debug node. */
81 DEBUG_VNC_NODE
, /* Debug VNC node. */
82 AAA_NODE
, /* AAA node. */
83 KEYCHAIN_NODE
, /* Key-chain node. */
84 KEYCHAIN_KEY_NODE
, /* Key-chain key node. */
85 LOGICALROUTER_NODE
, /* Logical-Router node. */
86 IP_NODE
, /* Static ip route node. */
87 VRF_NODE
, /* VRF mode node. */
88 INTERFACE_NODE
, /* Interface mode node. */
89 NH_GROUP_NODE
, /* Nexthop-Group mode node. */
90 ZEBRA_NODE
, /* zebra connection node. */
91 TABLE_NODE
, /* rtm_table selection node. */
92 RIP_NODE
, /* RIP protocol mode node. */
93 RIPNG_NODE
, /* RIPng protocol mode node. */
94 BABEL_NODE
, /* BABEL protocol mode node. */
95 EIGRP_NODE
, /* EIGRP protocol mode node. */
96 BGP_NODE
, /* BGP protocol mode which includes BGP4+ */
97 BGP_VPNV4_NODE
, /* BGP MPLS-VPN PE exchange. */
98 BGP_VPNV6_NODE
, /* BGP MPLS-VPN PE exchange. */
99 BGP_IPV4_NODE
, /* BGP IPv4 unicast address family. */
100 BGP_IPV4M_NODE
, /* BGP IPv4 multicast address family. */
101 BGP_IPV4L_NODE
, /* BGP IPv4 labeled unicast address family. */
102 BGP_IPV6_NODE
, /* BGP IPv6 address family */
103 BGP_IPV6M_NODE
, /* BGP IPv6 multicast address family. */
104 BGP_IPV6L_NODE
, /* BGP IPv6 labeled unicast address family. */
105 BGP_VRF_POLICY_NODE
, /* BGP VRF policy */
106 BGP_VNC_DEFAULTS_NODE
, /* BGP VNC nve defaults */
107 BGP_VNC_NVE_GROUP_NODE
, /* BGP VNC nve group */
108 BGP_VNC_L2_GROUP_NODE
, /* BGP VNC L2 group */
109 RFP_DEFAULTS_NODE
, /* RFP defaults node */
110 BGP_EVPN_NODE
, /* BGP EVPN node. */
111 OSPF_NODE
, /* OSPF protocol mode */
112 OSPF6_NODE
, /* OSPF protocol for IPv6 mode */
113 LDP_NODE
, /* LDP protocol mode */
114 LDP_IPV4_NODE
, /* LDP IPv4 address family */
115 LDP_IPV6_NODE
, /* LDP IPv6 address family */
116 LDP_IPV4_IFACE_NODE
, /* LDP IPv4 Interface */
117 LDP_IPV6_IFACE_NODE
, /* LDP IPv6 Interface */
118 LDP_L2VPN_NODE
, /* LDP L2VPN node */
119 LDP_PSEUDOWIRE_NODE
, /* LDP Pseudowire node */
120 ISIS_NODE
, /* ISIS protocol mode */
121 ACCESS_NODE
, /* Access list node. */
122 PREFIX_NODE
, /* Prefix list node. */
123 ACCESS_IPV6_NODE
, /* Access list node. */
124 ACCESS_MAC_NODE
, /* MAC access list node*/
125 PREFIX_IPV6_NODE
, /* Prefix list node. */
126 AS_LIST_NODE
, /* AS list node. */
127 COMMUNITY_LIST_NODE
, /* Community list node. */
128 RMAP_NODE
, /* Route map node. */
129 PBRMAP_NODE
, /* PBR map node. */
130 SMUX_NODE
, /* SNMP configuration node. */
131 DUMP_NODE
, /* Packet dump node. */
132 FORWARDING_NODE
, /* IP forwarding node. */
133 PROTOCOL_NODE
, /* protocol filtering node */
134 MPLS_NODE
, /* MPLS config node */
135 PW_NODE
, /* Pseudowire config node */
136 VTY_NODE
, /* Vty node. */
137 LINK_PARAMS_NODE
, /* Link-parameters node */
138 BGP_EVPN_VNI_NODE
, /* BGP EVPN VNI */
139 RPKI_NODE
, /* RPKI node for configuration of RPKI cache server
141 BGP_FLOWSPECV4_NODE
, /* BGP IPv4 FLOWSPEC Address-Family */
142 BGP_FLOWSPECV6_NODE
, /* BGP IPv6 FLOWSPEC Address-Family */
143 BFD_NODE
, /* BFD protocol mode. */
144 BFD_PEER_NODE
, /* BFD peer configuration mode. */
145 OPENFABRIC_NODE
, /* OpenFabric router configuration node */
146 NODE_TYPE_MAX
, /* maximum */
149 extern vector cmdvec
;
150 extern const struct message tokennames
[];
151 extern const char * node_names
[];
153 /* Node which has some commands and prompt string and configuration
154 function pointer . */
159 /* Prompt character at vty interface. */
162 /* Is this node's configuration goes to vtysh ? */
165 /* Node's configuration write function */
166 int (* func
)( struct vty
*);
168 /* Node's command graph */
169 struct graph
* cmdgraph
;
171 /* Vector of this node's command list. */
174 /* Hashed index of command node list, for de-dupping primarily */
175 struct hash
* cmd_hash
;
178 /* Return value of the commands. */
179 #define CMD_SUCCESS 0
180 #define CMD_WARNING 1
181 #define CMD_ERR_NO_MATCH 2
182 #define CMD_ERR_AMBIGUOUS 3
183 #define CMD_ERR_INCOMPLETE 4
184 #define CMD_ERR_EXEED_ARGC_MAX 5
185 #define CMD_ERR_NOTHING_TODO 6
186 #define CMD_COMPLETE_FULL_MATCH 7
187 #define CMD_COMPLETE_MATCH 8
188 #define CMD_COMPLETE_LIST_MATCH 9
189 #define CMD_SUCCESS_DAEMON 10
190 #define CMD_ERR_NO_FILE 11
191 #define CMD_SUSPEND 12
192 #define CMD_WARNING_CONFIG_FAILED 13
193 #define CMD_NOT_MY_INSTANCE 14
195 /* Argc max counts. */
196 #define CMD_ARGC_MAX 256
198 /* Turn off these macros when uisng cpp with extract.pl */
199 #ifndef VTYSH_EXTRACT_PL
201 /* helper defines for end-user DEFUN* macros */
202 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
203 static struct cmd_element cmdname = { \
212 #define DEFUN_CMD_FUNC_DECL(funcname) \
213 static int funcname(const struct cmd_element *, struct vty *, int, \
214 struct cmd_token *[]);
216 #define DEFUN_CMD_FUNC_TEXT(funcname) \
217 static int funcname(const struct cmd_element *self \
218 __attribute__((unused)), \
219 struct vty *vty __attribute__((unused)), \
220 int argc __attribute__((unused)), \
221 struct cmd_token *argv[] __attribute__((unused)))
223 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
224 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
227 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
228 DEFPY(funcname, cmdname, cmdstr, helpstr)
230 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
231 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
234 #define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
235 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
237 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
238 DEFUN_CMD_FUNC_DECL(funcname) \
239 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
240 DEFUN_CMD_FUNC_TEXT(funcname)
242 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
243 DEFUN_CMD_FUNC_DECL(funcname) \
244 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
245 DEFUN_CMD_FUNC_TEXT(funcname)
247 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
248 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
250 /* DEFUN_NOSH for commands that vtysh should ignore */
251 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
252 DEFUN(funcname, cmdname, cmdstr, helpstr)
254 /* DEFSH for vtysh. */
255 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
256 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
258 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
259 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
263 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
264 DEFUN_CMD_FUNC_DECL(funcname) \
265 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
266 DEFUN_CMD_FUNC_TEXT(funcname)
268 /* DEFUN + DEFSH with attributes */
269 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
270 DEFUN_CMD_FUNC_DECL(funcname) \
271 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
272 DEFUN_CMD_FUNC_TEXT(funcname)
274 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
275 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
278 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
279 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
282 /* ALIAS macro which define existing command's alias. */
283 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
284 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
286 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
287 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
289 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
290 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
293 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
294 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
295 CMD_ATTR_DEPRECATED, 0)
297 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
298 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
300 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
301 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
304 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
305 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
306 CMD_ATTR_DEPRECATED, daemon)
308 #else /* VTYSH_EXTRACT_PL */
309 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
310 DEFUN(funcname, cmdname, cmdstr, helpstr)
312 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
313 DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)
315 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
316 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
317 #endif /* VTYSH_EXTRACT_PL */
322 * Sometimes #defines create maximum values that
323 * need to have strings created from them that
324 * allow the parser to match against them.
325 * These macros allow that.
327 #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
328 #define CMD_CREATE_STR_HELPER(s) #s
329 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
331 /* Common descriptions. */
332 #define SHOW_STR "Show running system information \n "
333 #define IP_STR "IP information \n "
334 #define IPV6_STR "IPv6 information \n "
335 #define NO_STR "Negate a command or set its defaults \n "
336 #define REDIST_STR "Redistribute information from another routing protocol \n "
337 #define CLEAR_STR "Reset functions \n "
338 #define RIP_STR "RIP information \n "
339 #define EIGRP_STR "EIGRP information \n "
340 #define BGP_STR "BGP information \n "
341 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates \n "
342 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound' \n "
343 #define BGP_SOFT_OUT_STR "Resend all outbound updates \n "
344 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB \n "
345 #define OSPF_STR "OSPF information \n "
346 #define NEIGHBOR_STR "Specify neighbor router \n "
347 #define DEBUG_STR "Debugging functions \n "
348 #define UNDEBUG_STR "Disable debugging functions (see also 'debug') \n "
349 #define ROUTER_STR "Enable a routing process \n "
350 #define AS_STR "AS number \n "
351 #define MAC_STR "MAC address \n "
352 #define MBGP_STR "MBGP information \n "
353 #define MATCH_STR "Match values from routing table \n "
354 #define SET_STR "Set values in destination routing protocol \n "
355 #define OUT_STR "Filter outgoing routing updates \n "
356 #define IN_STR "Filter incoming routing updates \n "
357 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0) \n "
358 #define OSPF6_NUMBER_STR "Specify by number \n "
359 #define INTERFACE_STR "Interface information \n "
360 #define IFNAME_STR "Interface name(e.g. ep0) \n "
361 #define IP6_STR "IPv6 Information \n "
362 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6 \n "
363 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID \n "
364 #define SECONDS_STR "Seconds \n "
365 #define ROUTE_STR "Routing Table \n "
366 #define PREFIX_LIST_STR "Build a prefix list \n "
367 #define OSPF6_DUMP_TYPE_LIST \
368 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
369 #define AREA_TAG_STR "[area tag] \n "
370 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535) \n "
371 #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 "
372 #define MPLS_TE_STR "MPLS-TE specific commands \n "
373 #define LINK_PARAMS_STR "Configure interface link parameters \n "
374 #define OSPF_RI_STR "OSPF Router Information specific commands \n "
375 #define PCE_STR "PCE Router Information specific commands \n "
376 #define MPLS_STR "MPLS information \n "
377 #define SR_STR "Segment-Routing specific commands \n "
378 #define WATCHFRR_STR "watchfrr information \n "
379 #define ZEBRA_STR "Zebra information \n "
381 #define CMD_VNI_RANGE "(1-16777215)"
382 #define CONF_BACKUP_EXT ".sav"
384 /* Command warnings. */
385 #define NO_PASSWD_CMD_WARNING \
386 "Please be aware that removing the password is a security risk and you should think twice about this command. \n "
388 /* IPv4 only machine should not accept IPv6 address for peer's IP
389 address. So we replace VTY command string like below. */
390 #define NEIGHBOR_ADDR_STR "Neighbor address \n IPv6 address \n "
391 #define NEIGHBOR_ADDR_STR2 "Neighbor address \n Neighbor IPv6 address \n Interface name or neighbor tag \n "
392 #define NEIGHBOR_ADDR_STR3 "Neighbor address \n IPv6 address \n Interface name \n "
395 extern void install_node ( struct cmd_node
*, int (*)( struct vty
*));
396 extern void install_default ( enum node_type
);
397 extern void install_element ( enum node_type
, struct cmd_element
*);
399 /* known issue with uninstall_element: changes to cmd_token->attr (i.e.
400 * deprecated/hidden) are not reversed. */
401 extern void uninstall_element ( enum node_type
, struct cmd_element
*);
403 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
404 string with a space between each element (allocated using
405 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
406 extern char * argv_concat ( struct cmd_token
** argv
, int argc
, int shift
);
409 * It is preferred that you set the index initial value
410 * to a 0. This way in the future if you modify the
411 * cli then there is no need to modify the initial
414 extern int argv_find ( struct cmd_token
** argv
, int argc
, const char * text
,
417 extern vector
cmd_make_strvec ( const char *);
418 extern void cmd_free_strvec ( vector
);
419 extern vector
cmd_describe_command ( vector
, struct vty
*, int * status
);
420 extern char ** cmd_complete_command ( vector
, struct vty
*, int * status
);
421 extern const char * cmd_prompt ( enum node_type
);
422 extern int command_config_read_one_line ( struct vty
* vty
,
423 const struct cmd_element
**,
424 uint32_t line_num
, int use_config_node
);
425 extern int config_from_file ( struct vty
*, FILE *, unsigned int * line_num
);
426 extern enum node_type
node_parent ( enum node_type
);
428 * Execute command under the given vty context.
431 * The vty context to execute under.
434 * The command string to execute.
437 * If non-null and a match was found, the address of the matched command is
438 * stored here. No action otherwise.
441 * Whether or not this is being called from vtysh. If this is nonzero,
445 * XXX: what does it return
447 extern int cmd_execute ( struct vty
* vty
, const char * cmd
,
448 const struct cmd_element
** matched
, int vtysh
);
449 extern int cmd_execute_command ( vector
, struct vty
*,
450 const struct cmd_element
**, int );
451 extern int cmd_execute_command_strict ( vector
, struct vty
*,
452 const struct cmd_element
**);
453 extern void cmd_init ( int );
454 extern void cmd_terminate ( void );
455 extern void cmd_exit ( struct vty
* vty
);
456 extern int cmd_list_cmds ( struct vty
* vty
, int do_permute
);
458 extern int cmd_domainname_set ( const char * domainname
);
459 extern int cmd_hostname_set ( const char * hostname
);
460 extern const char * cmd_hostname_get ( void );
461 extern const char * cmd_domainname_get ( void );
463 /* NOT safe for general use; call this only if DEV_BUILD! */
464 extern void grammar_sandbox_init ( void );
466 extern vector
completions_to_vec ( struct list
* completions
);
468 /* Export typical functions. */
469 extern const char * host_config_get ( void );
470 extern void host_config_set ( const char *);
472 extern void print_version ( const char *);
474 extern int cmd_banner_motd_file ( const char *);
476 /* struct host global, ick */
477 extern struct host host
;
479 struct cmd_variable_handler
{
480 const char * tokenname
, * varname
;
481 void (* completions
)( vector out
, struct cmd_token
* token
);
484 extern void cmd_variable_complete ( struct cmd_token
* token
, const char * arg
,
487 cmd_variable_handler_register ( const struct cmd_variable_handler
* cvh
);
488 extern char * cmd_variable_comp2str ( vector comps
, unsigned short cols
);
490 extern void command_setup_early_logging ( const char * dest
, const char * level
);
491 #endif /* _ZEBRA_COMMAND_H */