FireBrick FB6202 V0.08.049 documentation

Top level config

The top level config element contains all of the FireBrick configuration data.

config: Attributes
Attribute	Type	Description	Default
timestamp	dateTime	Config store time, set automatically when config is saved
patch	integer	Internal use, for s/w updates that change config syntax

config: Elements
Element	Type	Instances	Description
system	system	Optional	System settings
user	user	Optional, unlimited	Admin users (for web/telnet access, etc)
syslog	syslog	Optional	Syslog controls (deprecated)
log	log	Optional, up to 50	Log target controls
services	services	Optional	General system services
ethernet	ethernet	Optional, unlimited	Physical port controls
port	portdef	Optional, up to 5	Port grouping and naming
interface	interface	Optional, up to 8192	Config ethernet port/vlan and subnets
ppp	pppoe	Optional, up to 10	PPPoE client settings
route	route (network-base)	Optional, unlimited	Static routes
network	network (network-base)	Optional, unlimited	List of locally originated networks
loopback	loopback (network-base)	Optional, unlimited	List of extra local addresses
bgp	bgp	Optional, up to 10	BGP config
cqm	cqm	Optional	Constant Quality Monitoring config
l2tp	l2tp	Optional	L2TP settings
profile	profile	Optional, unlimited	Control profiles
shaper	shaper (shaper-general)	Optional, unlimited	Named traffic shapers
ip-group	ip-group	Optional, unlimited	Named IP groups

IP Group

Named IP group

ip-group: Attributes
Attribute	Type	Description	Default
name	string	Name	Not optional
ip	List of IPRange	One or more IP ranges or IP/len
users	List of string	Include IP of logged in web users
source	string	Source of data, used in automated config management
comment	string	Comment

Traffic shaper override based on profile

Settings for a named traffic shaper

shaper-override: Attributes
Attribute	Type	Description	Default
tx	unsignedInt	Egress rate limit/target
tx-min	unsignedInt	Egress rate limit min
tx-max	unsignedInt	Egress rate limit max
tx-step	unsignedInt	Egress rate adjust step
tx-interval	duration	Egress rate adjust interval	PT1H
rx	unsignedInt	Ingress rate limit
rx-min	unsignedInt	Ingress rate limit min
rx-max	unsignedInt	Ingress rate limit max
rx-step	unsignedInt	Ingress rate adjust step
rx-interval	duration	Ingress rate adjust interval	PT1H
source	string	Source of data, used in automated config management
comment	string	Comment
profile	string	Profile name	Not optional

Traffic shaper

Settings for a named traffic shaper

shaper: Attributes
Attribute	Type	Description	Default
tx	unsignedInt	Egress rate limit/target
tx-min	unsignedInt	Egress rate limit min
tx-max	unsignedInt	Egress rate limit max
tx-step	unsignedInt	Egress rate adjust step
tx-interval	duration	Egress rate adjust interval	PT1H
rx	unsignedInt	Ingress rate limit
rx-min	unsignedInt	Ingress rate limit min
rx-max	unsignedInt	Ingress rate limit max
rx-step	unsignedInt	Ingress rate adjust step
rx-interval	duration	Ingress rate adjust interval	PT1H
source	string	Source of data, used in automated config management
comment	string	Comment
name	string	Graph name	Not optional

shaper: Elements
Element	Type	Instances	Description
override	shaper-override (shaper-general)	Optional, unlimited	Profile specific variations on main settings

Control profile ping test

Ping targets

profile-ping: Attributes
Attribute	Type	Description	Default
ip	IPAddr	Target IP	Not optional
ttl	unsignedByte	Time to live / Hop limit
flow	unsignedShort	Flow label (IPv6)
source-ip	IPAddr	Source IP
gateway	IPAddr	Ping via specific gateway

Control profile time range

Time range test in profiles

profile-time: Attributes
Attribute	Type	Description
days	Set of day	Which days of week apply, default all
start	time	Start time
stop	time	End time

Control profile by specific date/time range

Time range test in profiles

profile-date: Attributes
Attribute	Type	Description	Default
start	dateTime	Start date/time
stop	dateTime	End date/time

General control profile. If 'set' is set, then profile is overridden manually, else... If 'or' references an active profile this profile is active, else... If all tests pass or are not specified then this profile is active.

profile: Attributes
Attribute	Type	Description	Default
name	string	Profile name	Not optional
log	string	Log target	Not logging
interval	duration	Test frequency	1
timeout	duration	Time before timeout (i.e. how long test has been failing for)	10
recover	duration	Time before recover (i.e. how long test has been passing for)	1
vrrp	List of string	VRRP state (and of these is master)
ppp	List of string	PPP link state (any of these are up)
route	List of IPAddr	IPs, all of which must be routable to pass
set	boolean	Manual override, ignore all tests
and	List of string	Test: other profiles all active
not	string	Test: another profile is not active
or	List of string	Active if any of these other profiles active
table	routetable 0-99	Routing table for ping/route
source	string	Source of data, used in automated config management
comment	string	Comment

profile: Elements
Element	Type	Instances	Description
date	profile-date	Optional, unlimited	Specific date/time ranges
time	profile-time	Optional, unlimited	Time ranges
ping	profile-ping	Optional	Ping test

RADIUS accounting server settings

Server settings for RADIUS Accounting for L2TP

radius-acct: Attributes
Attribute	Type	Description	Default
name	string	Name
secret	Secret	Shared secret for RADIUS requests	Not optional
table	routetable 0-99	Routing table number
ip	List of IPAddr	One or more IPs of RADIUS servers (picked at random)	Not optional
relay-nas-ip	boolean	Pass remote L2TP endpoint as NAS IP
fail-count	unsignedInt	How many failures in a row before blacklisting	20
fail-time	duration	How long to blacklist before retrying (secs)	120
attempts	unsignedInt	How many concurrent requests to this server before trying next	200
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
timeout	duration	Min retry timeout on RADIUS requests	20
port	unsignedShort	Accounting UDP port	1813

