FireBrick FB6202 V1.57.010 configuration objects

Top level config

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

config: Attributes
Attribute	Type	Description
ip	IPAddr	Config store IP address
patch	integer	Internal use, for s/w updates that change config syntax
serial	string	Serial number
timestamp	dateTime	Config store time, set automatically when config is saved
version	string	Code version
who	string	Config store username

config: Elements
Element	Type	Instances	Description
bgp	bgp	Optional, up to 100	BGP config
bgp-filter	namedbgpmap	Optional, unlimited	Mapping and filtering rules for use with BGP peers
blackhole	blackhole	Optional, unlimited	Black hole (dropped packets) networks
cqm	cqm	Optional	Constant Quality Monitoring config
dhcp-relay	dhcp-relay	Optional, unlimited	DHCP server settings for remote / relayed requests
eap	eap	Optional, unlimited	User access control via EAP
ethernet	ethernet	Optional, unlimited	Ethernet port settings
interface	interface	Optional, up to 8192	Ethernet interface (port-group/vlan) and subnets
ip-group	ip-group	Optional, unlimited	Named IP groups
l2tp	l2tp	Optional	L2TP settings
log	log	Optional, up to 50	Log target controls
loopback	loopback	Optional, unlimited	Extra local addresses
network	network	Optional, unlimited	Locally originated networks
nowhere	blackhole	Optional, unlimited	Dead end (icmp error) networks
port	portdef	Optional, up to 2	Port grouping and naming
ppp	pppoe	Optional, up to 10	PPPoE settings
profile	profile	Optional, unlimited	Control profiles
route	route	Optional, unlimited	Static routes
routing-tables	routing-table	Optional, unlimited	Routing table settings
services	services	Optional	General system services
shaper	shaper	Optional, unlimited	Named traffic shapers
system	system	Optional	System settings
user	user	Optional, unlimited	Admin users

System settings

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

system: Attributes
Attribute	Type	Description	Default
acme-directory	string	ACME server directory	https://acme-v02.api.letsencrypt.org/directory
acme-hostname	List of string	Public hostname(s) for FireBrick for HTTPS
acme-keygen	boolean	Automatically obtain private keys as needed	true
acme-profile	NMTOKEN	Profile for when to do ACME renewals
acme-renew	positiveInteger	Renewal before expiry (days)	30
acme-source-ip	IP46Addr	Source IP for ACME renewal
acme-terms-agreed-email	string	Put your email if you agree CA terms
busy-threshold	unsignedInt	Max non-idle time before damping eth rx (millisec)	200
comment	string	Comment
contact	string	Contact name
cpu-int-reserved	percentage 0-100	Min percentage of CPU earmarked for int processing	95
email	string	Contact email
eth-rx-batch	unsignedInt	Max packets serviced on one port before rechecking other port for idle	20
eth-rx-qsize	unsignedInt	Size of eth driver Rx queue	2000
eth-tx-qsize	unsignedInt	Size of eth driver Tx queue	2000
intro	string	Home page text
location	string	Location description
log	NMTOKEN	Log system events	Web/console
log-acme	NMTOKEN	Log ACME
log-acme-debug	NMTOKEN	Log ACME debug
log-acme-error	NMTOKEN	Log ACME errors
log-config	NMTOKEN	Log config load	Web/Flash/console
log-debug	NMTOKEN	Log system debug messages	Not logging
log-error	NMTOKEN	Log system errors	Web/Flash/console
log-eth	NMTOKEN	Log Ethernet messages	Web/console
log-eth-debug	NMTOKEN	Log Ethernet debug	Not logging
log-eth-error	NMTOKEN	Log Ethernet errors	Web/Flash/console
log-ppp-dump	ppp-dump	PPP dump format
log-route-nexthop	NMTOKEN	Log next hop changes	Not logged
log-stats	NMTOKEN	Log one second stats	Not logging
log-support	NMTOKEN	Log support messages (e.g. stack trace) Also works as log-panic, which is deprecated	Web logs
log-tcp-debug	NMTOKEN	Log TCP/TLS debug messages	Not logging
login-intro	string	Login page text
name	string	System hostname
pre-reboot-url	string	URL to GET prior to s/w reboot (typically to warn nagios)
source	string	Source of data, used in automated config management
sw-update	autoloadtype	Load new software automatically	false
sw-update-delay	fb-sw-update-delay 0-30	Number of days after release to wait before automatically upgrading	0
sw-update-profile	NMTOKEN	Profile name for when to load new s/w
table	routetable 0-99	Routing table number for system functions (s/w updates, etc)	0

system: Elements
Element	Type	Instances	Description
link	link	Optional, unlimited	Intro links

Web links

Links to other web pages

link: Attributes
Attribute	Type	Description	Default
comment	string	Comment
level	user-level	Login level required	GUEST
name	string	Link name
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
text	string	Link text
url	string	Link address

Default source IP for services using a given table

Default source IP for traffic originated by this FireBrick

routing-table: Attributes
Attribute	Type	Description	Default
name	string	Name
source-ip	IP46Addr	Default source IP for services
table	routetable 0-99	Routing table number	Not optional

Admin users

User names, passwords and abilities for admin users

user: Attributes
Attribute	Type	Description	Default
allow	List of IPNameRange	Restrict logins to be from specific IP addresses
comment	string	Comment
config	config-access	Config access level	full
full-name	string	Full name
level	user-level	Login level	ADMIN
local-only	boolean	Restrict access to locally connected Ethernet subnets only	false
name	username (NMTOKEN)	User name	Not optional
otp-seed	OTP	OTP seed (do not edit by hand) Also works as otp, which is deprecated
password	Password	User password	Not optional
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
table	routetable 0-99	Restrict login to specific routing table	0
timeout	duration	Login idle timeout (zero to stay logged in, not recommended)	5:00

User access controlled by EAP

Identities, passwords and access methods for access controlled with EAP

eap: Attributes
Attribute	Type	Description	Default
comment	string	Comment
full-name	string	Full name
methods	Set of eap-method	Allowed methods	Not optional
name	string	User or account name	Not optional
password	Secret	User password	Not optional
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
subsystem	eap-subsystem	Access controlled subsystem	Not optional

Log target controls

Named logging target

log: Attributes
Attribute	Type	Description	Default
colour	Colour	Colour used in web display
comment	string	Comment
console	boolean	Log immediately to console
flash	boolean	Log immediately to slow flash memory (use with care)
jtag	boolean	Log immediately jtag (development use only)
name	NMTOKEN	Log target name	Not optional
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
system	boolean	Include system logs on web/cli view

log: Elements
Element	Type	Instances	Description
email	log-email	Optional, unlimited	Email settings
syslog	log-syslog	Optional, unlimited	Syslog settings

Syslog logger settings

Logging to a syslog server

