op-mode-definitions/openvpn.xml.in


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

<?xml version="1.0"?>
<interfaceDefinition>
  <node name="reset">
    <children>
      <node name="openvpn">
        <properties>
          <help>Reset OpenVPN client/server connections</help>
        </properties>
        <children>
          <tagNode name="client">
            <properties>
              <help>Reset specified OpenVPN client</help>
              <completionHelp>
                <script>sudo ${vyos_completion_dir}/list_openvpn_clients.py --all</script>
              </completionHelp>
            </properties>
            <command>echo kill $4 | socat - UNIX-CONNECT:/run/openvpn/openvpn-mgmt-intf &gt; /dev/null</command>
          </tagNode>
          <tagNode name="interface">
            <properties>
              <help>Reset OpenVPN process on interface</help>
              <completionHelp>
                <script>sudo ${vyos_completion_dir}/list_interfaces.py --type openvpn</script>
              </completionHelp>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/reset_openvpn.py $4</command>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
  <node name="show">
    <children>
      <node name="interfaces">
        <children>
          <node name="openvpn">
            <properties>
              <help>Show OpenVPN interface information</help>
            </properties>
            <children>
              <leafNode name="detail">
                <properties>
                  <help>Show detailed OpenVPN interface information</help>
                </properties>
                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=openvpn --action=show</command>
              </leafNode>
            </children>
          </node>
          <tagNode name="openvpn">
            <properties>
              <help>Show OpenVPN interface information</help>
              <completionHelp>
                <script>sudo ${vyos_completion_dir}/list_interfaces.py --type openvpn</script>
              </completionHelp>
            </properties>
            <command>${vyos_op_scripts_dir}/show_interfaces.py --intf=$4</command>
            <children>
              <tagNode name="user">
                <properties>
                  <help>Show OpenVPN interface users</help>
                  <completionHelp>
                    <script>sudo ${vyos_completion_dir}/list_openvpn_users.py --interface ${COMP_WORDS[3]}</script>
                  </completionHelp>
                </properties>
                <children>
                  <node name="mfa">
                    <properties>
                      <help>Show multi-factor authentication information</help>
                    </properties>
                    <children>
                      <leafNode name="secret">
                        <properties>
                          <help>Show multi-factor authentication secret</help>
                        </properties>
                        <command>${vyos_op_scripts_dir}/show_openvpn_mfa.py --user="$6" --intf="$4" --action=secret</command>
                      </leafNode>
                      <leafNode name="uri">
                        <properties>
                          <help>Show multi-factor authentication otpauth uri</help>
                        </properties>
                        <command>${vyos_op_scripts_dir}/show_openvpn_mfa.py --user="$6" --intf="$4" --action=uri</command>
                      </leafNode>
                      <leafNode name="qrcode">
                        <properties>
                          <help>Show multi-factor authentication QR code</help>
                        </properties>
                        <command>${vyos_op_scripts_dir}/show_openvpn_mfa.py --user="$6" --intf="$4" --action=qrcode</command>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </tagNode>
              <leafNode name="brief">
                <properties>
                  <help>Show summary of specified OpenVPN interface information</help>
                </properties>
                <command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4" --action=show-brief</command>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
      <node name="openvpn">
        <properties>
          <help>Show OpenVPN information</help>
        </properties>
        <children>
          <leafNode name="client">
            <properties>
              <help>Show tunnel status for OpenVPN client interfaces</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/show_openvpn.py --mode=client</command>
          </leafNode>
          <leafNode name="server">
            <properties>
              <help>Show tunnel status for OpenVPN server interfaces</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/show_openvpn.py --mode=server</command>
          </leafNode>
          <leafNode name="site-to-site">
            <properties>
              <help>Show tunnel status for OpenVPN site-to-site interfaces</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/show_openvpn.py --mode=site-to-site</command>
          </leafNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>