RADIUS authentication server settings

Server settings for RADIUS Authentication for L2TP

radius-auth: Attributes
Attribute	Type	Description	Default
name	string	Name
secret	Secret	Shared secret for RADIUS requests	Not optional
table	routetable 0-99	Routing table number
ip	List of IPAddr	One or more IPs of RADIUS servers (picked at random)	Not optional
relay-nas-ip	boolean	Pass remote L2TP endpoint as NAS IP
fail-count	unsignedInt	How many failures in a row before blacklisting	20
fail-time	duration	How long to blacklist before retrying (secs)	120
attempts	unsignedInt	How many concurrent requests to this server before trying next	200
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
timeout	duration	Min retry timeout on RADIUS requests	5
port	unsignedShort	Authentication UDP port	1812

Relay and local authentication rules for L2TP

Rules for relaying L2TP or local authentication

l2tp-relay: Attributes
Attribute	Type	Description	Default
name	string	Name
graph	string	Graph name
user-name	List of string	One or more patterns to match user-name
password	Secret	Password check
calling-station-id	List of string	One or more patterns to match calling-station-id
called-station-id	List of string	One or more patterns to match called-station-id
remote-ip	IP4Addr	Remote end PPP IPv4 (local auth)
localpref	unsignedInt	Localpref for remote-ip/routes	4294967295
routes	List of IPPrefix	Additional routes when link up (local auth)
relay-ip	List of IPAddr	Target IP(s) for L2TP connection
relay-secret	Secret	Shared secret for L2TP connection
relay-hostname	string	Hostname for L2TP connection
test	List of IPAddr	List of IPs that must have routing for this target to be valid (deprecated)
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

L2TP settings for incoming L2TP connections

L2TP tunnel settings for incoming L2TP connections

l2tp-incoming: Attributes
Attribute	Type	Description	Default
name	string	Name
hostname	string	Hostname quoted on incoming tunnel
secret	Secret	Shared secret
graph	string	Graph name
table	routetable 0-99	Routing table number for L2TP session
test	List of IPAddr	List of IPs to which routing must exist else tunnel dropped (deprecated)
payload-table	routetable 0-99	Routing table number for payload traffic
bgp	bgpmode	BGP announce mode for routes
allow	List of IPNameRange	List of IP ranges from which connects can be made
mtu	unsignedShort	Default MTU for sessions in this tunnel
ipv6ep	IP4Addr	Local end IPv4 for IPv6 tunnels
pppip	IP4Addr	Local end PPP IPv4
pppdns1	IP4Addr	PPP DNS1 IPv4 default
pppdns2	IP4Addr	PPP DNS2 IPv4 default
dhcpv6dns	List of IP6Addr	List of IPv6 DNS servers
dos-limit	unsignedInt	Per second per session tx packet drop limit for DOS protection	10000
speed	unsignedInt	Default egress rate limit
hdlc	boolean	Send HDLC header (FF03) on all PPP frames	true
lcp-rate	unsignedByte	LCP interval (seconds)	1
lcp-timeout	unsignedByte	LCP timeout (seconds)	10
tcp-mss-fix	boolean	Adjust MSS option in TCP SYN to fix session MSS	false
lcp-mru-fix	boolean	Restart LCP if RAS negotiated MRU is too high	false
require-platform	boolean	All sessions require a platform RADIUS first	false
icmp-ppp	boolean	Use PPP endpoint for ICMP	false
damping	boolean	Apply damping to sessions if limiting on shaper	false
shutdown	boolean	Refuse all new sessions or tunnels	false
log	string	Log events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

l2tp-incoming: Elements
Element	Type	Instances	Description
match	l2tp-relay	Optional, unlimited	Rules for relaying inbound connections to outbound

L2TP settings

L2TP settings list the incoming and outgoing L2TP connections allowed

l2tp: Attributes
Attribute	Type	Description	Default
accounting-interval	duration	Periodic interim accounting interval	3600

l2tp: Elements
Element	Type	Instances	Description
incoming	l2tp-incoming	Optional, unlimited	Incoming L2TP connections
authentication	radius-auth (radius)	Optional, unlimited	RADIUS authentication server settings
accounting	radius-acct (radius)	Optional, unlimited	RADIUS accounting server settings

Constant Quality Monitoring settings

Constant quality monitoring (graphs and data) have a number of settings. Most of the graphing settings can be overridden when a graph is collected so these define the defaults in many cases.

