27 #include <sys/types.h> 125 int (*func) (
struct vty *);
162 #define CMD_SUCCESS 0 163 #define CMD_WARNING 1 164 #define CMD_ERR_NO_MATCH 2 165 #define CMD_ERR_AMBIGUOUS 3 166 #define CMD_ERR_INCOMPLETE 4 167 #define CMD_ERR_EXEED_ARGC_MAX 5 168 #define CMD_ERR_NOTHING_TODO 6 169 #define CMD_COMPLETE_FULL_MATCH 7 170 #define CMD_COMPLETE_MATCH 8 171 #define CMD_COMPLETE_LIST_MATCH 9 172 #define CMD_SUCCESS_DAEMON 10 173 #define CMD_ERR_INVALID_INDENT 11 176 #define CMD_ARGC_MAX 256 179 #ifndef VTYSH_EXTRACT_PL 182 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ 183 static struct cmd_element cmdname = \ 193 #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ 194 struct cmd_element cmdname = \ 203 #define DEFUN_CMD_FUNC_DECL(funcname) \ 204 static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \ 206 #define DEFUN_CMD_FUNC_TEXT(funcname) \ 207 static int funcname \ 208 (struct cmd_element *self, struct vty *vty, int argc, const char *argv[]) 216 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \ 217 DEFUN_CMD_FUNC_DECL(funcname) \ 218 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ 219 DEFUN_CMD_FUNC_TEXT(funcname) 227 #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \ 228 DEFUN_CMD_FUNC_DECL(funcname) \ 229 gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ 230 DEFUN_CMD_FUNC_TEXT(funcname) 232 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ 233 DEFUN_CMD_FUNC_DECL(funcname) \ 234 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \ 235 DEFUN_CMD_FUNC_TEXT(funcname) 237 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ 238 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) 240 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ 241 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \ 244 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \ 245 DEFUN(funcname, cmdname, cmdstr, helpstr) 248 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \ 249 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \ 252 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \ 253 DEFUN_CMD_FUNC_DECL(funcname) \ 254 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \ 255 DEFUN_CMD_FUNC_TEXT(funcname) 258 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \ 259 DEFUN_CMD_FUNC_DECL(funcname) \ 260 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \ 261 DEFUN_CMD_FUNC_TEXT(funcname) 263 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ 264 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) 266 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ 267 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) 270 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \ 271 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) 274 #define gALIAS(funcname, cmdname, cmdstr, helpstr) \ 275 gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) 277 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ 278 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) 280 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ 281 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0) 283 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ 284 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0) 286 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \ 287 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) 289 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ 290 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) 292 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ 293 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon) 298 #define CMD_OPTION(S) ((S[0]) == '[') 299 #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<')) 300 #define CMD_VARARG(S) ((S[0]) == '.') 301 #define CMD_RANGE(S) ((S[0] == '<')) 303 #define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0)) 304 #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0)) 305 #define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0)) 306 #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0)) 308 #define VTY_IPV4_CMD "A.B.C.D" 309 #define VTY_IPV6_CMD "X:X::X:X" 310 #define VTY_IPV46_CMD "(" VTY_IPV4_CMD "|" VTY_IPV6_CMD ")" 313 #define SHOW_STR "Show running system information\n" 314 #define IP_STR "IP information\n" 315 #define IPV6_STR "IPv6 information\n" 316 #define NO_STR "Negate a command or set its defaults\n" 317 #define CLEAR_STR "Reset functions\n" 318 #define RIP_STR "RIP information\n" 319 #define BGP_STR "BGP information\n" 320 #define OSPF_STR "OSPF information\n" 321 #define NEIGHBOR_STR "Specify neighbor router\n" 322 #define DEBUG_STR "Debugging functions (see also 'undebug')\n" 323 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n" 324 #define ROUTER_STR "Enable a routing process\n" 325 #define AS_STR "AS number\n" 326 #define MBGP_STR "MBGP information\n" 327 #define MATCH_STR "Match values from routing table\n" 328 #define SET_STR "Set values in destination routing protocol\n" 329 #define OUT_STR "Filter outgoing routing updates\n" 330 #define IN_STR "Filter incoming routing updates\n" 331 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n" 332 #define OSPF6_NUMBER_STR "Specify by number\n" 333 #define INTERFACE_STR "Interface infomation\n" 334 #define IFNAME_STR "Interface name(e.g. ep0)\n" 335 #define IP6_STR "IPv6 Information\n" 336 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n" 337 #define OSPF6_ROUTER_STR "Enable a routing process\n" 338 #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n" 339 #define SECONDS_STR "<1-65535> Seconds\n" 340 #define ROUTE_STR "Routing Table\n" 341 #define PREFIX_LIST_STR "Build a prefix list\n" 342 #define OSPF6_DUMP_TYPE_LIST \ 343 "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)" 344 #define ISIS_STR "IS-IS information\n" 345 #define AREA_TAG_STR "[area tag]\n" 347 #define CONF_BACKUP_EXT ".sav" 352 #define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) " 353 #define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) " 354 #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n" 355 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) " 356 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) " 357 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n" 359 #define NEIGHBOR_CMD "neighbor A.B.C.D " 360 #define NO_NEIGHBOR_CMD "no neighbor A.B.C.D " 361 #define NEIGHBOR_ADDR_STR "Neighbor address\n" 362 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) " 363 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) " 364 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n" 379 char *
argv_concat(
const char **argv,
int argc,
int shift);
int advanced
Flags for services.
Definition: command.h:59
SS7 Application Server Process.
Definition: command.h:92
const char * prompt
Prompt character at vty interface.
Definition: command.h:119
#define OSMO_DEPRECATED(text)
SS7 root node.
Definition: command.h:90
CPU Sched related options node.
Definition: command.h:100
const char * string
Command specification by string.
Definition: command.h:144
const char * cmd
Command string.
Definition: command.h:157
int daemon
Daemon to which this command belong.
Definition: command.h:147
const char * doc
Documentation of this command.
Definition: command.h:146
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:119
Internal representation of a single VTY.
Definition: vty.h:67
NS node in libosmo-gb.
Definition: command.h:86
void config_replace_string(struct cmd_element *, char *,...)
SS7 xUA Listener.
Definition: command.h:93
char * config
Configuration string.
Definition: command.h:150
const struct vty_app_info * app_info
VTY application information.
Definition: command.h:67
SS7 Link.
Definition: command.h:95
char * password
Password for vty interface.
Definition: command.h:42
Definition: command.h:107
E1 line in libosmo-abis.
Definition: command.h:84
void * tall_vty_cmd_ctx
Definition: command.c:64
Configure the logging.
Definition: command.h:79
IPA proxying commands in libosmo-abis.
Definition: command.h:85
Vty node.
Definition: command.h:82
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:794
char * config
config file name of this host
Definition: command.h:56
Command description structure.
Definition: command.h:156
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:495
Host configuration variable.
Definition: command.h:37
Configure the statistics.
Definition: command.h:80
char * motdfile
Definition: command.h:64
Config node.
Definition: command.h:76
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:71
Node which has some commands and prompt string and configuration function pointer ...
Definition: command.h:114
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:244
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:3908
char ** cmd_complete_command()
vector cmd_describe_command()
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2426
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:3817
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:315
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:72
SS7 Application Server.
Definition: command.h:91
View node.
Definition: command.h:73
SS7 Routing Table.
Definition: command.h:94
struct cmd_element config_help_cmd
struct cmd_element config_exit_cmd
SS7 SCCP Address.
Definition: command.h:97
vector strvec
Pointing out each description vector.
Definition: command.h:148
int lines
System wide terminal lines.
Definition: command.h:50
char * logfile
Log filename.
Definition: command.h:53
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:122
char * enable_encrypt
Definition: command.h:47
const char * motd
Banner configuration.
Definition: command.h:63
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:128
Service node.
Definition: command.h:77
char * password_encrypt
Definition: command.h:43
Reserved for later extensions.
Definition: command.h:105
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2460
Generic vector interface header.
char * enable
Enable password.
Definition: command.h:46
SS7 SCCP Global Title.
Definition: command.h:98
Structure of a command element.
Definition: command.h:143
int encrypt
Definition: command.h:60
unsigned char attr
Command attributes.
Definition: command.h:152
char * name
Host name of this router.
Definition: command.h:39
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:812
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:3824
int config_from_file(struct vty *, FILE *)
Definition: command.c:2596
int node
Node index.
Definition: command.h:116
vector subconfig
Sub configuration string.
Definition: command.h:151
unsigned int cmdsize
Command index count.
Definition: command.h:149
int vty_dump_xml_ref(FILE *stream)
Print the XML reference of all VTY nodes to the given stream.
Definition: command.c:769
Definition: command.h:138
SS7 Linkset.
Definition: command.h:96
Control interface node.
Definition: command.h:88
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:3809
const char * str
Command's description.
Definition: command.h:158
Enable node.
Definition: command.h:75
struct cmd_element config_end_cmd
Authentication mode for change enable.
Definition: command.h:74
Information an application registers with the VTY.
Definition: vty.h:173
BSSGP node in libosmo-gb.
Definition: command.h:87
Debug node.
Definition: command.h:78
char * host_config_file()
Definition: command.h:139