summaryrefslogtreecommitdiffstats
path: root/net/pfSense-pkg-OpenBGPD/files/usr/local/pkg/openbgpd.xml
blob: 5d6e9dafa071116c67a7b432d40903be0950be4f (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
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE packagegui SYSTEM "../schema/packages.dtd">
<?xml-stylesheet type="text/xsl" href="../xsl/package.xsl"?>
<packagegui>
	<copyright>
	<![CDATA[
/* $Id$ */
/* ====================================================================================== */
/*
	openbgpd.xml
	part of pfSense (https://www.pfSense.org/)
	Copyright (C) 2007 Scott Ullrich (sullrich@gmail.com)
	Copyright (C) 2015 ESF, LLC
	All rights reserved.
*/
/* ====================================================================================== */
/*
	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions are met:


	1. Redistributions of source code must retain the above copyright notice,
	   this list of conditions and the following disclaimer.

	2. Redistributions in binary form must reproduce the above copyright
	   notice, this list of conditions and the following disclaimer in the
	   documentation and/or other materials provided with the distribution.


	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	POSSIBILITY OF SUCH DAMAGE.
*/
/* ====================================================================================== */
	]]>
	</copyright>
	<name>OpenBGPD</name>
	<title>Services: OpenBGPD</title>
	<include_file>/usr/local/pkg/openbgpd.inc</include_file>
	<service>
		<name>bgpd</name>
		<rcfile>bgpd.sh</rcfile>
		<executable>bgpd</executable>
		<description>OpenBSD BGP Daemon</description>
	</service>	
	<menu>
		<name>OpenBGPD</name>
		<section>Services</section>
		<url>/pkg_edit.php?xml=openbgpd.xml&amp;id=0</url>
	</menu>
	<tabs>
		<tab>
			<text>Settings</text>
			<url>/pkg_edit.php?xml=openbgpd.xml&amp;id=0</url>
			<active/>
		</tab>
		<tab>
			<text>Neighbors</text>
			<url>/pkg.php?xml=openbgpd_neighbors.xml</url>
		</tab>
		<tab>
			<text>Groups</text>
			<url>/pkg.php?xml=openbgpd_groups.xml&amp;id=0</url>
		</tab>
		<tab>
			<text>Raw config</text>
			<url>/openbgpd_raw.php</url>
		</tab>
		<tab>
			<text>Status</text>
			<url>/openbgpd_status.php</url>
		</tab>
	</tabs>
	<plugins>
		<item>
			<type>plugin_carp</type>
		</item>
	</plugins>
	<fields>
		<field>
			<fielddescr>Autonomous Systems (AS) Number</fielddescr>
			<fieldname>asnum</fieldname>
			<description>Set the local autonomous system number to as-number.</description>
			<type>input</type>
		</field>

		<field>
			<fielddescr>Holdtime</fielddescr>
			<fieldname>holdtime</fieldname>
			<description>
				<![CDATA[
				Set the holdtime in seconds. The holdtime is reset to its initial value every time either a KEEPALIVE or an UPDATE message is received from the neighbor.<br />
				If the holdtime expires the session is dropped. The default is 90 seconds. Neighboring systems negotiate the holdtime used when the connection is established in the OPEN messages.<br />
				Each neighbor announces its configured hold- time; the smaller one is then agreed upon.
				]]>
			</description>
			<type>input</type>
		</field>

		<field>
			<fielddescr>fib-update</fielddescr>
			<fieldname>fibupdate</fieldname>
			<description>If set to no, do not update the Forwarding Information Base a.k.a. the kernel routing table. The default is yes.</description>
			<type>select</type>
			<options>
				<option><name>yes</name><value>yes</value></option>
				<option><name>no</name><value>no</value></option>
			</options>
		</field>
		<field>
			<fielddescr>Listen on IP</fielddescr>
			<fieldname>listenip</fieldname>
			<description>Specify the local IP address bgpd(8) should listen on, or leave blank to bind to all IPs.</description>
			<type>input</type>
		</field>

		<field>
			<fielddescr>Router IP</fielddescr>
			<fieldname>routerid</fieldname>
			<description>Set the router ID to the given IP address, which must be local to the machine.</description>
			<type>input</type>
		</field>
		<field>
			<fielddescr>CARP Status IP</fielddescr>
			<fieldname>carpstatusvid</fieldname>
			<description>
				<![CDATA[
				Used to determine the CARP status. When the CARP vhid is in BACKUP status, bgpd will not be started.<br />
				]]>
			</description>
			<type>select_source</type>
			<source><![CDATA[openbgpd_get_carp_list()]]></source>
			<source_name>name</source_name>
			<source_value>value</source_value>
		</field>
		<field>
			<fielddescr>Networks</fielddescr>
			<fieldname>network</fieldname>
			<type>rowhelper</type>
			<description></description>
			<rowhelper>
				<rowhelperfield>
					<fielddescr>
						<![CDATA[
						Announce the specified network as belonging to our AS. If set to "(inet|inet6)connected", inet or inet6 routes to directly attached networks will be announced.<br />
						If set to "(inet|inet6) static", all inet or inet6 static routes will be announced.
						]]>
					</fielddescr>
					<fieldname>networks</fieldname>
					<description>Network that you would like to advertise</description>
					<type>input</type>
					<size>45</size>
				</rowhelperfield>
			</rowhelper>
		</field>
	</fields>
	<custom_php_resync_config_command>
		openbgpd_install_conf();
	</custom_php_resync_config_command>
	<custom_php_validation_command>
		bgpd_validate_input();
	</custom_php_validation_command>
</packagegui>
OpenPOWER on IntegriCloud