cqm: Attributes
Attribute	Type	Description	Default
secret	Secret	Secret for MD5 coded URLs
heading	string	Heading of graph
subheading	string	Subheading of graph
text1	string	Text line 1
text2	string	Text line 2
text3	string	Text line 3
text4	string	Text line 4
background	Colour	Background colour	white
graticule	Colour	Graticule colour	grey
axis	Colour	Axis colour	black
label-fail	string	Label for seconds (%) failed	Fail
label-damp	string	Label for % shaper damping	Damp%
fail	Colour	Colour for failed (dropped) seconds	red
label-sent	string	Label for seconds polled	Sent
sent	Colour	Colour for polled seconds	#ff8
label-off	string	Label for off line seconds	Off
off	Colour	Colour for off line seconds	#c8f
label-min	string	Label for minimum latency	Min
min	Colour	Colour for minimum latency	blue
label-ave	string	Label for average latency	Ave
ave	Colour	Colour for average latency	#0cc
label-max	string	Label for maximum latency	Max
max	Colour	Colour for maximum latency	green
label-tx	string	Label for Tx traffic level	Tx
tx	Colour	Colour for Tx traffic level	#080
label-rx	string	Label for Rx traffic level	Rx
rx	Colour	Colour for Rx traffic level	#800
text	Colour	Colour for text	black
outside	Colour	Colour for outer border	transparent
fblogo	Colour	Colour for logo	#c00
label-latency	string	Label for latency	Latency
label-shaper	string	Label for shaper	Shaper
label-poll	string	Label for polls	Polls
label-traffic	string	Label for traffic level	Traffic (bit/s)
label-time	string	Label for time	Time
label-score	string	Label for score	Score
label-period	string	Label for period	Period
timeformat	string	Time format	%Y-%m-%d %H:%M:%S
hourformat	string	Hour format	%H
dateformat	string	Date format	%Y-%m-%d
dayformat	string	Day format	%a
key	unsignedByte	Pixels space for key	90
left	unsignedByte	Pixels space left of main graph	0
right	unsignedByte	Pixels space right of main graph	50
top	unsignedByte	Pixels space at top of graph	4
bottom	unsignedByte	Pixels space at bottom of graph	11
fail-level1	unsignedByte	Loss level 1	3
fail-score1	unsignedByte	Score for on/above level 1	100
fail-level2	unsignedByte	Loss level 2	50
fail-score2	unsignedByte	Score for on/above level 2	200
latency-level1	unsignedInt	Latency level 1 (ns)	100000000
latency-score1	unsignedByte	Score for on/above level 1	10
latency-level2	unsignedInt	Latency level 2 (ns)	500000000
latency-score2	unsignedByte	Score for on/above level 2	20
latency-usage	unsignedInt	Usage below which latency is not expected	128000
latency-level	unsignedInt	Latency level not expected on low usage	100000000
latency-score	unsignedByte	Score for high latency and low usage	200
fail-usage	unsignedInt	Usage below which fail is not expected	128000
fail-level	unsignedInt	Fail level not expected on low usage	1
fail-score	unsignedByte	Score for fail and low usage	200
log	string	Log events	Not logging

Individual mapping/filtering rule

An individual rule for BGP mapping/filtering

bgprule: Attributes
Attribute	Type	Description	Default
name	string	Name
drop	boolean	Do not import/export this prefix	false
detag	List of Community	List of community tags to remove
tag	List of Community	List of community tags to add
localpref	unsignedInt	Set localpref	100
med	unsignedInt	Set MED
source	string	Source of data, used in automated config management
comment	string	Comment
prefix	List of IPFilter	Prefixes that this rule applies to

Mapping and filtering rules of BGP prefixes

This defines the rules for mapping and filtering of prefixes to/from a BGP peer.

bgpmap: Attributes
Attribute	Type	Description	Default
name	string	Name
drop	boolean	Do not import/export this prefix	false
detag	List of Community	List of community tags to remove
tag	List of Community	List of community tags to add
localpref	unsignedInt	Set localpref	100
med	unsignedInt	Set MED
source	string	Source of data, used in automated config management
comment	string	Comment
prefix	List of IPFilter	Drop all that are not in this prefix list

bgpmap: Elements
Element	Type	Instances	Description
match	bgprule (bgpruleaction)	Optional, unlimited	List rules, in order of checking

BGP peer definitions

The peer definition specifies the attributes of an individual peer. Multiple IP addresses can be specified, typically for IPv4 and IPv6 addresses for the same peer, but this can be used for a group of similar peers.

bgppeer: Attributes
Attribute	Type	Description	Default
name	string	Name
type	peertype	Type of neighbour (affects some defaults)	normal
ip	List of IPAddr	One or more IPs of neighbours (omit to allow incoming)
as	unsignedInt	Peer AS
md5	Secret	MD5 signing secret
ttl-security	unsignedByte	Enable RFC5082 TTL security for specified number of hops (set to 1 for adjacent router) and set both ends
holdtime	unsignedInt	Hold time	30
timer-openwait	unsignedInt	Time to wait for OPEN on connection	10
timer-retry	unsignedInt	Time to retry the neighbour	10
timer-idle	unsignedInt	Idle time after error	60
capability-mpe-ipv4	boolean	If supporting MPE for IPv4	true
capability-mpe-ipv6	boolean	If supporting MPE for IPv6	true
capability-as4	boolean	If supporting AS4	true
capability-graceful-restart	boolean	If supporting Graceful Restart	true
capability-route-refresh	boolean	If supporting Route Refresh	true
same-ip-type	boolean	Only accept/send IPv4 routes to IPv4 peers and IPv6 routes to IPv6 peers	true
next-hop-self	boolean	Force us as next hop outbound	false
allow-own-as	boolean	Allow our AS inbound
add-own-as	boolean	Add our AS on exported routes
in-soft	boolean	Mark received routes as soft
no-fib	boolean	Don't include received routes in packet forwarding
allow-only-their-as	boolean	Only accept routes that are solely the peers AS
allow-export	boolean	Ignore no-export community and export anyway
drop-default	boolean	Ignore default route received	false
send-default	boolean	Send a default route to this peer	false
send-no-routes	boolean	Don't send any normal routes	false
ignore-bad-optional-partial	boolean	Ignore routes with a regognised badly formed optional that is flagged partial	true
shutdown	boolean	Shutdown this neighbour
log-debug	string	Log debug Also works as log, which is deprecated	Not logging
pad	unsignedByte	Pad (prefix stuff) our AS by this many
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
max-prefix	bgp-prefix-limit 1-1000	Limit prefixes (IPv4+IPv6)	10000