log-syslog: Attributes
Attribute	Type	Description	Default
comment	string	Comment
facility	syslog-facility	Facility setting	LOCAL0
port	unsignedShort	Server port	514
profile	NMTOKEN	Profile name
server	IPNameAddr	Syslog server	Not optional
severity	syslog-severity	Severity setting	NOTICE
source	string	Source of data, used in automated config management
source-ip	IPAddr	Use specific source IP
system-logs	boolean	Include generic system log messages as well
table	routetable 0-99	Routing table number for sending syslogs	0

Email logger settings

Logging to email

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

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
dns	dns-service	Optional	DNS service settings
http	http-service	Optional	Web server settings
radius	radius-service	Optional	RADIUS server/proxy settings
snmp	snmp-service	Optional	SNMP server settings
telnet	telnet-service	Optional	Telnet server settings
time	time-service	Optional	System time server settings Also works as ntp, which is deprecated

Web service settings

Web management pages

http-service: Attributes
Attribute	Type	Description	Default
access-control-allow-origin	string	Additional HTTP header
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
allow-acme	boolean	Allow limited port 80 HTTP access for ACME during renewal	true
certlist	List of NMTOKEN	Certificate(s) to be used for HTTPS sessions	use any suitable
comment	string	Comment
content-security-policy	string	Additional HTTP header
css-url	string	Additional CSS for web control pages
https-port	unsignedShort	Service port for HTTPS access	443
js-url	string	Additional javascript for web control pages (logged in/trusted-ip)
local-only	boolean	Restrict access to locally connected Ethernet subnets only	true
log	NMTOKEN	Log events	Not logging
log-client	NMTOKEN	Log client accesses	Not logging
log-client-debug	NMTOKEN	Log client accesses (debug)	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
mode	http-mode	Security mode	redirect-to-https-if-acme
port	unsignedShort	Service port for HTTP access	80
profile	NMTOKEN	Profile name
referrer-policy	string	Additional HTTP header	no-referrer
self-sign	boolean	Create self signed certificate for HTTPS when necessary	true
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number for access to service	All
trusted	List of IPNameRange	List of allowed IP ranges from which additional access to certain functions is available
x-content-type-options	string	Additional HTTP header	nosniff
x-frame-options	string	Additional HTTP header	SAMEORIGIN
x-xss-protection	string	Additional HTTP header	1; mode=block

DNS service settings

DNS forwarding resolver service

dns-service: Attributes
Attribute	Type	Description	Default
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
auto-dhcp	boolean	Forward and reverse DNS for names in DHCP using this domain
caching	boolean	Cache relayed DNS entries locally	true
comment	string	Comment
domain	string	Our domain
fallback	boolean	For incoming requests, if no server in required table, relay to any DNS available	true
fallback-table	routetable 0-99	For incoming requests, if no server in requesting table, relay to any DNS available in this table	Don't fallback
local-only	boolean	Restrict access to locally connected Ethernet subnets only	true
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
log-interface	List of NMTOKEN	Only do normal log for specific interface(s)	All interfaces
profile	NMTOKEN	Profile name
resolvers	List of IPAddr	Recursive DNS resolvers to use
resolvers-table	routetable 0-99	Routing table for specified resolvers	as table / 0
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number for access to service	All

dns-service: Elements
Element	Type	Instances	Description
block	dns-block	Optional, unlimited	Fixed local DNS host blocks
host	dns-host	Optional, unlimited	Fixed local DNS host entries

Fixed local DNS host settings

DNS forwarding resolver service

dns-host: Attributes
Attribute	Type	Description	Default
comment	string	Comment
ip	List of IPAddr	IP addresses to serve (or our IP if omitted)	Our IP
name	List of string	Host names (can use * as a part of a domain)	Not optional
profile	NMTOKEN	Profile name
restrict-interface	List of NMTOKEN	Only apply on certain interface(s)
restrict-to	List of IPNameRange	List of IP ranges to which this is served Also works as restrict, which is deprecated
reverse	boolean	Map reverse DNS as well
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table applicable	any
ttl	unsignedInt	Time to live	60

Fixed local DNS blocks

DNS forwarding resolver service

dns-block: Attributes
Attribute	Type	Description	Default
comment	string	Comment
name	List of string	Host names (can use * as a part of a domain)	Not optional
profile	NMTOKEN	Profile name
restrict-interface	List of NMTOKEN	Only apply on certain interface(s)
restrict-to	List of IPNameRange	List of IP ranges to which this is served Also works as restrict, which is deprecated
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table applicable	any
ttl	unsignedInt	Time to live	60

RADIUS service definition

RADIUS server and proxy definitions

radius-service: Attributes
Attribute	Type	Description	Default
acct-port	unsignedShort	Accounting UDP port	1813
auth-port	unsignedShort	Authentication UDP port	1812
authenticator	boolean	Require message authenticator
backup-ip	List of IPNameAddr	Target IP(s) or hostname for backup L2TP connection
class	string	Class field to send
comment	string	Comment
control-port	unsignedShort	Control UDP port (CoA/DM)	3799
dummy-ip	boolean	Send dummy framed IP response	true
erx-tunnel-switch-profile	string	Juniper attribute 91
erx-tunnel-virtual-router	string	Juniper attribute 8
erx-virtual-router-name	string	Juniper attribute 1 (Also SIN502 Context-Name) Also works as context-name, which is deprecated
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug
log-error	NMTOKEN	Log errors	Log as event
nsn-conditional	boolean	Only send NSN settings if username is not same as calling station id
nsn-tunnel-override-username	unsignedByte	Additional response for GGSN usage
nsn-tunnel-user-auth-method	unsignedInt	Additional response for GGSN usage
order	radiuspriority	Priority tagging of endpoints sent
profile	NMTOKEN	Profile name
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
secret	Secret	Shared secret for RADIUS requests (needed for replies)
source	string	Source of data, used in automated config management
tagged	boolean	Tag all attributes that can be
target-hostname	string	Hostname for L2TP connection
target-ip	List of IPNameAddr	Target IP(s) or hostname for primary L2TP connection
target-secret	Secret	Shared secret for L2TP connection
tunnel-assignment-id	string	Tunnel Assignment ID to send
tunnel-client-return	boolean	Return tunnel client as radius IP

radius-service: Elements
Element	Type	Instances	Description
match	radius-service-match	Optional, unlimited	Matching rules for specific responses
server	radius-server	Optional, unlimited	RADIUS server settings

Matching rules for RADIUS service

Rules for matching incoming RADIUS requests

