summaryrefslogtreecommitdiffstats
path: root/usr/local/pkg/carp_settings.xml
blob: de0d226ba91e1e55e7e5174c60685a0acf081d45 (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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?xml version="1.0" encoding="utf-8" ?>
<packagegui>
	<name>carpsettings</name>
	<version>0.1.0</version>
	<title>Services: CARP Settings</title>
	<!-- configpath gets expanded out automatically and config items will be
         stored in that location -->
	<configpath>['installedpackages']['carpsettings']['config']</configpath>
	<aftersaveredirect>pkg_edit.php?xml=carp_settings.xml&amp;id=0</aftersaveredirect>
	<!-- Menu is where this packages menu will appear -->
	<menu>
	    <name>CARP (failover)</name>
	    <tooltiptext>CARP is a tool to help achieve system redundancy, by having multiple computers creating a single, virtual network interface between them, so that if any machine fails, another can respond instead. CARP is an improvement over the Virtual Router Redundancy Protocol (VRRP) standard. It was developed after VRRP was deemed to be not free enough because of a possibly-overlapping Cisco patent.</tooltiptext>
	    <section>Firewall</section>
	    <configfile>carp_settings.xml</configfile>
	</menu>
	<tabs>
<!--	    <tab>
		<text>CARP Virtual IPs</text>
		<url>/pkg.php?xml=carp.xml</url>
	    </tab>
-->
	    <tab>
		<text>Virtual IPs</text>
		<url>firewall_virtual_ip.php</url>
	    </tab>
	    <tab>
		<text>CARP Settings</text>
		<url>pkg_edit.php?xml=carp_settings.xml&amp;id=0</url>
		<active/>
	    </tab>
	</tabs>
	<adddeleteeditpagefields>
	    <columnitem>
		    <fielddescr>PFSync Enabled</fielddescr>
		    <fieldname>pfsyncenabled</fieldname>
	    </columnitem>
	    <columnitem>
		    <fielddescr>PFSync IP</fielddescr>
		    <fieldname>pfsyncip</fieldname>
	    </columnitem>
	    <columnitem>
		    <fielddescr>PFSync Interface</fielddescr>
		    <fieldname>pfsyncinterface</fieldname>
	    </columnitem>
	</adddeleteeditpagefields>
	<!-- fields gets invoked when the user adds or edits a item.   the following items
         will be parsed and rendered for the user as a gui with input, and selectboxes. -->
	<fields>
		<field>
			<fielddescr>Synchronize Enabled</fielddescr>
			<fieldname>pfsyncenabled</fieldname>
			    <description>
				PFSync transfers state insertion, update, and deletion messages between firewalls. Each firewall sends these messages out via multicast on a specified interface, using the PFSYNC protocol (IP Protocol 240). It also listens on that interface for similar messages from other firewalls, and imports them into the local state table.
				&lt;p&gt;
				NOTE: Clicking save will force a configuration sync!
			    </description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Interface</fielddescr>
			<fieldname>pfsyncinterface</fieldname>
			<type>interfaces_selection</type>
			<description>
			    If Synchronize State is enabled, it will utilize this interface for communication.
			    &lt;br&gt;&lt;b&gt;NOTE:&lt;/b&gt;  We recommend setting this to a interface other than LAN!  A dedicated interface works the best.
			    &lt;br&gt;&lt;b&gt;NOTE:&lt;/b&gt;  You must define a IP on each machine participating in this failover group.
			    &lt;br&gt;&lt;b&gt;NOTE:&lt;/b&gt;  You must have an IP assigned to the interface on any participating sync nodes.
			</description>
		</field>
		<field>
			<fielddescr>pfSync sync peer IP</fielddescr>
			<fieldname>pfsyncpeerip</fieldname>
			<type>input</type>
			<description>
				Setting this option will force pfsync to synchronize its state table to this IP address.  The default is directed multicast.
			</description>
		</field>
		<field>
			<fielddescr>Synchronize Users and Groups</fielddescr>
			<fieldname>synchronizeusers</fieldname>
			<description>When this option is enabled, this system will automatically sync the users and groups over to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize rules</fielddescr>
			<fieldname>synchronizerules</fieldname>
			<description>When this option is enabled, this system will automatically sync the firewall rules to the other CARP host when changes are made..</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Firewall Schedules</fielddescr>
			<fieldname>synchronizeschedules</fieldname>
			<description>When this option is enabled, this system will automatically sync the firewall schedules to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize aliases</fielddescr>
			<fieldname>synchronizealiases</fieldname>
			<description>When this option is enabled, this system will automatically sync the aliases over to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize nat</fielddescr>
			<fieldname>synchronizenat</fieldname>
			<description>When this option is enabled, this system will automatically sync the NAT rules over to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize IPsec</fielddescr>
			<fieldname>synchronizeipsec</fieldname>
			<description>When this option is enabled, this system will automatically sync the IPsec configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize OpenVPN</fielddescr>
			<fieldname>synchronizeopenvpn</fieldname>
			<description>When this option is enabled, this system will automatically sync the OpenVPN configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize DHCPD</fielddescr>
			<fieldname>synchronizedhcpd</fieldname>
			<description>When this option is enabled, this system will automatically sync the DHCP Server settings over to the other carp host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Wake on LAN</fielddescr>
			<fieldname>synchronizewol</fieldname>
			<description>When this option is enabled, this system will automatically sync the WoL configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Static Routes</fielddescr>
			<fieldname>synchronizestaticroutes</fieldname>
			<description>When this option is enabled, this system will automatically sync the Static Route configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Load Balancer</fielddescr>
			<fieldname>synchronizelb</fieldname>
			<description>When this option is enabled, this system will automatically sync the Load Balancer configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Virtual IPs</fielddescr>
			<fieldname>synchronizevirtualip</fieldname>
			<description>When this option is enabled, this system will automatically sync the CARP Virtual IPs to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize traffic shaper</fielddescr>
			<fieldname>synchronizetrafficshaper</fieldname>
			<description>When this option is enabled, this system will automatically sync the traffic shaper configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize DNS Forwarder</fielddescr>
			<fieldname>synchronizednsforwarder</fieldname>
			<description>When this option is enabled, this system will automatically sync the DNS Forwarder configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize Captive Portal</fielddescr>
			<fieldname>synchronizecaptiveportal</fieldname>
			<description>When this option is enabled, this system will automatically sync the Captive Portal configuration to the other CARP host when changes are made.</description>
			<type>checkbox</type>
		</field>
		<field>
			<fielddescr>Synchronize to IP</fielddescr>
			<fieldname>synchronizetoip</fieldname>
			<description>Enter the IP address of the firewall you are synchronizing with.</description>
			<type>input</type>
			<note>Note: CARP sync is currently only supported over connections using the same protocol and port as this system - make sure the remote system's port and protocol are set accordingly!   Also note that you will not use the Synchronize to IP and password option on backup cluster members!</note>
		</field>
		<field>
            <fielddescr>Remote System Password</fielddescr>
            <fieldname>password</fieldname>
            <description>Enter the webConfigurator password of the system that you would like to synchronize with.</description>
            <type>password</type>
			<note>NOTE: You will not use the Synchronize to IP and password option on backup cluster members!</note>
		</field>
	</fields>
	<custom_php_validation_command>
		if($_POST["synchronizetoip"]) {
			if(!is_ipaddr($_POST["synchronizetoip"]))
				$input_errors[] = "You must specify a valid IP address.";
			$ifdescrs = get_configured_interface_list();
			foreach($ifdescrs as $descr) 
				if(get_interface_ip($descr) == $_POST["synchronizetoip"])
					$input_errors[] = "CARP sync IP must be the backup firewall IP!  You cannot specify this firewalls IP in this location.";
			if($config['virtualip']['vip']) {
				foreach($config['virtualip']['vip'] as $vip) {
					if($vip['subnet'] == $_POST["synchronizetoip"]) 				
						$input_errors[] = "CARP sync IP must be the backup firewall IP!  You cannot specify this firewalls IP in this location.";
				}
			}
		}
	</custom_php_validation_command>
	<custom_add_php_command_late>
		/* setup carp interfaces */
		interfaces_carp_setup();
		/* force a filter configure for syncing */
		filter_configure();
	</custom_add_php_command_late>
</packagegui>
OpenPOWER on IntegriCloud