bgppeer: Elements
Element	Type	Instances	Description
import	bgpmap (bgpruleaction)	Optional, unlimited	Mapping and filtering rules of accepting prefixes from peer
export	bgpmap (bgpruleaction)	Optional, unlimited	Mapping and filtering rules of announcing prefixes to peer

Overall BGP settings

The BGP element defines general BGP settings and a list of peer definitions for the individual BGP peers.

bgp: Attributes
Attribute	Type	Description	Default
name	string	Name
table	routetable 0-99	Routing table number	0
as	unsignedInt	Our AS
id	IP4Addr	Our router ID
cluster-id	IP4Addr	Our cluster ID
log	string	Log events	Not logging
source	string	Source of data, used in automated config management
comment	string	Comment

bgp: Elements
Element	Type	Instances	Description
peer	bgppeer (bgppeer-base)	Optional, up to 50	List of peers/neighbours

Locally originated networks

Loopback addresses define local IP addresses

loopback: Attributes
Attribute	Type	Description	Default
name	string	Name
table	routetable 0-99	Routing table number	0
localpref	unsignedInt	Localpref of network	4294967295
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
profile	string	Profile name
bgp	bgpmode	BGP announce mode for routes
source	string	Source of data, used in automated config management
comment	string	Comment
ip	List of IPAddr	One or more local network addresses	Not optional

Locally originated networks

Network settings define prefixes which are to be announced by some routing protocol but do not actually have a routing entry.

network: Attributes
Attribute	Type	Description	Default
name	string	Name
table	routetable 0-99	Routing table number	0
localpref	unsignedInt	Localpref of network	4294967295
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
profile	string	Profile name
bgp	bgpmode	BGP announce mode for routes
source	string	Source of data, used in automated config management
comment	string	Comment
ip	List of IPPrefix	One or more local network prefixes	Not optional

Static routes

Static routes define prefixes which are permanently in the routing table, and whether these should be announced by routing protocols or not.

route: Attributes
Attribute	Type	Description	Default
name	string	Name
table	routetable 0-99	Routing table number	0
localpref	unsignedInt	Localpref of network	4294967295
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
profile	string	Profile name
bgp	bgpmode	BGP announce mode for routes
source	string	Source of data, used in automated config management
comment	string	Comment
speed	unsignedInt	Egress rate limit
graph	string	Graph name
ip	List of IPPrefix	One or more local network prefixes	Not optional
gateway	List of IPAddr	One or more target gateway IPs

PPP routes

Routes that apply when link is up

ppp-route: Attributes
Attribute	Type	Description	Default
name	string	Name
table	routetable 0-99	Routing table number	0
localpref	unsignedInt	Localpref of network	4294967295
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
profile	string	Profile name
bgp	bgpmode	BGP announce mode for routes
source	string	Source of data, used in automated config management
comment	string	Comment
ip	List of IPPrefix	One or more local network prefixes	Not optional

PPPoE client settings

PPPoE client endpoint settings

pppoe: Attributes
Attribute	Type	Description	Default
name	string	Name
port	string	Physical port number, or port group name
vlan	vlan 0-4095	VLAN ID (0=untagged)	0
service	string	Service name	Any service
ac-name	string	Access concentrator name	Any a/c name
username	string	User name
password	Secret	User password
mtu	unsignedShort	MTU for link	1492
speed	unsignedInt	Default egress rate limit
tcp-mss-fix	boolean	Adjust MSS option in TCP SYN to fix session MSS	true
lcp-rate	unsignedByte	LCP interval (seconds)	10
lcp-timeout	unsignedByte	LCP timeout (seconds)	61
routes	List of IPPrefix	Routes when link up	Default gateway
localpref	unsignedInt	Localpref for route	4294967295
bgp	bgpmode	BGP announce mode for routes
table	routetable 0-99	Routing table number for payload	From interface
local	IP4Addr	Local IPv4 address
remote	IP4Addr	Remote IPv4 address
graph	string	Graph name
log	string	Log events	Not logging
log-error	string	Log as events	Not logging
log-debug	string	Log debug	Not logging
mode	pppoe-mode	PPPoE server/client mode	client
cug	cug 1-32767	Closed user group ID
cug-restrict	boolean	Closed user group restricted traffic (only to/from same CUG ID)
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

pppoe: Elements
Element	Type	Instances	Description
route	ppp-route (network-base)	Optional, unlimited	Routes to apply when ppp link is up

DHCP server attributes

Additional DHCP server attributes (IP)

dhcp-attr-ip: Attributes
Attribute	Type	Description	Default
name	string	Name
id	unsignedByte	Attribute type code	Not optional
value	IP4Addr	Value	Not optional
force	boolean	Send even if not requested
comment	string	Comment

DHCP server attributes

Additional DHCP server attributes (number)

dhcp-attr-number: Attributes
Attribute	Type	Description	Default
name	string	Name
id	unsignedByte	Attribute type code	Not optional
value	unsignedInt	Value	Not optional
force	boolean	Send even if not requested
comment	string	Comment

DHCP server attributes

Additional DHCP server attributes (string)

dhcp-attr-string: Attributes
Attribute	Type	Description	Default
name	string	Name
id	unsignedByte	Attribute type code	Not optional
value	string	Value	Not optional
force	boolean	Send even if not requested
comment	string	Comment

DHCP server attributes

Additional DHCP server attributes (hex)

dhcp-attr-hex: Attributes
Attribute	Type	Description	Default
name	string	Name
id	unsignedByte	Attribute type code	Not optional
value	hexBinary	Value	Not optional
force	boolean	Send even if not requested
comment	string	Comment

DHCP server settings

Settings for DHCP server