radius-service-match: Attributes
Attribute	Type	Description	Default
allow	List of IPNameRange	Match source IP address of RADIUS request
authenticator	boolean	Require message authenticator
backup-ip	List of IPNameAddr	Target IP(s) or hostname for backup L2TP connection
called-station-id	List of string	One or more patterns to match called-station-id
calling-station-id	List of string	One or more patterns to match calling-station-id
class	string	Class field to send
comment	string	Comment
dummy-ip	boolean	Send dummy framed IP response	true
erx-tunnel-switch-profile	string	Juniper attribute 91
erx-tunnel-virtual-router	string	Juniper attribute 8
erx-virtual-router-name	string	Juniper attribute 1 (Also SIN502 Context-Name) Also works as context-name, which is deprecated
ip	List of IPNameRange	Match target IP address of RADIUS request
name	string	Name
nas-ip	List of IPNameRange	Match NAS-IP address in RADIUS request
nsn-conditional	boolean	Only send NSN settings if username is not same as calling station id
nsn-tunnel-override-username	unsignedByte	Additional response for GGSN usage
nsn-tunnel-user-auth-method	unsignedInt	Additional response for GGSN usage
order	radiuspriority	Priority tagging of endpoints sent
profile	NMTOKEN	Profile name
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
secret	Secret	Shared secret for RADIUS requests (needed for replies)
source	string	Source of data, used in automated config management
stop	boolean	Stop checking if this matches	true
tagged	boolean	Tag all attributes that can be
target-hostname	string	Hostname for L2TP connection
target-ip	List of IPNameAddr	Target IP(s) or hostname for primary L2TP connection
target-secret	Secret	Shared secret for L2TP connection
tunnel-assignment-id	string	Tunnel Assignment ID to send
tunnel-client-return	boolean	Return tunnel client as radius IP
username	List of string	One or more patterns to match username

RADIUS server settings

Server settings for outgoing RADIUS

radius-server: Attributes
Attribute	Type	Description	Default
comment	string	Comment
host	List of IPNameAddr	One or more hostname/IPs of RADIUS servers	Not optional
max-timeout	duration	Maximum final timeout	10
min-timeout	duration	Minimum final timeout	2
name	string	Name
port	unsignedShort	UDP port	From services/radius settings
profile	NMTOKEN	Profile name
queue	unsignedInt	Concurrent requests over all of these servers (per type)
scale-timeout	unsignedByte	Timeout scaling factor	2
secret	Secret	Shared secret for RADIUS requests	Not optional
source	string	Source of data, used in automated config management
source-ip	IPAddr	Fix source IP
table	routetable 0-99	Routing table number
type	Set of radiustype	Server type	All

Telnet service settings

Telnet control interface

telnet-service: Attributes
Attribute	Type	Description	Default
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
comment	string	Comment
local-only	boolean	Restrict access to locally connected Ethernet subnets only	true
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
port	unsignedShort	Service port	23
profile	NMTOKEN	Profile name
prompt	string	Prompt	system name
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number for access to service	All

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
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
comment	string	Comment
community	Secret	Community string	public
local-only	boolean	Restrict access to locally connected Ethernet subnets only	false
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
port	unsignedShort	Service port	161
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number for access to service	All

System time server settings

The time settings define which NTP servers to synchronize the system clock from, and provide controls for daylight saving (summer time). The defaults are those that apply to the EU

time-service: Attributes
Attribute	Type	Description	Default
allow	List of IPNameRange	List of IP ranges from which service can be accessed	Allow from anywhere
comment	string	Comment
legacy-timeserver	boolean	Serve legacy TIME service on UDP port 37	true
local-only	boolean	Restrict access to locally connected Ethernet subnets only	true
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
maxpoll	duration	NTP maximum poll rate	1024
minpoll	duration	NTP minimum poll rate	64
ntp-control-allow	List of IPNameRange	List of IP ranges from which control (ntpq) requests can be accessed	Allow from anywhere
ntp-control-local-only	boolean	Restrict control (ntpq) access to locally connected Ethernet subnets only	true
ntp-control-table	routetable 0-99	Routing table number for incoming control (ntpq) requests	All
ntp-peer-table	routetable 0-99	Routing table number used for outgoing ntp peer requests	0
ntp-servers	List of IPNameAddr	List of NTP time servers (IP or hostname) from which time may be synchronized and served by ntp (Null list disables NTP) Also works as ntpserver, which is deprecated	ntp.firebrick.ltd.uk
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number for access to service	All
tz1-name	string	Timezone 1 name	GMT
tz1-offset	duration	Timezone 1 offset from UTC	0
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-month	month	Timezone 1 to 2 month	Mar
tz12-time	time	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	1:00:00
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-month	month	Timezone 2 to 1 month	Oct
tz21-time	time	Timezone 2 to 1 local time of change	02:00:00

Physical port controls

Physical port attributes

ethernet: Attributes
Attribute	Type	Description	Default
autoneg	boolean	Perform link auto-negotiation	auto negotiate unless manual 10/100 speed and duplex are set
clocking	LinkClock	Gigabit clock setting	prefer-slave
crossover	Crossover	Port crossover configuration	auto
duplex	LinkDuplex	Duplex setting for this port	auto
flow	LinkFlow	Flow control setting	none
green	LinkLED-g	Green LED setting	Link/Activity
lacp	boolean	Send LACP packets	Auto
lldp	boolean	Send LLDP packets	true
optimise	boolean	enable PHY optimisations	true
port	port	Physical port	Not optional
power-saving	LinkPower	enable PHY power saving	full
profile	NMTOKEN	Profile name
send-fault	LinkFault	Send fault status
speed	LinkSpeed	Speed setting for this port	auto
yellow	LinkLED-y	Yellow LED setting	Tx

Port grouping and naming

portdef: Attributes
Attribute	Type	Description	Default
comment	string	Comment
name	NMTOKEN	Name	Not optional
ports	Set of port	Physical port(s)	Not optional
source	string	Source of data, used in automated config management
trunk	trunk-mode	Trunk ports	l2-hash

Port-group/VLAN interface settings

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

