28 #include <sys/types.h> 129 int (*func) (
struct vty *);
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 202 #define CMD_ARGC_MAX 256 205 #ifndef VTYSH_EXTRACT_PL 208 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ 209 static struct cmd_element cmdname = \ 219 #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ 220 struct cmd_element cmdname = \ 229 #define DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attrs, usrattrs) \ 230 static struct cmd_element cmdname = \ 236 .usrattr = usrattrs, \ 239 #define DEFUN_CMD_FUNC_DECL(funcname) \ 240 static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \ 242 #define DEFUN_CMD_FUNC_TEXT(funcname) \ 243 static int funcname \ 244 (struct cmd_element *self, struct vty *vty, int argc, const char *argv[]) 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) 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) 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) 273 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ 274 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) 276 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ 277 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) 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) 292 #define DEFUN_USRATTR(funcname, cmdname, usrattr, cmdstr, helpstr) \ 293 DEFUN_ATTR_USRATTR(funcname, cmdname, 0, usrattr, cmdstr, helpstr) 296 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \ 297 DEFUN(funcname, cmdname, cmdstr, helpstr) 300 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \ 301 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \ 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) 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) 315 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ 316 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) 318 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ 319 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) 322 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \ 323 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) 326 #define gALIAS(funcname, cmdname, cmdstr, helpstr) \ 327 gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) 329 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ 330 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) 332 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ 333 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0) 335 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ 336 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0) 338 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \ 339 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) 341 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ 342 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) 344 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ 345 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon) 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] == '<')) 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)) 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 ")" 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" 399 #define CONF_BACKUP_EXT ".sav" 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" 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" 433 char *
argv_concat(
const char **argv,
int argc,
int shift);
int advanced
Flags for services.
Definition: command.h:60
SS7 Application Server Process.
Definition: command.h:96
const char * prompt
Prompt character at vty interface.
Definition: command.h:123
unsigned int usrattr
Command attributes (program specific)
Definition: command.h:178
#define OSMO_DEPRECATED(text)
SS7 root node.
Definition: command.h:94
CPU Sched related options node.
Definition: command.h:104
const char * string
Command specification by string.
Definition: command.h:169
const char * cmd
Command string.
Definition: command.h:183
int daemon
Daemon to which this command belong.
Definition: command.h:172
const char * doc
Documentation of this command.
Definition: command.h:171
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:119
Internal representation of a single VTY.
Definition: vty.h:73
Definition: command.h:145
NS node in libosmo-gb.
Definition: command.h:90
Definition: command.h:144
void config_replace_string(struct cmd_element *, char *,...)
SS7 xUA Listener.
Definition: command.h:97
char * config
Configuration string.
Definition: command.h:175
const struct vty_app_info * app_info
VTY application information.
Definition: command.h:68
SS7 Link.
Definition: command.h:99
char * password
Password for vty interface.
Definition: command.h:43
Definition: command.h:111
E1 line in libosmo-abis.
Definition: command.h:88
void * tall_vty_cmd_ctx
Definition: command.c:64
Configure the logging.
Definition: command.h:83
IPA proxying commands in libosmo-abis.
Definition: command.h:89
Vty node.
Definition: command.h:86
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:910
char * config
config file name of this host
Definition: command.h:57
Command description structure.
Definition: command.h:182
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:495
Host configuration variable.
Definition: command.h:38
Configure the statistics.
Definition: command.h:84
char * motdfile
Definition: command.h:65
Config node.
Definition: command.h:80
void sort_node(void)
Sort each node's command element according to command string.
Definition: command.c:205
node_type
There are some command levels which called from command node.
Definition: command.h:75
Node which has some commands and prompt string and configuration function pointer ...
Definition: command.h:118
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:244
Definition: command.h:159
void install_node(struct cmd_node *, int(*)(struct vty *))
Install top node of command vector.
Definition: command.c:181
void cmd_init(int)
Definition: command.c:4257
char ** cmd_complete_command()
vector cmd_describe_command()
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2561
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:4161
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:315
Definition: command.h:164
struct cmd_element config_list_cmd
void cmd_free_strvec(vector)
Free allocated string vector.
Definition: command.c:323
Authentication mode of vty interface.
Definition: command.h:76
SS7 Application Server.
Definition: command.h:95
View node.
Definition: command.h:77
SS7 Routing Table.
Definition: command.h:98
struct cmd_element config_help_cmd
struct cmd_element config_exit_cmd
SS7 SCCP Address.
Definition: command.h:101
vector strvec
Pointing out each description vector.
Definition: command.h:173
void install_lib_element(int node_type, struct cmd_element *)
Install a library command into a node.
Definition: command.c:931
int lines
System wide terminal lines.
Definition: command.h:51
char * logfile
Log filename.
Definition: command.h:54
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:126
char * enable_encrypt
Definition: command.h:48
const char * motd
Banner configuration.
Definition: command.h:64
char * osmo_asciidoc_escape(const char *inp)
escape all special asciidoc symbols
Definition: command.c:508
vector cmd_vector
Vector of this node's command list.
Definition: command.h:132
Service node.
Definition: command.h:81
char * password_encrypt
Definition: command.h:44
Reserved for later extensions.
Definition: command.h:109
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2595
Generic vector interface header.
char * enable
Enable password.
Definition: command.h:47
SS7 SCCP Global Title.
Definition: command.h:102
Structure of a command element.
Definition: command.h:168
int encrypt
Definition: command.h:61
unsigned char attr
Command attributes (global)
Definition: command.h:177
char * name
Host name of this router.
Definition: command.h:40
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:938
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:4168
Definition: command.h:146
int config_from_file(struct vty *, FILE *)
Definition: command.c:2731
Definition: command.h:161
void install_lib_element_ve(struct cmd_element *cmd)
Definition: command.c:945
int node
Node index.
Definition: command.h:120
vector subconfig
Sub configuration string.
Definition: command.h:176
unsigned int cmdsize
Command index count.
Definition: command.h:174
int vty_dump_xml_ref(FILE *stream)
Print the XML reference of all VTY nodes to the given stream.
Definition: command.c:885
Definition: command.h:142
SS7 Linkset.
Definition: command.h:100
Control interface node.
Definition: command.h:92
enum node_type node_parent(enum node_type)
void print_version(int print_copyright)
print the version (and optionally copyright) information
Definition: command.c:110
void host_config_set(const char *)
Definition: command.c:4153
const char * str
Command's description.
Definition: command.h:184
Enable node.
Definition: command.h:79
struct cmd_element config_end_cmd
Definition: command.h:160
Authentication mode for change enable.
Definition: command.h:78
Information an application registers with the VTY.
Definition: vty.h:179
BSSGP node in libosmo-gb.
Definition: command.h:91
Debug node.
Definition: command.h:82
char * host_config_file()
bool expert_mode
Whether the expert mode is enabled.
Definition: command.h:71
Definition: command.h:143