dhcps: Attributes
Attribute	Type	Description	Default
name	string	Name
ip	List of IP4Range	Address pool	0.0.0.0/0
mac	List of up to 12 macprefix (hexBinary)	Partial or full MAC addresses
client-name	string	Client name match
class	string	CLass match
gateway	List of IP4Addr	Gateway	Our IP
dns	List of IP4Addr	DNS resolvers	Our IP
time	List of IP4Addr	Time server	Our IP
ntp	List of IP4Addr	NTP server	From system settings
syslog	List of IP4Addr	Syslog serve (deprecated)r	From system settings
domain	string	DNS domain	From system settings
boot	IP4Addr	Next/boot server
boot-file	string	Boot filename
lease	duration	Lease length	PT2H
force	boolean	Send all options ever if not requested
log	string	Log events (allocations)	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

dhcps: Elements
Element	Type	Instances	Description
send	dhcp-attr-hex	Optional, unlimited	Additional attributes to send
send-string	dhcp-attr-string	Optional, unlimited	Additional string attributes to send
send-number	dhcp-attr-number	Optional, unlimited	Additional numeric attributes to send
send-ip	dhcp-attr-ip	Optional, unlimited	Additional IP attributes to send

VRRP settings

VRRP settings provide virtual router redundancy for the FireBrick. Profile inactive does not disable vrrp but forces vrrp low priority.

vrrp: Attributes
Attribute	Type	Description	Default
name	string	Name
ip	List of IP4Addr	One or more IP addresses to annouce	Not optional
vrid	unsignedByte	VRID	Not optional
priority	unsignedByte	Normal priority	100
interval	unsignedByte	Transit interval (sec)	1
preempt	boolean	Whether pre-empt allowed	true
test	List of IPAddr	List of IPs to which routing must exist else low priority (deprecated)
low-priority	unsignedByte	Lower priority applicable until routing established	1
delay	unsignedInt	Delay after routing established before priority returns to normal	10
use-vmac	boolean	Whether to use the special VMAC or use normal MAC	false
answer-ping	boolean	Whether to answer PING to VRRP IPs when master	true
log	string	Log events	Not logging
log-errors	string	Log errors	log as event
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

Subnet settings

Subnet settings define the IP address(es) of the FireBrick, and also allow default routes to be set.

subnet: Attributes
Attribute	Type	Description	Default
name	string	Name
ip	List of IPSubnet	One or more IP/len	Automatic by DHCP
gateway	List of IPAddr	One or more gateways to install
ra	ramode	If to announce IPv6 RA for this subnet	false
ra-max	ra-max 4-1800	Max RA send interval	600
ra-min	ra-min 3-1350	Min RA send interval
ra-managed	dhcpv6control	RA 'M' (managed) flag
ra-other	dhcpv6control	RA 'O' (other) flag
ra-profile	string	Profile, if inactive then forces low priority RA
ra-mtu	unsignedShort	MTU to use on RA	As subnet
ra-dns	List of IP6Addr	List of recursive DNS servers in route announcements
localpref	unsignedInt	Localpref for subnet	4294967295
bgp	bgpmode	BGP announce mode for routes
mtu	unsignedShort	MTU for subnet
ttl	unsignedByte	TTL for originating traffic via subnet	64
arp-timeout	unsignedShort	Max lifetime on ARP and ND	60
broadcast	boolean	If broadcast address allowed	false
proxy-arp	boolean	Answer ARP/ND by proxy if we have routing	false
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

Physical/VLAN interface settings

The interface definition relates to a specific physical port and VLAN. It includes subnets and VRRP that apply to that interface.

interface: Attributes
Attribute	Type	Description	Default
name	string	Name
port	string	Port group name
vlan	vlan 0-4095	VLAN ID (0=untagged)	0
graph	string	Graph name
mtu	unsignedShort	MTU for this interface	1500
ra-client	boolean	Accept IPv6 RA and create auto config subnets and routes	true
table	routetable 0-99	Routing table applicable	0
cug	cug 1-32767	Closed user group ID
cug-restrict	boolean	Closed user group restricted traffic (only to/from same CUG ID)
ping	IPAddr	Ping address to add loss/latency to graph for interface
log	string	Log events including DHCP and related events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

interface: Elements
Element	Type	Instances	Description
subnet	subnet	Optional, unlimited	Define subnet
vrrp	vrrp	Optional, unlimited	Define VRRP settings
dhcp	dhcps	Optional, unlimited	DHCP server settings

Port grouping and naming

portdef: Attributes
Attribute	Type	Description	Default
name	string	Name	Not optional
ports	Set of port	Physical port(s)	Not optional
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

Physical port controls

Physical port attributes

ethernet: Attributes
Attribute	Type	Description	Default
port	port	Physical port	Not optional
autoneg	boolean	Perform link auto-negotiation	true
shutdown	boolean	Power down this port	false
crossover	Crossover	Port crossover configuration	auto
speed	LinkSpeed	Speed setting for this port	auto
duplex	LinkDuplex	Duplex setting for this port	auto
flow	LinkFlow	Flow control setting	none
clocking	LinkClock	Gigabit clock setting	prefer-master
yellow	LinkLED-y	Yellow LED setting	Tx
green	LinkLED-g	Green LED setting	Link/Activity

Matching rules for platform RADIUS

Rules for matching RADIUS requests