interface: Attributes
Attribute	Type	Description	Default
allow-6in4	boolean	Handle 6in4 (protocol 41) packets	false
bgp	bgpmode	BGP announce mode for routes	Auto
comment	string	Comment
cug	cug 1-32767	Closed user group ID
cug-restrict	boolean	Closed user group restricted traffic (only to/from same CUG ID)
dhcp-relay	IP4Addr	Relay any unresolved requests to external server
fast-l2tp	boolean	Set on interfaces that are mainly terminating L2TP traffic
graph	graphname (token)	Graph name
link	NMTOKEN	Interface to which this is linked at layer 2
log	NMTOKEN	Log events including DHCP and related events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
mtu	mtu 576-2000	MTU for this interface	1500
name	NMTOKEN	Name
ping	IPAddr	Ping address to add loss/latency to graph for interface
port	NMTOKEN	Port group name	Not optional
profile	NMTOKEN	Profile name
ra-client	boolean	Accept IPv6 RA and create auto config subnets and routes	true
restrict-mac	boolean	Use only one MAC on this interface
source	string	Source of data, used in automated config management
source-filter	sfoption	Source filter traffic received via this interface
source-filter-table	routetable 0-99	Routing table to use for source filtering checks	interface table
table	routetable 0-99	Routing table applicable	0
vlan	vlan 0-4095	VLAN ID (0=untagged)	0
wan	boolean	Do not consider this interface 'local' for 'local-only' checks

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

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
accept-dns	boolean	Accept DNS servers specified by DHCP	true
arp-timeout	unsignedShort	Max lifetime on ARP and ND	60
bgp	bgpmode	BGP announce mode for routes	Auto
broadcast	boolean	If broadcast address allowed	false
comment	string	Comment
dhcp-class	string	DHCP client option 60 (Class)	FB-type
dhcp-client-id	string	DHCP client option 61 (Client-Identifier)	MAC
gateway	List of IPAddr	One or more gateways to install
ip	List of IPSubnet	One or more IP/len	Automatic by DHCP
localpref	unsignedInt	Localpref for subnet (highest wins)	4294967295
mtu	mtu 576-2000	MTU for subnet	As interface
name	string	Name
profile	NMTOKEN	Profile name
proxy-arp	boolean	Answer ARP/ND by proxy if we have routing	false
ra	ramode	If to announce IPv6 RA for this subnet	false
ra-dns	List of IP6Addr	List of recursive DNS servers in route announcements	Our IP
ra-dnssl	List of string	List of DNS search domains in route announcements
ra-managed	dhcpv6control	RA 'M' (managed) flag
ra-max	ra-max 4-1800	Max RA send interval	600
ra-min	ra-min 3-1350	Min RA send interval	ra-max/3
ra-mtu	unsignedShort	MTU to use on RA	As subnet
ra-other	dhcpv6control	RA 'O' (other) flag
ra-profile	NMTOKEN	Profile, if inactive then forces low priority RA
source	string	Source of data, used in automated config management
test	IPAddr	Test link state using ARP/ND for this IP
ttl	unsignedByte	TTL for originating traffic via subnet	64

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
answer-ping	boolean	Whether to answer PING to VRRP IPs when master	true
comment	string	Comment
delay	unsignedInt	Delay after routing established before priority returns to normal	60
interval	unsignedShort	Transit interval (centiseconds)	100
ip	List of IPAddr	One or more IP addresses to announce	Not optional
log	NMTOKEN	Log events	Not logging
log-error	NMTOKEN	Log errors	log as event
low-priority	unsignedByte	Lower priority applicable until routing established	1
name	NMTOKEN	Name
preempt	boolean	Whether pre-empt allowed	true
priority	unsignedByte	Normal priority	100
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
use-vmac	boolean	Whether to use the special VMAC or use normal MAC	true
version3	boolean	Use only version 3	v2 for IPv4, v3 for IPv6
vrid	unsignedByte	VRID	42

DHCP server settings

Settings for DHCP server

dhcps: Attributes
Attribute	Type	Description	Default
boot	IP4Addr	Next/boot server
boot-file	string	Boot filename
broadcast	boolean	Broadcast replies even if not requested
circuit	string	Agent info circuit match
class	string	Vendor class match
client-name	string	Client name match
comment	string	Comment
dns	List of IP4Addr	DNS resolvers	Our IP
domain	string	DNS domain	From system settings
domain-search	string	DNS domain search list (list will be truncated to fit one attribute)
force	boolean	Send all options even if not requested
gateway	IP4Subnet	Gateway	Our IP
ip	List of IP4Range	Address pool	0.0.0.0/0
lease	duration	Lease length	2:00:00
log	NMTOKEN	Log events (allocations)	Not logging
mac	List of up to 12 macprefix (hexBinary)	Partial or full client hardware (MAC) addresses (or client-id MAC if specified)
name	string	Name
ntp	List of IP4Addr	NTP server	Our IP
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
syslog	List of IP4Addr	Syslog server
time	List of IP4Addr	Time server	Our IP

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

DHCP server attributes (hex)

Additional DHCP server attributes (hex)

dhcp-attr-hex: Attributes
Attribute	Type	Description	Default
comment	string	Comment
force	boolean	Send even if not requested
id	unsignedByte	Attribute type code/tag	Not optional
name	string	Name
value	hexBinary	Value	Not optional
vendor	boolean	Add as vendor specific option (under option 43)

DHCP server attributes (string)

Additional DHCP server attributes (string)

dhcp-attr-string: Attributes
Attribute	Type	Description	Default
comment	string	Comment
force	boolean	Send even if not requested
id	unsignedByte	Attribute type code/tag	Not optional
name	string	Name
value	string	Value	Not optional
vendor	boolean	Add as vendor specific option (under option 43)

DHCP server attributes (numeric)

Additional DHCP server attributes (numeric)

dhcp-attr-number: Attributes
Attribute	Type	Description	Default
comment	string	Comment
force	boolean	Send even if not requested
id	unsignedByte	Attribute type code/tag	Not optional
name	string	Name
value	unsignedInt	Value	Not optional
vendor	boolean	Add as vendor specific option (under option 43)

DHCP server attributes (IP)

Additional DHCP server attributes (IP)

dhcp-attr-ip: Attributes
Attribute	Type	Description	Default
comment	string	Comment
force	boolean	Send even if not requested
id	unsignedByte	Attribute type code/tag	Not optional
name	string	Name
value	IP4Addr	Value	Not optional
vendor	boolean	Add as vendor specific option (under option 43)

PPPoE settings

PPPoE endpoint settings

pppoe: Attributes
Attribute	Type	Description	Default
ac-name	string	Access concentrator name	Any a/c name as client, else same as 'name'
accept-dns	boolean	Accept DNS servers specified by far end	true
auto-percent	unsignedByte	Try to set egress based on connect message, percentage	N/A
bgp	bgpmode	BGP announce mode for routes	Auto
calling-id	pppoe-calling	Add mac and/or vlan after prefix
calling-prefix	string	Prefix on calling number (BRAS mode)
comment	string	Comment
cug	cug 1-32767	Closed user group ID
cug-restrict	boolean	Closed user group restricted traffic (only to/from same CUG ID)
eth	port	Physical port connected to modem (for port reset)
fast-retry	boolean	Aggressive re-connect
graph	graphname (token)	Graph name
ip-over-lcp	boolean	Sends all IP packets as LCP	auto
lcp-rate	unsignedByte	LCP interval (seconds)	10
lcp-timeout	unsignedByte	LCP timeout (seconds)	61
local	IP4Addr	Local IPv4 address
localpref	unsignedInt	Localpref for route (highest wins)	4294967295
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log as events	Not logging
mode	pppoe-mode	PPPoE server/client mode	client
mtu	mtu 576-2000	MTU for link	1492
name	NMTOKEN	Name
password	Secret	User password
pd-interface	List of NMTOKEN	Interfaces for IPv6 prefix delegation	Auto
port	NMTOKEN	Port group name
profile	NMTOKEN	Profile name
remote	IP4Addr	Remote IPv4 address
rfc4638	boolean	Send RFC4638 PPP-Max-Payload	If over 1492 MTU
routes	List of IPPrefix	Routes when link up	Default gateway
service	string	Service name	Any service
source	string	Source of data, used in automated config management
speed	unsignedInt	Default egress rate limit (b/s)
table	routetable 0-99	Routing table number for payload
tcp-mss-fix	boolean	Adjust MSS option in TCP SYN to fix session MSS	true
username	string	User name
vlan	vlan 0-4095	VLAN ID (0=untagged)	0

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

