libosmovty  1.5.1
Osmocom VTY library
command.h
Go to the documentation of this file.
1 
3 /*
4  * Copyright (C) 1997, 98 Kunihiro Ishiguro
5  *
6  * This file is part of GNU Zebra.
7  *
8  * GNU Zebra is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published
10  * by the Free Software Foundation; either version 2, or (at your
11  * option) any later version.
12  *
13  * GNU Zebra is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with GNU Zebra; see the file COPYING. If not, write to the
20  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23 
24 #pragma once
25 
26 #include <stdio.h>
27 #include <stdbool.h>
28 #include <sys/types.h>
29 #include "vector.h"
30 
31 #include <osmocom/core/defs.h>
32 #include <osmocom/core/utils.h>
33 
39 struct host {
41  char *name;
42 
44  char *password;
46 
48  char *enable;
50 
52  int lines;
53 
55  char *logfile;
56 
58  char *config;
59 
61  int advanced;
62  int encrypt;
63 
65  const char *motd;
66  char *motdfile;
67 
69  const struct vty_app_info *app_info;
70 };
71 
73 enum node_type {
105  /*
106  * When adding new nodes to the libosmocore project, these nodes can be
107  * used to avoid ABI changes for unrelated projects.
108  */
112 };
113 
114 #include "vty.h"
115 
118 struct cmd_node {
120  int node;
121 
123  const char *prompt;
124 
126  int vtysh;
127 
129  int (*func) (struct vty *);
130 
133 
137  char name[64];
138 };
139 
141 enum {
143  CMD_ATTR_HIDDEN = (1 << 1),
144  CMD_ATTR_IMMEDIATE = (1 << 2),
145  CMD_ATTR_NODE_EXIT = (1 << 3),
147 };
148 
150 enum {
151  /* The entries of this enum shall conform the following requirements:
152  * 1. Naming format: 'OSMO_' + <LIBNAME> + '_LIB_ATTR_' + <ATTRNAME>,
153  * where LIBNAME is a short name of the library, e.g. 'ABIS', 'MGCP',
154  * and ATTRNAME is a brief name of the attribute, e.g. RTP_CONN_EST;
155  * for example: 'OSMO_ABIS_LIB_ATTR_RSL_LINK_UP'.
156  * 2. Brevity: shortenings and abbreviations are welcome!
157  * 3. Values are not flags but indexes, unlike CMD_ATTR_*.
158  * 4. Ordering: new entries added before _OSMO_CORE_LIB_ATTR_COUNT. */
162 
163  /* Keep this floating entry last, it's needed for count check. */
165 };
166 
168 struct cmd_element {
169  const char *string;
170  int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
171  const char *doc;
172  int daemon;
174  unsigned int cmdsize;
175  char *config;
177  unsigned char attr;
178  unsigned int usrattr;
179 };
180 
182 struct desc {
183  const char *cmd;
184  const char *str;
185 };
186 
188 #define CMD_SUCCESS 0
189 #define CMD_WARNING 1
190 #define CMD_ERR_NO_MATCH 2
191 #define CMD_ERR_AMBIGUOUS 3
192 #define CMD_ERR_INCOMPLETE 4
193 #define CMD_ERR_EXEED_ARGC_MAX 5
194 #define CMD_ERR_NOTHING_TODO 6
195 #define CMD_COMPLETE_FULL_MATCH 7
196 #define CMD_COMPLETE_MATCH 8
197 #define CMD_COMPLETE_LIST_MATCH 9
198 #define CMD_SUCCESS_DAEMON 10
199 #define CMD_ERR_INVALID_INDENT 11
200 
201 /* Argc max counts. */
202 #define CMD_ARGC_MAX 256
203 
204 /* Turn off these macros when uisng cpp with extract.pl */
205 #ifndef VTYSH_EXTRACT_PL
206 
207 /* helper defines for end-user DEFUN* macros */
208 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
209  static struct cmd_element cmdname = \
210  { \
211  .string = cmdstr, \
212  .func = funcname, \
213  .doc = helpstr, \
214  .attr = attrs, \
215  .daemon = dnum, \
216  };
217 
218 /* global (non static) cmd_element */
219 #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
220  struct cmd_element cmdname = \
221  { \
222  .string = cmdstr, \
223  .func = funcname, \
224  .doc = helpstr, \
225  .attr = attrs, \
226  .daemon = dnum, \
227  };
228 
229 #define DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attrs, usrattrs) \
230  static struct cmd_element cmdname = \
231  { \
232  .string = cmdstr, \
233  .func = funcname, \
234  .doc = helpstr, \
235  .attr = attrs, \
236  .usrattr = usrattrs, \
237  };
238 
239 #define DEFUN_CMD_FUNC_DECL(funcname) \
240  static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
241 
242 #define DEFUN_CMD_FUNC_TEXT(funcname) \
243  static int funcname \
244  (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
245 
252 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
253  DEFUN_CMD_FUNC_DECL(funcname) \
254  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
255  DEFUN_CMD_FUNC_TEXT(funcname)
256 
263 #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \
264  DEFUN_CMD_FUNC_DECL(funcname) \
265  gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
266  DEFUN_CMD_FUNC_TEXT(funcname)
267 
268 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
269  DEFUN_CMD_FUNC_DECL(funcname) \
270  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
271  DEFUN_CMD_FUNC_TEXT(funcname)
272 
273 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
274  DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
275 
276 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
277  DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
278 
287 #define DEFUN_ATTR_USRATTR(funcname, cmdname, attr, usrattr, cmdstr, helpstr) \
288  DEFUN_CMD_FUNC_DECL(funcname) \
289  DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attr, usrattr) \
290  DEFUN_CMD_FUNC_TEXT(funcname)
291 
292 #define DEFUN_USRATTR(funcname, cmdname, usrattr, cmdstr, helpstr) \
293  DEFUN_ATTR_USRATTR(funcname, cmdname, 0, usrattr, cmdstr, helpstr)
294 
295 /* DEFUN_NOSH for commands that vtysh should ignore */
296 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
297  DEFUN(funcname, cmdname, cmdstr, helpstr)
298 
299 /* DEFSH for vtysh. */
300 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
301  DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
302 
303 /* DEFUN + DEFSH */
304 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
305  DEFUN_CMD_FUNC_DECL(funcname) \
306  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
307  DEFUN_CMD_FUNC_TEXT(funcname)
308 
309 /* DEFUN + DEFSH with attributes */
310 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
311  DEFUN_CMD_FUNC_DECL(funcname) \
312  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
313  DEFUN_CMD_FUNC_TEXT(funcname)
314 
315 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
316  DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
317 
318 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
319  DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
320 
321 /* ALIAS macro which define existing command's alias. */
322 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
323  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
324 
325 /* global (non static) cmd_element */
326 #define gALIAS(funcname, cmdname, cmdstr, helpstr) \
327  gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
328 
329 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
330  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
331 
332 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
333  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
334 
335 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
336  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
337 
338 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
339  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
340 
341 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
342  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
343 
344 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
345  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
346 
347 #endif /* VTYSH_EXTRACT_PL */
348 
349 /* Some macroes */
350 #define CMD_OPTION(S) ((S[0]) == '[')
351 #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
352 #define CMD_VARARG(S) ((S[0]) == '.')
353 #define CMD_RANGE(S) ((S[0] == '<'))
354 
355 #define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
356 #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
357 #define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
358 #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
359 
360 #define VTY_IPV4_CMD "A.B.C.D"
361 #define VTY_IPV6_CMD "X:X::X:X"
362 #define VTY_IPV46_CMD "(" VTY_IPV4_CMD "|" VTY_IPV6_CMD ")"
363 
364 /* Common descriptions. */
365 #define SHOW_STR "Show running system information\n"
366 #define IP_STR "IP information\n"
367 #define IPV6_STR "IPv6 information\n"
368 #define NO_STR "Negate a command or set its defaults\n"
369 #define CLEAR_STR "Reset functions\n"
370 #define RIP_STR "RIP information\n"
371 #define BGP_STR "BGP information\n"
372 #define OSPF_STR "OSPF information\n"
373 #define NEIGHBOR_STR "Specify neighbor router\n"
374 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
375 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
376 #define ROUTER_STR "Enable a routing process\n"
377 #define AS_STR "AS number\n"
378 #define MBGP_STR "MBGP information\n"
379 #define MATCH_STR "Match values from routing table\n"
380 #define SET_STR "Set values in destination routing protocol\n"
381 #define OUT_STR "Filter outgoing routing updates\n"
382 #define IN_STR "Filter incoming routing updates\n"
383 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
384 #define OSPF6_NUMBER_STR "Specify by number\n"
385 #define INTERFACE_STR "Interface infomation\n"
386 #define IFNAME_STR "Interface name(e.g. ep0)\n"
387 #define IP6_STR "IPv6 Information\n"
388 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
389 #define OSPF6_ROUTER_STR "Enable a routing process\n"
390 #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
391 #define SECONDS_STR "<1-65535> Seconds\n"
392 #define ROUTE_STR "Routing Table\n"
393 #define PREFIX_LIST_STR "Build a prefix list\n"
394 #define OSPF6_DUMP_TYPE_LIST \
395 "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
396 #define ISIS_STR "IS-IS information\n"
397 #define AREA_TAG_STR "[area tag]\n"
398 
399 #define CONF_BACKUP_EXT ".sav"
400 
401 /* IPv4 only machine should not accept IPv6 address for peer's IP
402  address. So we replace VTY command string like below. */
403 #ifdef HAVE_IPV6
404 #define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
405 #define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
406 #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
407 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
408 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
409 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
410 #else
411 #define NEIGHBOR_CMD "neighbor A.B.C.D "
412 #define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
413 #define NEIGHBOR_ADDR_STR "Neighbor address\n"
414 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
415 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
416 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
417 #endif /* HAVE_IPV6 */
418 
419 /* Prototypes. */
420 void install_node(struct cmd_node *, int (*)(struct vty *));
421 void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
422 void install_element(int node_type, struct cmd_element *);
423 void install_lib_element(int node_type, struct cmd_element *);
424 void install_element_ve(struct cmd_element *cmd);
425 void install_lib_element_ve(struct cmd_element *cmd);
426 void sort_node(void);
427 
428 void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
429 
430 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
431  string with a space between each element (allocated using
432  XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
433 char *argv_concat(const char **argv, int argc, int shift);
434 
435 vector cmd_make_strvec(const char *);
436 int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p);
437 void cmd_free_strvec(vector);
440 const char *cmd_prompt(enum node_type);
441 int config_from_file(struct vty *, FILE *);
442 enum node_type node_parent(enum node_type);
443 int cmd_execute_command(vector, struct vty *, struct cmd_element **, int);
444 int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **);
445 void config_replace_string(struct cmd_element *, char *, ...);
446 void cmd_init(int);
447 
448 /* Export typical functions. */
449 extern struct cmd_element config_exit_cmd;
450 extern struct cmd_element config_help_cmd;
451 extern struct cmd_element config_list_cmd;
452 extern struct cmd_element config_end_cmd;
454 void host_config_set(const char *);
455 
456 char *osmo_asciidoc_escape(const char *inp);
457 
458 /* This is called from main when a daemon is invoked with -v or --version. */
459 void print_version(int print_copyright);
460 
461 extern void *tall_vty_cmd_ctx;
462 
471 };
472 
473 extern const struct value_string vty_ref_gen_mode_names[];
474 extern const struct value_string vty_ref_gen_mode_desc[];
475 
476 int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode);
477 int vty_dump_xml_ref(FILE *stream) OSMO_DEPRECATED("Use vty_dump_xml_ref_mode() instead");
478 
argv
Definition: tdef_vty.c:299
argc
Definition: tdef_vty.c:299
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:119
struct cmd_element config_exit_cmd
enum node_type node_parent(enum node_type)
void install_lib_element_ve(struct cmd_element *cmd)
Definition: command.c:1009
struct cmd_element config_help_cmd
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:1002
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2625
void cmd_free_strvec(vector)
Free allocated string vector.
Definition: command.c:323
int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode)
Print the XML reference of all VTY nodes to the given stream.
Definition: command.c:916
void host_config_set(const char *)
Definition: command.c:4217
void * tall_vty_cmd_ctx
Definition: command.c:64
struct cmd_element config_end_cmd
void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()")
Deprecated, now happens implicitly when calling install_node().
Definition: command.c:4232
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:974
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:495
int vty_dump_xml_ref(FILE *stream) OSMO_DEPRECATED("Use vty_dump_xml_ref_mode() instead")
Print the XML reference of all VTY nodes to the given stream.
Definition: command.c:949
node_type
There are some command levels which called from command node.
Definition: command.h:73
void install_node(struct cmd_node *, int(*)(struct vty *))
Install top node of command vector.
Definition: command.c:181
vty_ref_gen_mode
VTY reference generation mode.
Definition: command.h:464
void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()")
Deprecated, now happens implicitly when calling install_node().
Definition: command.c:4225
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:315
const struct value_string vty_ref_gen_mode_desc[]
Definition: command.c:904
char ** cmd_complete_command()
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:244
int config_from_file(struct vty *, FILE *)
Definition: command.c:2795
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2659
const struct value_string vty_ref_gen_mode_names[]
Definition: command.c:897
vector cmd_describe_command()
void cmd_init(int)
Definition: command.c:4321
void print_version(int print_copyright)
print the version (and optionally copyright) information
Definition: command.c:110
struct cmd_element config_list_cmd
void sort_node(void)
Sort each node's command element according to command string.
Definition: command.c:205
char * host_config_file()
void config_replace_string(struct cmd_element *, char *,...)
void install_lib_element(int node_type, struct cmd_element *)
Install a library command into a node.
Definition: command.c:995
char * osmo_asciidoc_escape(const char *inp)
escape all special asciidoc symbols
Definition: command.c:508
@ CMD_ATTR_DEPRECATED
Definition: command.h:142
@ CMD_ATTR_LIB_COMMAND
Definition: command.h:146
@ CMD_ATTR_HIDDEN
Definition: command.h:143
@ CMD_ATTR_IMMEDIATE
Definition: command.h:144
@ CMD_ATTR_NODE_EXIT
Definition: command.h:145
@ L_CS7_RTABLE_NODE
SS7 Routing Table.
Definition: command.h:96
@ L_IPA_NODE
IPA proxying commands in libosmo-abis.
Definition: command.h:87
@ L_CS7_LINKSET_NODE
SS7 Linkset.
Definition: command.h:98
@ SERVICE_NODE
Service node.
Definition: command.h:79
@ L_CS7_AS_NODE
SS7 Application Server.
Definition: command.h:93
@ L_CS7_NODE
SS7 root node.
Definition: command.h:92
@ L_CS7_LINK_NODE
SS7 Link.
Definition: command.h:97
@ AUTH_NODE
Authentication mode of vty interface.
Definition: command.h:74
@ L_NS_NODE
NS node in libosmo-gb.
Definition: command.h:88
@ VTY_NODE
Vty node.
Definition: command.h:84
@ CONFIG_NODE
Config node.
Definition: command.h:78
@ L_NS_BIND_NODE
NS bind node.
Definition: command.h:103
@ L_E1INP_NODE
E1 line in libosmo-abis.
Definition: command.h:86
@ DEBUG_NODE
Debug node.
Definition: command.h:80
@ L_CS7_XUA_NODE
SS7 xUA Listener.
Definition: command.h:95
@ CFG_LOG_NODE
Configure the logging.
Definition: command.h:81
@ L_CPU_SCHED_NODE
CPU Sched related options node.
Definition: command.h:102
@ ENABLE_NODE
Enable node.
Definition: command.h:77
@ L_NS_NSE_NODE
NS NSE node.
Definition: command.h:104
@ AUTH_ENABLE_NODE
Authentication mode for change enable.
Definition: command.h:76
@ L_CTRL_NODE
Control interface node.
Definition: command.h:90
@ L_CS7_SCCPADDR_NODE
SS7 SCCP Address.
Definition: command.h:99
@ _LAST_OSMOVTY_NODE
Definition: command.h:111
@ RESERVED3_NODE
Reserved for later extensions.
Definition: command.h:109
@ VIEW_NODE
View node.
Definition: command.h:75
@ L_CS7_SCCPADDR_GT_NODE
SS7 SCCP Global Title.
Definition: command.h:100
@ CFG_STATS_NODE
Configure the statistics.
Definition: command.h:82
@ L_BSSGP_NODE
BSSGP node in libosmo-gb.
Definition: command.h:89
@ L_CS7_ASP_NODE
SS7 Application Server Process.
Definition: command.h:94
@ VTY_REF_GEN_MODE_HIDDEN
"Inverse" mode: only hidden commands.
Definition: command.h:470
@ VTY_REF_GEN_MODE_EXPERT
Expert mode: all commands including hidden, excluding deprecated.
Definition: command.h:468
@ VTY_REF_GEN_MODE_DEFAULT
Default mode: all commands except deprecated and hidden.
Definition: command.h:466
@ OSMO_SCCP_LIB_ATTR_RSTRT_ASP
Definition: command.h:159
@ OSMO_ABIS_LIB_ATTR_IPA_NEW_LNK
Definition: command.h:160
@ _OSMO_CORE_LIB_ATTR_COUNT
Definition: command.h:164
@ OSMO_ABIS_LIB_ATTR_LINE_UPD
Definition: command.h:161
#define OSMO_DEPRECATED(text)
Definition: vector.h:27
Structure of a command element.
Definition: command.h:168
unsigned char attr
Command attributes (global)
Definition: command.h:177
vector strvec
Pointing out each description vector.
Definition: command.h:173
vector subconfig
Sub configuration string.
Definition: command.h:176
int(* func)(struct cmd_element *, struct vty *, int, const char *[])
Definition: command.h:170
const char * string
Command specification by string.
Definition: command.h:169
unsigned int usrattr
Command attributes (program specific)
Definition: command.h:178
char * config
Configuration string.
Definition: command.h:175
unsigned int cmdsize
Command index count.
Definition: command.h:174
const char * doc
Documentation of this command.
Definition: command.h:171
int daemon
Daemon to which this command belong.
Definition: command.h:172
Node which has some commands and prompt string and configuration function pointer .
Definition: command.h:118
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:126
vector cmd_vector
Vector of this node's command list.
Definition: command.h:132
char name[64]
Human-readable ID of this node.
Definition: command.h:137
const char * prompt
Prompt character at vty interface.
Definition: command.h:123
int node
Node index.
Definition: command.h:120
int(* func)(struct vty *)
Node's configuration write function.
Definition: command.h:129
Command description structure.
Definition: command.h:182
const char * cmd
Command string.
Definition: command.h:183
const char * str
Command's description.
Definition: command.h:184
Host configuration variable.
Definition: command.h:39
int lines
System wide terminal lines.
Definition: command.h:52
char * logfile
Log filename.
Definition: command.h:55
char * config
config file name of this host
Definition: command.h:58
const struct vty_app_info * app_info
VTY application information.
Definition: command.h:69
char * password_encrypt
Definition: command.h:45
const char * motd
Banner configuration.
Definition: command.h:65
int encrypt
Definition: command.h:62
char * enable
Enable password.
Definition: command.h:48
char * password
Password for vty interface.
Definition: command.h:44
char * name
Host name of this router.
Definition: command.h:41
int advanced
Flags for services.
Definition: command.h:61
char * enable_encrypt
Definition: command.h:49
char * motdfile
Definition: command.h:66
Information an application registers with the VTY.
Definition: vty.h:182
Internal representation of a single VTY.
Definition: vty.h:73
Generic vector interface header.