platform-radius-match: Attributes
Attribute	Type	Description	Default
name	string	Name
target-ip	List of IPAddr	Target IP(s) for L2TP connection
target-secret	Secret	Shared secret for L2TP connection
target-hostname	string	Hostname for L2TP connection
relay-ip	List of IPAddr	Address to copy RADIUS request
relay-port	unsignedShort	Authentication UDP port for copy RADIUS request	1812
relay-table	routetable 0-99	Routing table number for copy of RADIUS request
nsn-conditional	boolean	Only send NSN settings if username is not same as calling station id
nsn-tunnel-user-auth-method	unsignedInt	Additional response for GGSN usage
nsn-tunnel-override-username	unsignedByte	Additional response for GGSN usage
tunnel-client-return	boolean	Return tunnel client as radius IP
tunnel-assignment-id	string	Tunnel Assignment ID to send
class	string	Class field to send
dummy-ip	boolean	Send dummy framed IP response	true
tagged	boolean	Tag all attributes that can be
test	List of IPAddr	List of IPs that must have routing for this target to be valid (deprecated)
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
user-name	List of string	One or more patterns to match user-name
calling-station-id	List of string	One or more patterns to match calling-station-id
called-station-id	List of string	One or more patterns to match called-station-id

Platform RADIUS definition

Platform RADIUS server and proxy definitions

platform-radius: Attributes
Attribute	Type	Description	Default
name	string	Name
target-ip	List of IPAddr	Target IP(s) for L2TP connection
target-secret	Secret	Shared secret for L2TP connection
target-hostname	string	Hostname for L2TP connection
relay-ip	List of IPAddr	Address to copy RADIUS request
relay-port	unsignedShort	Authentication UDP port for copy RADIUS request	1812
relay-table	routetable 0-99	Routing table number for copy of RADIUS request
nsn-conditional	boolean	Only send NSN settings if username is not same as calling station id
nsn-tunnel-user-auth-method	unsignedInt	Additional response for GGSN usage
nsn-tunnel-override-username	unsignedByte	Additional response for GGSN usage
tunnel-client-return	boolean	Return tunnel client as radius IP
tunnel-assignment-id	string	Tunnel Assignment ID to send
class	string	Class field to send
dummy-ip	boolean	Send dummy framed IP response	true
tagged	boolean	Tag all attributes that can be
test	List of IPAddr	List of IPs that must have routing for this target to be valid (deprecated)
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
port	unsignedShort	Authentication UDP port	1812
acct-port	unsignedShort	Accounting UDP port	1813
secret	Secret	Shared secret for RADIUS requests (needed for replies)
log	string	Log events	Not logging
log-error	string	Log errors	Log as event

platform-radius: Elements
Element	Type	Instances	Description
match	platform-radius-match (platform-radius-target)	Optional, unlimited	Matching rules for specific responses

DNS service settings

Web management pages

dns-service: Attributes
Attribute	Type	Description	Default
table	routetable 0-99	Routing table number	0
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
log	string	Log events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
domain	string	Our domain
resolvers	List of IPAddr	Recursive DNS resolvers to use

HTTP service settings

Web management pages

http-service: Attributes
Attribute	Type	Description	Default
table	routetable 0-99	Routing table number	0
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
log	string	Log events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
port	unsignedShort	Service port	80
trusted	List of IPNameRange	List of IP ranges from which trusted access is allowed

Telnet service settings

Telnet control interface

telnet-service: Attributes
Attribute	Type	Description	Default
table	routetable 0-99	Routing table number	0
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
log	string	Log events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
port	unsignedShort	Service port	23

NTP service settings

The NTP settings define how the system clock is set, from what servers, and controls for dalylight saving (summer time). The defaults are those that apply to the EU

ntp-service: Attributes
Attribute	Type	Description	Default
table	routetable 0-99	Routing table number	0
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
log	string	Log events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
timeserver	List of IPNameAddr	List of time servers (IP or hostname) from which time may be set by ntp
tz1-name	string	Timezone 1 name	GMT
tz1-offset	duration	Timezone 1 offset from UTC	00:00:00
tz12-month	month	Timezone 1 to 2 month	Mar
tz12-date	datenum 1-31	Timezone 1 to 2 earliest date in month	25
tz12-day	day	Timezone 1 to 2 day of week of change	Sun
tz12-time	duration	Timezone 1 to 2 local time of change	01:00:00
tz2-name	string	Timezone 2 name	BST
tz2-offset	duration	Timezone 2 offset from UTC	01:00:00
tz21-month	month	Timezone 2 to 1 month	Oct
tz21-date	datenum 1-31	Timezone 2 to 1 earliest date in month	25
tz21-day	day	Timezone 2 to 1 day of week of change	Sun
tz21-time	duration	Timezone 2 to 1 local time of change	02:00:00

SNMP service settings

The SNMP service has general service settings and also specific attributes for SNMP such as community

snmp-service: Attributes
Attribute	Type	Description	Default
table	routetable 0-99	Routing table number	0
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
log	string	Log events	Not logging
log-error	string	Log errors	Log as event
log-debug	string	Log debug	Not logging
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment
port	unsignedShort	Service port	161
community	string	Community string	public

System services

System services are various generic services that the system provides, and allows access controls and settings for these to be specified. The service is only active if the corresponding element is included in services, otherwise it is disabled.

services: Elements
Element	Type	Instances	Description
snmp	snmp-service (service)	Optional	SNMP server settings
ntp	ntp-service (service)	Optional	NTP client settings (server not implimented yet)
telnet	telnet-service (service)	Optional	Telnet server settings
http	http-service (service)	Optional	HTTP server settings
dns	dns-service (service)	Optional	DNS service settings
platform-radius	platform-radius (platform-radius-target)	Optional	Platform RADIUS server/proxy settings

SNMP trap logger settings

Defines logging by SNMP trap

log-snmp: Attributes
Attribute	Type	Description	Default
server	IPNameAddr	SNMP server	Not optional
OID	string	OID to send	Not optional
port	unsignedShort	Server port	25
table	routetable 0-99	Routing table number for sending syslogs	0
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

