libosmovty  1.9.0.130-7f1fb.202401112026
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  */
119 };
120 
121 #include "vty.h"
122 
125 struct cmd_node {
127  int node;
128 
130  const char *prompt;
131 
133  int vtysh;
134 
136  int (*func) (struct vty *);
137 
140 
144  char name[64];
145 };
146 
148 enum {
150  CMD_ATTR_HIDDEN = (1 << 1),
151  CMD_ATTR_IMMEDIATE = (1 << 2),
152  CMD_ATTR_NODE_EXIT = (1 << 3),
154 };
155 
157 enum {
158  /* The entries of this enum shall conform the following requirements:
159  * 1. Naming format: 'OSMO_' + <LIBNAME> + '_LIB_ATTR_' + <ATTRNAME>,
160  * where LIBNAME is a short name of the library, e.g. 'ABIS', 'MGCP',
161  * and ATTRNAME is a brief name of the attribute, e.g. RTP_CONN_EST;
162  * for example: 'OSMO_ABIS_LIB_ATTR_RSL_LINK_UP'.
163  * 2. Brevity: shortenings and abbreviations are welcome!
164  * 3. Values are not flags but indexes, unlike CMD_ATTR_*.
165  * 4. Ordering: new entries added before _OSMO_CORE_LIB_ATTR_COUNT. */
169 
170  /* Keep this floating entry last, it's needed for count check. */
172 };
173 
175 struct cmd_element {
176  const char *string;
177  int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
178  const char *doc;
179  int daemon;
181  unsigned int cmdsize;
182  char *config;
184  unsigned char attr;
185  unsigned int usrattr;
186 };
187 
189 struct desc {
190  const char *cmd;
191  const char *str;
192 };
193 
195 #define CMD_SUCCESS 0
196 #define CMD_WARNING 1
197 #define CMD_ERR_NO_MATCH 2
198 #define CMD_ERR_AMBIGUOUS 3
199 #define CMD_ERR_INCOMPLETE 4
200 #define CMD_ERR_EXEED_ARGC_MAX 5
201 #define CMD_ERR_NOTHING_TODO 6
202 #define CMD_COMPLETE_FULL_MATCH 7
203 #define CMD_COMPLETE_MATCH 8
204 #define CMD_COMPLETE_LIST_MATCH 9
205 #define CMD_SUCCESS_DAEMON 10
206 #define CMD_ERR_INVALID_INDENT 11
207 
208 /* Argc max counts. */
209 #define CMD_ARGC_MAX 256
210 
211 /* Turn off these macros when uisng cpp with extract.pl */
212 #ifndef VTYSH_EXTRACT_PL
213 
214 /* helper defines for end-user DEFUN* macros */
215 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
216  static struct cmd_element cmdname = \
217  { \
218  .string = cmdstr, \
219  .func = funcname, \
220  .doc = helpstr, \
221  .attr = attrs, \
222  .daemon = dnum, \
223  };
224 
225 /* global (non static) cmd_element */
226 #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
227  struct cmd_element cmdname = \
228  { \
229  .string = cmdstr, \
230  .func = funcname, \
231  .doc = helpstr, \
232  .attr = attrs, \
233  .daemon = dnum, \
234  };
235 
236 #define DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attrs, usrattrs) \
237  static struct cmd_element cmdname = \
238  { \
239  .string = cmdstr, \
240  .func = funcname, \
241  .doc = helpstr, \
242  .attr = attrs, \
243  .usrattr = usrattrs, \
244  };
245 
246 #define DEFUN_CMD_FUNC_DECL(funcname) \
247  static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
248 
249 #define DEFUN_CMD_FUNC_TEXT(funcname) \
250  static int funcname \
251  (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
252 
259 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
260  DEFUN_CMD_FUNC_DECL(funcname) \
261  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
262  DEFUN_CMD_FUNC_TEXT(funcname)
263 
270 #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \
271  DEFUN_CMD_FUNC_DECL(funcname) \
272  gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
273  DEFUN_CMD_FUNC_TEXT(funcname)
274 
275 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
276  DEFUN_CMD_FUNC_DECL(funcname) \
277  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
278  DEFUN_CMD_FUNC_TEXT(funcname)
279 
280 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
281  DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
282 
283 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
284  DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
285 
294 #define DEFUN_ATTR_USRATTR(funcname, cmdname, attr, usrattr, cmdstr, helpstr) \
295  DEFUN_CMD_FUNC_DECL(funcname) \
296  DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attr, usrattr) \
297  DEFUN_CMD_FUNC_TEXT(funcname)
298 
299 #define DEFUN_USRATTR(funcname, cmdname, usrattr, cmdstr, helpstr) \
300  DEFUN_ATTR_USRATTR(funcname, cmdname, 0, usrattr, cmdstr, helpstr)
301 
302 /* DEFUN_NOSH for commands that vtysh should ignore */
303 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
304  DEFUN(funcname, cmdname, cmdstr, helpstr)
305 
306 /* DEFSH for vtysh. */
307 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
308  DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
309 
310 /* DEFUN + DEFSH */
311 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
312  DEFUN_CMD_FUNC_DECL(funcname) \
313  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
314  DEFUN_CMD_FUNC_TEXT(funcname)
315 
316 /* DEFUN + DEFSH with attributes */
317 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
318  DEFUN_CMD_FUNC_DECL(funcname) \
319  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
320  DEFUN_CMD_FUNC_TEXT(funcname)
321 
322 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
323  DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
324 
325 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
326  DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
327 
328 /* ALIAS macro which define existing command's alias. */
329 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
330  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
331 
332 /* global (non static) cmd_element */
333 #define gALIAS(funcname, cmdname, cmdstr, helpstr) \
334  gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
335 
336 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
337  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
338 
339 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
340  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
341 
342 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
343  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
344 
345 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
346  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
347 
348 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
349  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
350 
351 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
352  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
353 
354 #endif /* VTYSH_EXTRACT_PL */
355 
356 /* Some macroes */
357 #define CMD_OPTION(S) ((S[0]) == '[')
358 #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
359 #define CMD_VARARG(S) ((S[0]) == '.')
360 #define CMD_RANGE(S) ((S[0] == '<'))
361 
362 #define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
363 #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
364 #define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
365 #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
366 
367 #define VTY_IPV4_CMD "A.B.C.D"
368 #define VTY_IPV6_CMD "X:X::X:X"
369 #define VTY_IPV46_CMD "(" VTY_IPV4_CMD "|" VTY_IPV6_CMD ")"
370 
371 /* Common descriptions. */
372 #define SHOW_STR "Show running system information\n"
373 #define IP_STR "IP information\n"
374 #define IPV6_STR "IPv6 information\n"
375 #define NO_STR "Negate a command or set its defaults\n"
376 #define CLEAR_STR "Reset functions\n"
377 #define RIP_STR "RIP information\n"
378 #define BGP_STR "BGP information\n"
379 #define OSPF_STR "OSPF information\n"
380 #define NEIGHBOR_STR "Specify neighbor router\n"
381 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
382 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
383 #define ROUTER_STR "Enable a routing process\n"
384 #define AS_STR "AS number\n"
385 #define MBGP_STR "MBGP information\n"
386 #define MATCH_STR "Match values from routing table\n"
387 #define SET_STR "Set values in destination routing protocol\n"
388 #define OUT_STR "Filter outgoing routing updates\n"
389 #define IN_STR "Filter incoming routing updates\n"
390 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
391 #define OSPF6_NUMBER_STR "Specify by number\n"
392 #define INTERFACE_STR "Interface infomation\n"
393 #define IFNAME_STR "Interface name(e.g. ep0)\n"
394 #define IP6_STR "IPv6 Information\n"
395 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
396 #define OSPF6_ROUTER_STR "Enable a routing process\n"
397 #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
398 #define SECONDS_STR "<1-65535> Seconds\n"
399 #define ROUTE_STR "Routing Table\n"
400 #define PREFIX_LIST_STR "Build a prefix list\n"
401 #define OSPF6_DUMP_TYPE_LIST \
402 "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
403 #define ISIS_STR "IS-IS information\n"
404 #define AREA_TAG_STR "[area tag]\n"
405 
406 #define CONF_BACKUP_EXT ".sav"
407 
408 /* IPv4 only machine should not accept IPv6 address for peer's IP
409  address. So we replace VTY command string like below. */
410 #ifdef HAVE_IPV6
411 #define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
412 #define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
413 #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
414 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
415 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
416 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
417 #else
418 #define NEIGHBOR_CMD "neighbor A.B.C.D "
419 #define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
420 #define NEIGHBOR_ADDR_STR "Neighbor address\n"
421 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
422 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
423 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
424 #endif /* HAVE_IPV6 */
425 
426 /* Prototypes. */
427 void install_node(struct cmd_node *, int (*)(struct vty *));
428 void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
429 void install_element(int node_type, struct cmd_element *);
430 void install_lib_element(int node_type, struct cmd_element *);
431 void install_element_ve(struct cmd_element *cmd);
432 void install_lib_element_ve(struct cmd_element *cmd);
433 void sort_node(void);
434 
435 void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
436 
437 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
438  string with a space between each element (allocated using
439  XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
440 char *argv_concat(const char **argv, int argc, int shift);
441 
442 vector cmd_make_strvec(const char *);
443 int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p);
444 void cmd_free_strvec(vector);
445 vector cmd_describe_command(vector vline, struct vty *vty, int *status);
446 char **cmd_complete_command(vector vline, struct vty *vty, int *status);
447 const char *cmd_prompt(enum node_type);
448 int config_from_file(struct vty *, FILE *);
449 enum node_type node_parent(enum node_type);
450 int cmd_execute_command(vector, struct vty *, struct cmd_element **, int);
451 int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **);
452 void config_replace_string(struct cmd_element *, char *, ...);
453 void cmd_init(int);
454 
455 /* Export typical functions. */
456 extern struct cmd_element config_exit_cmd;
457 extern struct cmd_element config_help_cmd;
458 extern struct cmd_element config_list_cmd;
459 extern struct cmd_element config_end_cmd;
460 const char *host_config_file(void);
461 void host_config_set(const char *);
462 
463 char *osmo_asciidoc_escape(const char *inp);
464 
465 /* This is called from main when a daemon is invoked with -v or --version. */
466 void print_version(int print_copyright);
467 
468 extern void *tall_vty_cmd_ctx;
469 
478 };
479 
480 extern const struct value_string vty_ref_gen_mode_names[];
481 extern const struct value_string vty_ref_gen_mode_desc[];
482 
483 int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode);
484 int vty_dump_xml_ref(FILE *stream) OSMO_DEPRECATED("Use vty_dump_xml_ref_mode() instead");
485 
486 int vty_cmd_range_match(const char *range, const char *str);
487 
argv
Definition: tdef_vty.c:296
argc
Definition: tdef_vty.c:296
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:141
struct cmd_element config_exit_cmd
enum node_type node_parent(enum node_type)
const char * host_config_file(void)
Definition: command.c:4303
void install_lib_element_ve(struct cmd_element *cmd)
Definition: command.c:1031
struct cmd_element config_help_cmd
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:1024
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2694
void cmd_free_strvec(vector)
Free allocated string vector.
Definition: command.c:345
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:938
void host_config_set(const char *)
Definition: command.c:4298
void * tall_vty_cmd_ctx
Definition: command.c:68
struct cmd_element config_end_cmd
int vty_cmd_range_match(const char *range, const char *str)
Definition: command.c:1527
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:4318
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:996
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:517
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:971
node_type
There are some command levels which called from command node.
Definition: command.h:73
vector cmd_describe_command(vector vline, struct vty *vty, int *status)
Definition: command.c:2197
void install_node(struct cmd_node *, int(*)(struct vty *))
Install top node of command vector.
Definition: command.c:203
vty_ref_gen_mode
VTY reference generation mode.
Definition: command.h:471
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:4311
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:337
const struct value_string vty_ref_gen_mode_desc[]
Definition: command.c:926
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:266
int config_from_file(struct vty *, FILE *)
Definition: command.c:2864
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2728
const struct value_string vty_ref_gen_mode_names[]
Definition: command.c:919
void cmd_init(int)
Definition: command.c:4407
void print_version(int print_copyright)
print the version (and optionally copyright) information
Definition: command.c:132
struct cmd_element config_list_cmd
void sort_node(void)
Sort each node's command element according to command string.
Definition: command.c:227
char ** cmd_complete_command(vector vline, struct vty *vty, int *status)
Definition: command.c:2411
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:1017
char * osmo_asciidoc_escape(const char *inp)
escape all special asciidoc symbols
Definition: command.c:530
@ CMD_ATTR_DEPRECATED
Definition: command.h:149
@ CMD_ATTR_LIB_COMMAND
Definition: command.h:153
@ CMD_ATTR_HIDDEN
Definition: command.h:150
@ CMD_ATTR_IMMEDIATE
Definition: command.h:151
@ CMD_ATTR_NODE_EXIT
Definition: command.h:152
@ 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
@ RESERVED4_NODE
Reserved for later extensions.
Definition: command.h:112
@ 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
@ RESERVED1_NODE
Reserved for later extensions.
Definition: command.h:109
@ 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
@ RESERVED2_NODE
Reserved for later extensions.
Definition: command.h:110
@ CONFIG_NODE
Config node.
Definition: command.h:78
@ L_NS_BIND_NODE
NS bind node.
Definition: command.h:103
@ RESERVED6_NODE
Reserved for later extensions.
Definition: command.h:114
@ 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
@ RESERVED8_NODE
Reserved for later extensions.
Definition: command.h:116
@ 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
@ RESERVED7_NODE
Reserved for later extensions.
Definition: command.h:115
@ _LAST_OSMOVTY_NODE
Definition: command.h:118
@ RESERVED3_NODE
Reserved for later extensions.
Definition: command.h:111
@ VIEW_NODE
View node.
Definition: command.h:75
@ RESERVED5_NODE
Reserved for later extensions.
Definition: command.h:113
@ 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:477
@ VTY_REF_GEN_MODE_EXPERT
Expert mode: all commands including hidden, excluding deprecated.
Definition: command.h:475
@ VTY_REF_GEN_MODE_DEFAULT
Default mode: all commands except deprecated and hidden.
Definition: command.h:473
@ OSMO_SCCP_LIB_ATTR_RSTRT_ASP
Definition: command.h:166
@ OSMO_ABIS_LIB_ATTR_IPA_NEW_LNK
Definition: command.h:167
@ _OSMO_CORE_LIB_ATTR_COUNT
Definition: command.h:171
@ OSMO_ABIS_LIB_ATTR_LINE_UPD
Definition: command.h:168
#define OSMO_DEPRECATED(text)
Definition: vector.h:22
Structure of a command element.
Definition: command.h:175
unsigned char attr
Command attributes (global)
Definition: command.h:184
vector strvec
Pointing out each description vector.
Definition: command.h:180
vector subconfig
Sub configuration string.
Definition: command.h:183
int(* func)(struct cmd_element *, struct vty *, int, const char *[])
Definition: command.h:177
const char * string
Command specification by string.
Definition: command.h:176
unsigned int usrattr
Command attributes (program specific)
Definition: command.h:185
char * config
Configuration string.
Definition: command.h:182
unsigned int cmdsize
Command index count.
Definition: command.h:181
const char * doc
Documentation of this command.
Definition: command.h:178
int daemon
Daemon to which this command belong.
Definition: command.h:179
Node which has some commands and prompt string and configuration function pointer .
Definition: command.h:125
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:133
vector cmd_vector
Vector of this node's command list.
Definition: command.h:139
char name[64]
Human-readable ID of this node.
Definition: command.h:144
const char * prompt
Prompt character at vty interface.
Definition: command.h:130
int node
Node index.
Definition: command.h:127
int(* func)(struct vty *)
Node's configuration write function.
Definition: command.h:136
Command description structure.
Definition: command.h:189
const char * cmd
Command string.
Definition: command.h:190
const char * str
Command's description.
Definition: command.h:191
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
const char * str
Information an application registers with the VTY.
Definition: vty.h:169
Internal representation of a single VTY.
Definition: vty.h:60
Generic vector interface header.