vtysh/vtysh.h

   1 /* Virtual terminal interface shell.
   2  * Copyright (C) 2000 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef VTYSH_H
  22 #define VTYSH_H
  23
  24 #include "memory.h"
  25 DECLARE_MGROUP(MVTYSH)
  26
  27 #define VTYSH_ZEBRA     0x0001
  28 #define VTYSH_RIPD      0x0002
  29 #define VTYSH_RIPNGD    0x0004
  30 #define VTYSH_OSPFD     0x0008
  31 #define VTYSH_OSPF6D    0x0010
  32 #define VTYSH_BGPD      0x0020
  33 #define VTYSH_ISISD     0x0040
  34 #define VTYSH_PIMD      0x0080
  35 #define VTYSH_LDPD      0x0100
  36 #define VTYSH_WATCHFRR  0x0200
  37 #define VTYSH_NHRPD     0x0400
  38 #define VTYSH_EIGRPD    0x0800
  39 #define VTYSH_BABELD    0x1000
  40 #define VTYSH_SHARPD    0x2000
  41 #define VTYSH_PBRD      0x4000
  42
  43 /* commands in REALLYALL are crucial to correct vtysh operation */
  44 #define VTYSH_REALLYALL   ~0U
  45 /* watchfrr is not in ALL since library CLI functions should not be
  46  * run on it (logging & co. should stay in a fixed/frozen config, and
  47  * things like prefix lists are not even initialised) */
  48 #define VTYSH_ALL         VTYSH_ZEBRA|VTYSH_RIPD|VTYSH_RIPNGD|VTYSH_OSPFD|VTYSH_OSPF6D|VTYSH_LDPD|VTYSH_BGPD|VTYSH_ISISD|VTYSH_PIMD|VTYSH_NHRPD|VTYSH_EIGRPD|VTYSH_BABELD|VTYSH_SHARPD|VTYSH_PBRD
  49 #define VTYSH_RMAP        VTYSH_ZEBRA|VTYSH_RIPD|VTYSH_RIPNGD|VTYSH_OSPFD|VTYSH_OSPF6D|VTYSH_BGPD|VTYSH_ISISD|VTYSH_PIMD|VTYSH_EIGRPD|VTYSH_SHARPD
  50 #define VTYSH_INTERFACE   VTYSH_ZEBRA|VTYSH_RIPD|VTYSH_RIPNGD|VTYSH_OSPFD|VTYSH_OSPF6D|VTYSH_ISISD|VTYSH_PIMD|VTYSH_NHRPD|VTYSH_EIGRPD|VTYSH_BABELD|VTYSH_PBRD
  51 #define VTYSH_NS          VTYSH_ZEBRA
  52 #define VTYSH_VRF         VTYSH_ZEBRA|VTYSH_PIMD
  53
  54 enum vtysh_write_integrated {
  55         WRITE_INTEGRATED_UNSPECIFIED,
  56         WRITE_INTEGRATED_NO,
  57         WRITE_INTEGRATED_YES
  58 };
  59
  60 extern enum vtysh_write_integrated vtysh_write_integrated;
  61
  62 extern char frr_config[];
  63 extern char vtydir[];
  64
  65 void vtysh_init_vty(void);
  66 void vtysh_uninit(void);
  67 void vtysh_init_cmd(void);
  68 extern int vtysh_connect_all(const char *optional_daemon_name);
  69 void vtysh_readline_init(void);
  70 void vtysh_user_init(void);
  71
  72 int vtysh_execute(const char *);
  73 int vtysh_execute_no_pager(const char *);
  74
  75 char *vtysh_prompt(void);
  76
  77 void vtysh_config_write(void);
  78
  79 int vtysh_config_from_file(struct vty *, FILE *);
  80
  81 void config_add_line(struct list *, const char *);
  82
  83 int vtysh_mark_file(const char *filename);
  84
  85 int vtysh_read_config(const char *);
  86 int vtysh_write_config_integrated(void);
  87
  88 void vtysh_config_parse_line(void *, const char *);
  89
  90 void vtysh_config_dump(FILE *);
  91
  92 void vtysh_config_init(void);
  93
  94 void vtysh_pager_init(void);
  95
  96 void suid_on(void);
  97 void suid_off(void);
  98
  99 /* Child process execution flag. */
 100 extern int execute_flag;
 101
 102 extern struct vty *vty;
 103
 104 extern int user_mode;
 105
 106 #endif /* VTYSH_H */