PPP routes

Routes that apply when link is up

ppp-route: Attributes
Attribute	Type	Description	Default
bgp	bgpmode	BGP announce mode for routes	Auto
comment	string	Comment
ip	List of IPPrefix	One or more network prefixes	Not optional
localpref	unsignedInt	Localpref of network (highest wins)	4294967295
name	string	Name
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management

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
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
bgp	bgpmode	BGP announce mode for routes	Auto
comment	string	Comment
gateway	List of IPAddr	One or more target gateway IPs	Not optional
graph	graphname (token)	Graph name
ip	List of IPPrefix	One or more network prefixes	Not optional
localpref	unsignedInt	Localpref of network (highest wins)	4294967295
name	string	Name
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
speed	unsignedInt	Egress rate limit (b/s)
table	routetable 0-99	Routing table number	0
tag	List of Community	List of community tags

Locally originated networks

Network blocks that are announced but not actually added to internal routes - note that blackhole and nowhere objects can also announce but add routing.

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

Dead end networks

Networks that go nowhere

blackhole: Attributes
Attribute	Type	Description	Default
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
bgp	bgpmode	BGP announce mode for routes	false
comment	string	Comment
ip	List of IPPrefix	One or more network prefixes	Not optional
localpref	unsignedInt	Localpref of network (highest wins)	4294967295
name	string	Name
no-fib	boolean	Route not in forwarding, only for EBGP
profile	NMTOKEN	Profile name
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number	0
tag	List of Community	List of community tags

Locally originated networks

Loopback addresses define local IP addresses

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

Mapping and filtering rules of BGP prefixes

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

namedbgpmap: Attributes
Attribute	Type	Description	Default
comment	string	Comment
name	NMTOKEN	Name	Not optional
source	string	Source of data, used in automated config management

namedbgpmap: Elements
Element	Type	Instances	Description
match	bgprule	Optional, unlimited	List rules, in order of checking

Individual mapping/filtering rule

An individual rule for BGP mapping/filtering

bgprule: Attributes
Attribute	Type	Description
as-origin	unsignedInt	AS that must be last in path to match
as-present	unsignedInt	AS that must be present in path to match
comment	string	Comment
community	Community	Community that must be present to match
detag	List of Community	List of community tags to remove
drop	boolean	Do not import/export this prefix
localpref	unsignedInt	Set localpref (highest wins)
med	unsignedInt	Set MED
name	string	Name
no-community	Community	Community that must not be present to match
pad	unsignedByte	Pad (prefix stuff) our AS on export by this many, can be zero to not send our AS
prefix	List of IPFilter	Prefixes that this rule applies to
source	string	Source of data, used in automated config management
tag	List of Community	List of community tags to add

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
as	unsignedInt	Our AS
blackhole-community	Community	Community tag to mark black hole routes
cluster-id	IP4Addr	Our cluster ID
comment	string	Comment
dead-end-community	Community	Community tag to mark dead end routes
greyhole-community	Community	Community tag to mark black hole routes with no-fib
id	IP4Addr	Our router ID
log	NMTOKEN	Log events	Not logging
name	string	Name
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table number	0