Email logger settings

Defines logging to email

log-email: Attributes
Attribute	Type	Description	Default
to	string	Target email address	Not optional
from	string	Source email address	One made up using serial number
subject	string	Subject	From first line being logged
delay	duration	Delay before sending, since first event to send	PT1M
retry	duration	Delay before sending, since failed send	PT10M
hold-off	duration	Delay before sending, since last email	PT1H
server	IPNameAddr	Smart host to use rather than MX
port	unsignedShort	Server port	25
table	routetable 0-99	Routing table number for sending syslogs	0
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

Syslog logger settings

Defines logging to a syslog server

log-syslog: Attributes
Attribute	Type	Description	Default
server	IPNameAddr	Syslog server	Not optional
port	unsignedShort	Server port	514
severity	syslog-severity	Severity setting	NOTICE
facility	syslog-facility	Facility setting	LOCAL0
table	routetable 0-99	Routing table number for sending syslogs	0
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

Log target controls

Defines a named logging target

log: Attributes
Attribute	Type	Description	Default
name	string	Log target name	Not optional
flash	boolean	Log immediately to slow flash memory (use with care)
jtag	boolean	Log immediately jtag (development use only)
console	boolean	Log immediately to console
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

log: Elements
Element	Type	Instances	Description
syslog	log-syslog	Optional, unlimited	Syslog settings
email	log-email	Optional, unlimited	Email settings
snmp	log-snmp	Optional, unlimited	SNMP settings (TBA)

Syslog settings

Syslog settings specify where logging is to be sent using syslog.

syslog: Attributes
Attribute	Type	Description	Default
server	IPAddr	Server IP address	Not optional
port	unsignedShort	Server port	514
severity	syslog-severity	Log events that are this severe or more	NOTICE
facility	syslog-facility	Facility for log	LOCAL0
table	routetable 0-99	Routing table number for sending syslogs	0
log	string	Log events	Not logging

Admin users

User names, passwords and abilities for admin users

user: Attributes
Attribute	Type	Description	Default
name	username (string)	User name	Not optional
full-name	string	Full name
password	Password	User password
timeout	duration	Login idle timeout	PT5M
config	config-access	Config access level	full
level	user-level	Login level	ADMIN
otp	string	OTP serial number
allow	List of IPNameRange	Restrict logins to be from specific IP addresses
profile	string	Profile name
source	string	Source of data, used in automated config management
comment	string	Comment

System settings

The system settings are the top level attributes of the system which apply globally.

system: Attributes
Attribute	Type	Description	Default
name	string	System hostname
sw-update-profile	string	Profile name for when to load new s/w
contact	string	Contact name
location	string	Location description
intro	string	Home page text
log	string	Log system events	Web logs
log-error	string	Log system errors	Web/Flash/console
log-eth	string	Log Ethernet messages	Console
log-eth-error	string	Log Ethernet errors	Web/Flash/console
log-eth-debug	string	Log Ethernet debug	Web/Console
log-stats	string	Log one second stats	Not logging
log-debug	string	Log system debug messages	Not logging
log-panic	string	Log system panic messages	Web logs
fast-reboot	boolean	Debug - causes fast reboot on new code load
dos-limit	unsignedInt	Interrupt DoS packet limit, leave at default	1000
dos-delay	unsignedInt	Interrupt DoS restoration counter, leave at default	2
sw-update	autoloadtype	Load new software automatically	false
source	string	Source of data, used in automated config management
comment	string	Comment

BGP peer type

Peer type controls many of the defaults for a peer setting. It allows typical settings to be defined with one attribute that reflects the type of peer.

Tag	Description
normal	Normal BGP operation
transit	EBGP Mark received as no-export
peer	EBGP Mark received as no-export, only accept peer AS
customer	EBGP Allow export as if confederate, only accept peer AS
internal	IBGP allowing own AS
reflector	IBGP allowing own AS and working in route reflector mode
confederate	EBGP confederate
ixp	Internet exchange point peer on route server

Type of PPPoE connection

Tag	Description
client	Normal PPPoE client connects to access controller
bras-l2tp	PPPoE server mode linked to L2TP operation

BGP announcement mode

BGP mode defines the default advertisement mode for prefixes, based on well-known community tags

Tag	Description
false	Not included in BGP at all
no-advertise	Not included in BGP, not advertised at all
no-export	Not normally exported from local AS/confederation
local-as	Not exported from local AS
no-peer	Exported with no-peer community tag
true	Exported as normal with no special tags added

Control for RA and DHCPv6 bits

Tag	Description
false	Don't set bit or answer on DHCPv6
true	Set bit but do not answer on DHCPv6
dhcpv6	Set bit and do answer on DHCPv6

IPv6 route announce level

IPv6 route announcement mode and level

Tag	Description
false	Do not announce
low	Announce as low priority
medium	Announce as medium priority
high	Announce as high priority
true	Announce as default (medium) priority

Green LED setting

Tag	Description
Link/Activity	On when link up; blink when Tx or Rx activity
Duplex/Collision	On when full-duplex; blink when half-duplex and collisions detected
Rx	Blink when Rx activity
Off	Permanently off
On	Permanently on
Cycling	Cycling pattern

Yellow LED setting

Tag	Description
Duplex/Collision	On when full-duplex; blink when half-duplex and collisions detected
Activity	Blink when Tx or Rx activity
Fault	On when autonegotiation mismatch
Tx	Blink when Tx activity
Off	Permanently off
On	Permanently on
Cycling	Cycling pattern

Physical port Gigabit clock master/slave setting

