blob: 58cb70cd7979c36cbe3eea99e1368de1a631819f (
plain)
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?xml version="1.0"?>
<interfaceDefinition>
<node name="service">
<children>
<node name="https" owner="${vyos_conf_scripts_dir}/https.py">
<properties>
<help>HTTPS configuration</help>
<priority>1001</priority>
</properties>
<children>
<tagNode name="virtual-host">
<properties>
<help>Identifier for virtual host</help>
<constraint>
<regex>[a-zA-Z0-9-_.:]{1,255}</regex>
</constraint>
<constraintErrorMessage>illegal characters in identifier or identifier longer than 255 characters</constraintErrorMessage>
</properties>
<children>
<leafNode name="listen-address">
<properties>
<help>Address to listen for HTTPS requests</help>
<completionHelp>
<script>${vyos_completion_dir}/list_local_ips.sh --both</script>
</completionHelp>
<valueHelp>
<format>ipv4</format>
<description>HTTPS IPv4 address</description>
</valueHelp>
<valueHelp>
<format>ipv6</format>
<description>HTTPS IPv6 address</description>
</valueHelp>
<valueHelp>
<format>'*'</format>
<description>any</description>
</valueHelp>
<constraint>
<validator name="ipv4-address"/>
<validator name="ipv6-address"/>
<regex>\*$</regex>
</constraint>
</properties>
</leafNode>
<leafNode name='listen-port'>
<properties>
<help>Port to listen for HTTPS requests; default 443</help>
<valueHelp>
<format>u32:1-65535</format>
<description>Numeric IP port</description>
</valueHelp>
<constraint>
<validator name="numeric" argument="--range 1-65535"/>
</constraint>
</properties>
</leafNode>
<leafNode name="server-name">
<properties>
<help>Server names: exact, wildcard, or regex</help>
<multi/>
</properties>
</leafNode>
</children>
</tagNode>
<node name="api" owner="${vyos_conf_scripts_dir}/http-api.py">
<properties>
<help>VyOS HTTP API configuration</help>
<priority>1002</priority>
</properties>
<children>
#include <include/port-number.xml.i>
<node name="keys">
<properties>
<help>HTTP API keys</help>
</properties>
<children>
<tagNode name="id">
<properties>
<help>HTTP API id</help>
</properties>
<children>
<leafNode name="key">
<properties>
<help>HTTP API plaintext key</help>
</properties>
</leafNode>
</children>
</tagNode>
</children>
</node>
<leafNode name="strict">
<properties>
<help>Enforce strict path checking</help>
<valueless/>
</properties>
</leafNode>
<leafNode name="debug">
<properties>
<help>Debug</help>
<valueless/>
<hidden/>
</properties>
</leafNode>
<leafNode name="socket">
<properties>
<help>Run server on Unix domain socket</help>
<valueless/>
</properties>
</leafNode>
</children>
</node>
<node name="api-restrict">
<properties>
<help>Restrict api proxy to subset of virtual hosts</help>
</properties>
<children>
<leafNode name="virtual-host">
<properties>
<help>Restrict proxy to virtual host(s)</help>
<multi/>
</properties>
</leafNode>
</children>
</node>
<node name="certificates">
<properties>
<help>TLS certificates</help>
</properties>
<children>
<node name="system-generated-certificate" owner="${vyos_conf_scripts_dir}/vyos_cert.py">
<properties>
<help>Use an automatically generated self-signed certificate</help>
</properties>
<children>
<leafNode name="lifetime">
<properties>
<help>Lifetime in days; default is 365</help>
<valueHelp>
<format>1-65535</format>
<description>Number of days</description>
</valueHelp>
</properties>
</leafNode>
</children>
</node>
<node name="certbot" owner="${vyos_conf_scripts_dir}/le_cert.py">
<properties>
<help>Request or apply a letsencrypt certificate for domain-name</help>
</properties>
<children>
<leafNode name="domain-name">
<properties>
<help>Domain name(s) for which to obtain certificate</help>
<multi/>
</properties>
</leafNode>
<leafNode name="email">
<properties>
<help>Email address to associate with certificate</help>
</properties>
</leafNode>
</children>
</node>
</children>
</node>
#include <include/interface/vrf.xml.i>
</children>
</node>
</children>
</node>
</interfaceDefinition>
|