bgp: Elements
Element	Type	Instances	Description
peer	bgppeer	Optional, up to 500	List of peers/neighbours

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
add-own-as	boolean	Add our AS on exported routes
allow-export	boolean	Ignore no-export community and export anyway	true for customer
allow-only-their-as	boolean	Only accept routes that are solely the peers AS
allow-own-as	boolean	Allow our AS inbound
as	unsignedInt	Peer AS
blackhole-community	Community	Egress community tag to mark black hole routes	Not announced on EBGP, our blackhole-community if IBGP
capability-as4	boolean	If supporting AS4	true
capability-graceful-restart	boolean	If supporting Graceful Restart	true
capability-mpe-ipv4	boolean	If supporting MPE for IPv4	true
capability-mpe-ipv6	boolean	If supporting MPE for IPv6	true
capability-route-refresh	boolean	If supporting Route Refresh	true
clean-shutdown-wait	duration	Send peers low priority and delay on shutdown
clean-startup-wait	duration	Don't announce routes within this time of reboot
comment	string	Comment
drop-default	boolean	Ignore default route received	false
export-filters	List of NMTOKEN	Named export filters to apply
export-med	unsignedInt	Set MED on exported routes (unless export filter sets it)
holdtime	unsignedInt	Hold time	30
ignore-bad-optional-partial	boolean	Ignore routes with a recognised badly formed optional that is flagged partial	true
import-filters	List of NMTOKEN	Named import filters to apply
import-localpref	unsignedInt	Set localpref on imported routes (unless import filter sets it)
import-tag	List of Community	List of community tags to add in addition to any import filters
in-soft	boolean	Mark received routes as soft
ip	List of IPAddr	One or more IPs of neighbours (omit to allow incoming)
log-debug	NMTOKEN	Log debug	Not logging
max-prefix	unsignedInt	Limit prefixes (IPv4+IPv6)
md5	Secret	MD5 signing secret
name	string	Name
next-hop-self	boolean	Force us as next hop outbound	false
no-fib	boolean	Don't include received routes in packet forwarding
pad	unsignedByte	Pad (prefix stuff) our AS on export by this many
profile	NMTOKEN	Profile name
reduce-recursion	boolean	Override incoming next hop if not local subnet	false
same-ip-type	boolean	Only accept/send IPv4 routes to IPv4 peers and IPv6 routes to IPv6 peers	true
send-default	boolean	Send a default route to this peer	false
send-no-routes	boolean	Don't send any normal routes	false
source	string	Source of data, used in automated config management
timer-idle	unsignedInt	Idle time after error	60
timer-openwait	unsignedInt	Time to wait for OPEN on connection	10
timer-retry	unsignedInt	Time to retry the neighbour	10
ttl-security	byte	Enable RFC5082 TTL security (if +ve, 1 to 127), i.e. 1 for adjacent router. If -ve (-1 to -128) set forced sending TTL, i.e. -1 for TTL of 1 sending, and not checking.
type	peertype	Type of neighbour (affects some defaults)	normal
use-vrrp-as-self	boolean	Use VRRP address as self if possible	true if customer/transit type

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

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
comment	string	Comment
detag	List of Community	List of community tags to remove
drop	boolean	Do not import/export this prefix
localpref	unsignedInt	Set localpref (highest wins)
med	unsignedInt	Set MED
prefix	List of IPFilter	Drop all that are not in this prefix list
source	string	Source of data, used in automated config management
tag	List of Community	List of community tags to add

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

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
ave	Colour	Colour for average latency	#08f
axis	Colour	Axis colour	black
background	Colour	Background colour	white
bottom	unsignedByte	Pixels space at bottom of graph	11
dateformat	string	Date format	%Y-%m-%d
dayformat	string	Day format	%a
fail	Colour	Colour for failed (dropped) seconds	red
fail-level	unsignedInt	Fail level not expected on low usage	1
fail-level1	unsignedByte	Loss level 1	3
fail-level2	unsignedByte	Loss level 2	50
fail-score	unsignedByte	Score for fail and low usage	200
fail-score1	unsignedByte	Score for on/above level 1	100
fail-score2	unsignedByte	Score for on/above level 2	200
fail-usage	unsignedInt	Usage below which fail is not expected	128000
fblogo	Colour	Colour for logo	#bd1220
graticule	Colour	Graticule colour	grey
heading	string	Heading of graph
hourformat	string	Hour format	%H
key	unsignedByte	Pixels space for key	90
label-ave	string	Label for average latency	Ave
label-damp	string	Label for % shaper damping	Damp%
label-fail	string	Label for seconds (%) failed	%Fail
label-latency	string	Label for latency	Latency
label-max	string	Label for maximum latency	Max
label-min	string	Label for minimum latency	Min
label-off	string	Label for off line seconds	Off
label-period	string	Label for period	Period
label-poll	string	Label for polls	Polls
label-rej	string	Label for rejected seconds	%Reject
label-rx	string	Label for Rx traffic level	Rx
label-score	string	Label for score	Score
label-sent	string	Label for seconds polled	Sent
label-shaper	string	Label for shaper	Shaper
label-time	string	Label for time	Time
label-traffic	string	Label for traffic level	Traffic (bit/s)
label-tx	string	Label for Tx traffic level	Tx
latency-level	unsignedInt	Latency level not expected on low usage	100000000
latency-level1	unsignedInt	Latency level 1 (ns)	100000000
latency-level2	unsignedInt	Latency level 2 (ns)	500000000
latency-score	unsignedByte	Score for high latency and low usage	200
latency-score1	unsignedByte	Score for on/above level 1	10
latency-score2	unsignedByte	Score for on/above level 2	20
latency-usage	unsignedInt	Usage below which latency is not expected	128000
left	unsignedByte	Pixels space left of main graph	0
log	NMTOKEN	Log events	Not logging
marker-width	string	Marker + on tx/rx
max	Colour	Colour for maximum latency	green
min	Colour	Colour for minimum latency	#008
ms-max	positiveInteger	ms max height	500
off	Colour	Colour for off line seconds	#c8f
outside	Colour	Colour for outer border	transparent
rej	Colour	Colour for off line seconds	#f8c
right	unsignedByte	Pixels space right of main graph	50
rx	Colour	Colour for Rx traffic level	#800
secret	Secret	Secret for SHA1 coded URLs
sent	Colour	Colour for polled seconds	#ff8
share-interface	NMTOKEN	Interface on which to broadcast data for shaper sharing
share-secret	Secret	Secret to validate shaper sharing
stroke-width	string	Stroke line tx/rx
subheading	string	Subheading of graph
svg-css	string	URL for SVG CSS instead of local style settings
svg-title	boolean	Include mouseover title text on svg
text	Colour	Colour for text	black
text1	string	Text line 1
text2	string	Text line 2
text3	string	Text line 3
text4	string	Text line 4
timeformat	string	Time format	%Y-%m-%d %H:%M:%S
top	unsignedByte	Pixels space at top of graph	4
tx	Colour	Colour for Tx traffic level	#080

L2TP settings

L2TP settings for incoming L2TP connections

l2tp: Attributes
Attribute	Type	Description	Default
accounting-interval	duration	Periodic interim accounting interval	1:00:00
send-acct-delay	boolean	Send Acct-Delay as well as Event-Timestamp on accounting

l2tp: Elements
Element	Type	Instances	Description
incoming	l2tp-incoming	Optional, unlimited	Incoming L2TP connections

L2TP settings for incoming L2TP connections

L2TP tunnel settings for incoming L2TP connections

l2tp-incoming: Attributes
Attribute	Type	Description	Default
allow	List of IPNameRange	List of IP ranges from which connects can be made
bgp	bgpmode	BGP announce mode for routes	Auto
comment	string	Comment
damping	boolean	Apply damping to sessions if limiting on shaper	false
dhcpv6dns	List of IP6Addr	List of IPv6 DNS servers
dos-limit	unsignedInt	Per second per session tx packet drop limit for DOS protection	10000
fail-lockout	unsignedByte	Interval kept in failed state	60
graph	string	Graph name
hdlc	boolean	Send HDLC header (FF03) on all PPP frames	true
hello-interval	unsignedByte	Interval between HELLO messages	60
icmp-ppp	boolean	Use PPP endpoint for ICMP	false
ipv6ep	IP4Addr	Local end IPv4 for IPv6 tunnels
lcp-data-len	unsignedByte	LCP data field length
lcp-mru-fix	boolean	Restart LCP if RAS negotiated MRU is too high	false
lcp-rate	unsignedByte	LCP interval (seconds)	1
lcp-timeout	unsignedByte	LCP timeout (seconds)	10
local-hostname	string	Hostname quoted on reply	System name
local-ppp-ip	IP4Addr	Local end PPP IPv4 Also works as pppip, which is deprecated
log	NMTOKEN	Log events	Not logging
log-debug	NMTOKEN	Log debug	Not logging
log-error	NMTOKEN	Log errors	Log as event
mtu	mtu 576-2000	Default MTU for sessions in this tunnel
name	string	Name
open-timeout	unsignedByte	Interval before OPEN considered failed	60
payload-table	routetable 0-99	Routing table number for payload traffic	0
ppp-final-timeout	unsignedByte	PPP total timeout (seconds)	60
ppp-init-timeout	unsignedByte	PPP initial timeout (seconds)	10
pppdns1	IP4Addr	PPP DNS1 IPv4 default
pppdns2	IP4Addr	PPP DNS2 IPv4 default
profile	NMTOKEN	Profile name
radius	string	Name for RADIUS server config to use
radius-nas-ip	radius-nas	Pass remote (LAC) or local (LNS) as RADIUS NAS IP / port Also works as relay-nas-ip, which is deprecated	lac
receive-window	unsignedShort	Receive window to advise on connection	Not sent
remote-hostname	string	Hostname expected on connection
require-platform	boolean	All sessions require a platform RADIUS first	false
require-radius-acct	boolean	Close session if cannot do RADIUS accounting
retry-timeout	unsignedByte	Interval to retry sending control messages before fail	60
secret	Secret	Shared secret (for far end to check)
shutdown	boolean	Refuse all new sessions or tunnels	false
source	string	Source of data, used in automated config management
source-ip	IPAddr	IP of our end for relayed (on same table) Also works as relay-local-ip, which is deprecated
speed	unsignedInt	Default egress rate limit (b/s)
table	routetable 0-99	Routing table number for L2TP session	Any
tcp-mss-fix	boolean	Adjust MSS option in TCP SYN to fix session MSS	false