Tag	Description
prefer-master	Master status negotiated; preference for master
prefer-slave	Master status negotiated; preference for slave
force-master	Master status forced
force-slave	Slave status forced

Physical port flow control setting

Tag	Description
none	No flow control
symmetric	Can support two-way flow control
send-pauses	Can send pauses but does not support pause reception
any	Can receive pauses and may send pauses if required

Physical port duplex setting

Tag	Description
half	Half-duplex
full	Full-duplex
auto	Duplex determined by autonegotiation

Physical port speed

Tag	Description
10M	10Mbit/sec
100M	100Mbit/sec
1G	1Gbit/sec
auto	Speed determined by autonegotiation

Crossover configuration

Physical port crossover configuration.

Tag	Description
auto	Crossover is determined automatically
MDI	Force no crossover

Physical port

Tag	Description
0	Port 0 (left)
1	Port 1 (right)

Day name (3 letter)

Tag	Description
Sun	Sunday
Mon	Monday
Tue	Tuesday
Wed	Wednesday
Thu	Thursday
Fri	Friday
Sat	Saturday

Month name (3 letter)

Tag	Description
Jan	January
Feb	February
Mar	March
Apr	April
May	May
Jun	June
Jul	July
Aug	August
Sep	September
Oct	October
Nov	November
Dec	December

Syslog facility

Syslog facility, usually used to control which log file the syslog is written to.

Tag	Description
KERN	Kernel messages
USER	User level messges
MAIL	Mail system
DAEMON	System Daemons
AUTH	Security/auth
SYSLOG	Internal to syslogd
LPR	Printer
NEWS	News
UUCP	UUCP
CRON	Cron deamon
AUTHPRIV	private security/auth
FTP	File transfer
12	Unused
13	Unused
14	Unused
15	Unused
LOCAL0	Local 0
LOCAL1	Local 1
LOCAL2	Local 2
LOCAL3	Local 3
LOCAL4	Local 4
LOCAL5	Local 5
LOCAL6	Local 6
LOCAL7	Local 7

Syslog severity

Log severity - different loggable events log at different levels.

Tag	Description
EMERG	System is unstable
ALERT	Action must be taken immediately
CRIT	Critical conditions
ERR	Error conditions
WARNING	Warning conditions
NOTICE	Normal but significant events
INFO	Informational
DEBUG	Debug level messages
NO-LOGGING	No logging

User login level

User login level - commands available are restricted according to assigned level.

Tag	Description
NOBODY	Unknown or not logged in user
GUEST	Guest user
USER	Normal unprivileged user
ADMIN	System administrator
DEBUG	System debugger

Type of access user has to config

Tag	Description
none	No access unless explicitly listed
view	View only access (no passwords)
read	Read only access (with passwords)
full	Full view and edit access

Type of s/w auto load

Tag	Description
false	Do no auto load
factory	Load factory releases
beta	Load beta test releases
alpha	Load test releases

Basic types

Type	Description
ses-id	[unsignedShort] Local session ID (1-65535)
tun-id	[unsignedShort] Local tunnel ID (1-20000)
dates	[datenum] Set of dates
routetableset	[routetable] Set of routetables
protolist	[unsignedByte] List of IP protocols
portlist	[PortRange] List of protocol port ranges
prefix4list	[IP4Prefix] List of IPv4 Prefixes
userlist	[username] List of user names
iprangelist	[IPRange] List of IPranges
bgp-prefix-limit	[unsignedInt] Maximum prefixes accepted on BGP session (1-1000)
filterlist	[IPFilter] List of IP Prefix filters
communitylist	[Community] List of BGP communities
prefixlist	[IPPrefix] List of IP Prefixes
unsignedIntList	[unsignedInt] List of integers
aslist	[unsignedIntList] List of AS numbers
cug	[unsignedShort] CUG ID (1-32767)
vlan	[unsignedShort] VLAN ID (0=untagged) (0-4095)
macprefix	[hexBinary] MAC prefix
macprefixlist	[macprefix] List of strings
ip4rangelist	[IP4Range] List of IP4ranges
ip4list	[IP4Addr] List of IPv4 addresses
ip6list	[IP6Addr] List of IPv6 addresses
ra-min	[unsignedShort] Route announcement min interval (seconds) (3-1350)
ra-max	[unsignedShort] Route announcement max interval (seconds) (4-1800)
subnetlist	[IPSubnet] List of subnets
stringlist	[string] List of strings
iplist	[IPAddr] List of IP addresses
datenum	[unsignedByte] Day number in month (1-31)
ipnamelist	[IPNameAddr] List of IP addresses or domain names
routetable	[unsignedByte] Route table number (0-99)
ipnamerangelist	[IPNameRange] List of IPranges or ip groups
username	[string] Login name
Secret	Secret/passphrase
Colour	#rgb #rrggbb #rgba #rrggbbaa colour
PortRange	xxx-xxx port range
Community	xxx:xxx community
Password	Password
IPFilter	Route filter
IPSubnet	IP address / bitlen
IP4Prefix	IPv4 address / bitlen
IP4Range	IPv4 address / bitlen or range
IPNameRange	IP address / bitlen or range or name
IPRange	IP address / bitlen or range
IPPrefix	IP address / bitlen
IP6Addr	IPv6 address
IP4Addr	IPv4 address
IPNameAddr	IP address or name
IPAddr	IP address
void	Internal use
time	HH:MM:SS time
dateTime	YYYY-MM-DDTHH:MM:SS date/time
duration	Period
boolean	Boolean
unsignedByte	unsigned byte integer (0-255)
unsignedShort	unsigned short integer (0-65535)
unsignedInt	unsigned integer (0-4294967295)
integer	integer (-2147483648-2147483647)
hexBinary	hex coded binary data
string	text string