l2tp-incoming: Elements
Element	Type	Instances	Description
match	l2tp-relay	Optional, unlimited	Rules for relaying connections and local authentication

Relay and local authentication rules for L2TP

Rules for relaying L2TP or local authentication

l2tp-relay: Attributes
Attribute	Type	Description	Default
called-station-id	List of string	One or more patterns to match called-station-id
calling-station-id	List of string	One or more patterns to match calling-station-id
comment	string	Comment
graph	graphname (token)	Graph name
ip-over-lcp	boolean	Send IP over LCP (local auth)
lcp-echo-mim	boolean	Handle LCP echos in the middle on relayed connection
localpref	unsignedInt	Localpref for remote-ppp-ip/routes (highest wins)	4294967295
name	string	Name
password	Secret	Password check
payload-table	routetable 0-99	Routing table number for payload traffic (or L2TP relay)	As per l2tp-incoming
profile	NMTOKEN	Profile name
relay-hostname	string	Hostname for L2TP connection
relay-ip	List of IPAddr	Target IP(s) for L2TP connection
relay-pick	boolean	If set, try one of the relay IPs at random first
relay-secret	Secret	Shared secret for L2TP connection
remote-netmask	IP4Addr	Remote end PPP Netmask (local auth)
remote-ppp-ip	IP4Addr	Remote end PPP IPv4 (local auth) Also works as remote-ip, which is deprecated
routes	List of IPPrefix	Additional routes when link up (local auth)
source	string	Source of data, used in automated config management
username	List of string	One or more patterns to match username

Control profile

General on/off control profile used in various places in the config.

profile: Attributes
Attribute	Type	Description	Default
and	List of NMTOKEN	Active if all specified profiles are active as well as all other tests passing, including 'not'
comment	string	Comment
control-switch-users	List of NMTOKEN	Restrict users that have access to control switch	Any users
expect	boolean	Defines state considered 'Good' and shown green on status page	none
initial	boolean	Defines state at system startup, or new config, where not known/fixed	true
interval	duration	Time between tests	1
invert	boolean	Invert final result of testing
log	NMTOKEN	Log target	Not logging
log-debug	NMTOKEN	Log additional information	Not logging
name	NMTOKEN	Profile name	Not optional
not	NMTOKEN	Active if specified profile is inactive as well as all other tests passing, including 'and'
or	List of NMTOKEN	Active if any of these other profiles are active regardless of other tests (including 'not' or 'and')
ports	Set of port	Test passes if any of these physical ports are up
ppp	List of NMTOKEN	PPP link state (any of these are up)
recover	duration	Time before recover (i.e. how long test has been passing)	1
route	List of IPAddr	Test passes if all specified addresses are routeable
set	switch	Manual override. Test settings ignored; Control switches can use and/or/not/invert
source	string	Source of data, used in automated config management
table	routetable 0-99	Routing table for ping/route
timeout	duration	Time before timeout (i.e. how long test has been failing)	10
vrrp	List of NMTOKEN	VRRP state (any of these is master)

profile: Elements
Element	Type	Instances	Description
date	profile-date	Optional, unlimited	Test passes if within any date range specified
ping	profile-ping	Optional	Test passes if address is answering pings
time	profile-time	Optional, unlimited	Test passes if within any time range specified

Test passes if within any of the time ranges specified

Time range test in profiles

profile-date: Attributes
Attribute	Type	Description
comment	string	Comment
source	string	Source of data, used in automated config management
start	dateTime	Start (YYYY-MM-DDTHH:MM:SS)
stop	dateTime	End (YYYY-MM-DDTHH:MM:SS)

Test passes if within any of the date/time ranges specified

Time range test in profiles

profile-time: Attributes
Attribute	Type	Description
comment	string	Comment
days	Set of day	Which days of week apply, default all
source	string	Source of data, used in automated config management
start	time	Start (HH:MM:SS)
stop	time	End (HH:MM:SS)

Test passes if any addresses are pingable

Ping targets

profile-ping: Attributes
Attribute	Type	Description	Default
comment	string	Comment
flow	unsignedShort	Flow label (IPv6)
gateway	IPAddr	Ping via specific gateway (bypasses session tracking if set)
ip	IPAddr	Target IP	Not optional
source	string	Source of data, used in automated config management
source-ip	IPAddr	Source IP
ttl	unsignedByte	Time to live / Hop limit

Traffic shaper

Settings for a named traffic shaper

shaper: Attributes
Attribute	Type	Description	Default
comment	string	Comment
name	graphname (token)	Graph name	Not optional
rx	unsignedLong	Rx rate limit/target (b/s)
rx-limit	shaper-limit 0-1000	Rx low level burst limit (ms) - ½ for large packets	400ms
rx-max	unsignedLong	Rx rate limit max
rx-min	unsignedLong	Rx rate limit min
rx-min-burst	duration	Rx minimum allowed burst time
rx-step	unsignedLong	Rx rate reduction per hour
share	boolean	If shaper is shared with other devices	false
source	string	Source of data, used in automated config management
tx	unsignedLong	Tx rate limit/target (b/s)
tx-limit	shaper-limit 0-1000	Tx low level burst limit (ms) - ½ for large packets	400ms
tx-max	unsignedLong	Tx rate limit max
tx-min	unsignedLong	Tx rate limit min
tx-min-burst	duration	Tx minimum allowed burst time
tx-step	unsignedLong	Tx rate reduction per hour

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

Traffic shaper override based on profile

Settings for a named traffic shaper

shaper-override: Attributes
Attribute	Type	Description	Default
comment	string	Comment
profile	NMTOKEN	Profile name	Not optional
rx	unsignedLong	Rx rate limit/target (b/s)
rx-limit	shaper-limit 0-1000	Rx low level burst limit (ms) - ½ for large packets	400ms
rx-max	unsignedLong	Rx rate limit max
rx-min	unsignedLong	Rx rate limit min
rx-min-burst	duration	Rx minimum allowed burst time
rx-step	unsignedLong	Rx rate reduction per hour
source	string	Source of data, used in automated config management
tx	unsignedLong	Tx rate limit/target (b/s)
tx-limit	shaper-limit 0-1000	Tx low level burst limit (ms) - ½ for large packets	400ms
tx-max	unsignedLong	Tx rate limit max
tx-min	unsignedLong	Tx rate limit min
tx-min-burst	duration	Tx minimum allowed burst time
tx-step	unsignedLong	Tx rate reduction per hour

IP Group

Named IP group

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

DHCP server settings for remote / relayed requests

Settings for DHCP server for relayed connections

dhcp-relay: Attributes
Attribute	Type	Description	Default
allocation-table	routetable 0-99	Routing table for allocations - suggest using separate tables for remote DHCP	Allocate same as request table
allow	List of IPNameRange	IPs allowed (e.g. allocated IPs for renewal)	Allow from anywhere
relay	List of IPNameRange	Relay server IP(s)	Any relay
table	routetable 0-99	Routing table applicable	Allow any

dhcp-relay: Elements
Element	Type	Instances	Description
dhcp	dhcps	Optional, unlimited	DHCP server settings

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

PPP dump format

Tag	Description
default	Mixed hex/decode
decoded	Decoded only
decoded+raw	Decoded + raw
raw	Raw hex

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

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)
demo	Full view and edit access but can only test config, not save
test	Full view and edit access but must test save config first
full	Full view and edit access

Subsystem with EAP access control

Tag	Description
IPsec	IPsec/IKEv2 VPN

EAP access method

Tag	Description
MD5	MD5 Challenge
MSChapV2	MS Challenge

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

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

HTTP/HTTPS security mode

Tag	Description
http-only	No HTTPS access
http+https	Both HTTP and HTTPS access
https-only	No HTTP access
redirect-to-https	HTTP accesses are redirected to use HTTPS
redirect-to-https-if-acme	HTTP accesses are redirected to use HTTPS if ACME set up for hostname
redirect-to-https-except-trusted	HTTP accesses are redirected to use HTTPS (except trusted IPs)

Options for controlling platform RADIUS response priority tagging

Tag	Description
equal	All the same priority
strict	In order specified
random	Random order
calling	Hashed on calling station id
called	Hashed on called station id
username	Hashed on full username
user	Hashed on username before @
realm	Hashed on username after @
prefix	Hashed on username initial letters and numbers only

Type of RADIUS server

Tag	Description
authentication	Authentication server
accounting	Accounting server
control	Allowed to send control (CoA/DM)

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

Day name (3 letter)

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

Physical port

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

Crossover configuration

Physical port crossover configuration.

Tag	Description
auto	Crossover is determined automatically
MDI	Force no crossover

Physical port speed

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

Physical port duplex setting

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

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 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

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

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

PHY power saving options

Tag	Description
none	No power saving
full	Full power saving

Link fault type to send

Tag	Description
false	No fault
true	Send fault
off-line	Send offline fault (1G)
ane	Send ANE fault (1G)

Trunk port mode

Tag	Description
false	Not trunking
random	Random trunking
l2-hash	L2 hashed trunking
l23-hash	L2 and L3 hashed trunking
l3-hash	L3 hashed trunking

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

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

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

Source filter option

Tag	Description
false	No source filter checks
blackhole	Check replies blackholed
nowhere	Check replies valid
self	Check replies valid and not self
true	Check replies down same port/vlan

Type of PPPoE connection

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

Additional prefix on PPPoE calling ID

Tag	Description
none	None
mac	MAC
vlan	VLAN
mac-vlan	MAC and VLAN

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, soft routes EBGP only

NAS IP to report

Tag	Description
false	Local LNS IP (deprecated)
lns	Local LNS IP
both	Send NAS IP twice (LAC then LNS)
lac	Remote LAC IP
true	Remote LAC IP (deprecated)

Profile manual setting

Manual setting control for profile

Tag	Description
false	Profile set to OFF
true	Profile set to ON
control-switch	Profile set based on control switch on home page

Basic types

Type	Description
string	text string
token	text string
hexBinary	hex coded binary data
integer	integer (-2147483648-2147483647)
positiveInteger	positive integer (1-4294967295)
unsignedLong	unsigned long 64 bit integer (0-9223372036854775807)
unsignedInt	unsigned integer (0-4294967295)
unsignedShort	unsigned short integer (0-65535)
byte	byte integer (-128-127)
unsignedByte	unsigned byte integer (0-255)
boolean	Boolean
dateTime	YYYY-MM-DDTHH:MM:SS date/time
time	HH:MM:SS time
NMTOKEN	String with no spaces
void	Internal use
IPAddr	IP address
IPNameAddr	IP address or name
IP4Addr	IPv4 address
IP6Addr	IPv6 address
IP46Addr	IPv4 + IPv6 address
IPPrefix	IP address / bitlen
IPRange	IP address / bitlen or range
IPNameRange	IP address / bitlen or range or name
IP4Range	IPv4 address / bitlen or range
IP4Prefix	IPv4 address / bitlen
IPSubnet	IP address / bitlen
IP4Subnet	IPv4 address / bitlen
IPFilter	Route filter
Password	Password
OTP	OTP
Community	xxx:xxx community
PortRange	xxx-xxx port range
Colour	#rgb #rrggbb #rgba #rrggbbaa colour
Secret	Secret/passphrase
duration	Period [[HH:]MM:]SS
fb-sw-update-delay	[unsignedByte] Number of days to delay upgrade by (0-30)
stringlist	[string] List of strings
percentage	[unsignedByte] Percentage (0 .. 100) (0-100)
routetable	[unsignedByte] Route table number (0-99)
username	[NMTOKEN] Login name
ipnamerangelist	[IPNameRange] List of IPranges or ip groups
nmtokenlist	[NMTOKEN] List of NMTOKEN
iplist	[IPAddr] List of IP addresses
ipnamelist	[IPNameAddr] List of IP addresses or domain names
datenum	[unsignedByte] Day number in month (1-31)
subnetlist	[IPSubnet] List of subnets
ra-max	[unsignedShort] Route announcement max interval (seconds) (4-1800)
ra-min	[unsignedShort] Route announcement min interval (seconds) (3-1350)
ip6list	[IP6Addr] List of IPv6 addresses
mtu	[unsignedShort] Max transmission unit (576-2000)
vlan	[unsignedShort] VLAN ID (0=untagged) (0-4095)
ip4rangelist	[IP4Range] List of IP4ranges
macprefixlist	[macprefix] List of strings
macprefix	[hexBinary] MAC prefix
ip4list	[IP4Addr] List of IPv4 addresses
graphname	[token] Graph name
cug	[unsignedShort] CUG ID (1-32767)
prefixlist	[IPPrefix] List of IP Prefixes
aslist	[unsignedIntList] List of AS numbers
unsignedIntList	[unsignedInt] List of integers
communitylist	[Community] List of BGP communities
filterlist	[IPFilter] List of IP Prefix filters
shaper-limit	[unsignedShort] Shaper limit (ms) (0-1000)
iprangelist	[IPRange] List of IPranges
userlist	[username] List of user names
prefix4list	[IP4Prefix] List of IPv4 Prefixes
portlist	[PortRange] List of protocol port ranges
protolist	[unsignedByte] List of IP protocols
routetableset	[routetable] Set of routetables
vlan-nz	[unsignedShort] VLAN ID (1-4095)
dates	[datenum] Set of dates
tun-id	[unsignedShort] Local tunnel ID (1-20000)
ses-id	[unsignedShort] Local session ID (1-65535)
hostname	[NMTOKEN] Host name
sip-error	[unsignedShort] SIP error code (400-699)