FireBrick FB6202 version 3807 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

config: Elements
Element	Type	Instances	Description
system	system	Optional	System settings
user	user	Optional, unlimited	Admin users
syslog	syslog	Optional	Syslog controls
interface	interface	Optional, up to 8192	Config ethernet port/vlan and subnets
services	services	Optional	General system services
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
shaper	shaper	Optional, unlimited	Named traffic shapers

Traffic shaper

Settings for a named traffic shaper

shaper: Attributes
Attribute	Type	Description	Default
name	string	Graph name	Not optional
egress	unsignedLong	Egress rate limit/target
egress-min	unsignedLong	Egress rate limit min
egress-max	unsignedLong	Egress rate limit max
egress-step	unsignedLong	Egress rate adjust step
egress-interval	unsignedLong	Egress rate adjust interval (seconds)	3600
ingress	unsignedLong	Ingress rate limit
ingress-min	unsignedLong	Ingress rate limit min
ingress-max	unsignedLong	Ingress rate limit max
ingress-step	unsignedLong	Ingress rate adjust step
ingress-interval	unsignedLong	Ingress rate adjust interval (seconds)	3600
source	string	Source of data, used in automated config management
comment	string	Comment

RADIUS accounting server settings

Server settings for RADIUS Accounting for L2TP

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

RADIUS authentication server settings

Server settings for RADIUS Authentication for L2TP

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

Relay rules for L2TP

Rules for relaying L2TP

l2tp-relay: Attributes
Attribute	Type	Description
name	string	Name
graph	string	Graph name
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
target-ip	List of IPAddr	Target IP(s) for L2TP connection
target-secret	string	Shared secret for L2TP connection
target-hostname	string	Hostname for L2TP connection
test	List of IPAddr	List of IPs that must have routing for this target to be valid
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
graph	string	Graph name
table	routetable 0-10	Routing table number for L2TP session
test	List of IPAddr	List of IPs to which routing must exist else tunnel dropped
payload-table	routetable 0-10	Routing table number for payload traffic
bgp	bgpmode	BGP announce mode for routes	no-export
hostname	string	Hostname quoted on incoming tunnel
secret	string	Shared secret
allow	List of IPPrefix	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	Local end PPP DNS1 IPv4 default
pppdns2	IP4Addr	Local end PPP DNS2 IPv4 default
dos-limit	unsignedLong	Per second per session tx packet drop limit for DOS protection	10000
tx-speed	unsignedLong	Default tx rate limit
hdlc	boolean	Send HDLC header (FF03) on all PPP frames	true
tcp-mss-fix	boolean	Adjust MSS option in TCP SYN to fix session MSS	false
require-platform	boolean	All sessions require a platform RADIUS first	false
shutdown	boolean	Refuse all new sessions or tunnels	false
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	unsignedLong	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	string	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-drop	string	Label for % shaper drops	Drop%
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-down	string	Label for download traffic level	Down
down	Colour	Colour for downstream traffic level	#080
label-up	string	Label for upload traffic level	Up
up	Colour	Colour for upstream 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

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)
md5	string	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
max-prefix	bgp-prefix-limit 1-100	Limit prefixes (IPv4+IPv6)	100
as	unsignedInt	Peer AS
holdtime	unsignedInt	Hold time	30
localpref	unsignedInt	Default inbound localpref assumed	100
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
no-fib	boolean	Don't include received routes in packet forwarding
in-soft	boolean	Mark received routes as soft
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
ignore-bad-optional-partial	boolean	Ignore routes with a regognised badly formed optional that is flagged partial	true
shutdown	boolean	Shutdown this neighbour
pad	unsignedByte	Pad our AS by this many
in-med	unsignedInt	Set inbound MED
out-med	unsignedInt	Set outbound MED
in-tag	bgpmode	Set inbound well-known community
out-tag	bgpmode	Set outbound well-known community
source	string	Source of data, used in automated config management
comment	string	Comment
log	boolean	Log inbound route updates

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
name	string	Name
table	routetable 0-10	Routing table number
as	unsignedInt	Our AS
id	IP4Addr	Our router ID
cluster-id	IP4Addr	Our cluster ID

bgp: Elements
Element	Type	Instances	Description
peer	bgppeer	Optional, up to 20	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-10	Routing table number
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
localpref	unsignedInt	Localpref of network	4294967295
ospf	boolean	OSPF announce mode for route
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
bgp	bgpmode	BGP announce mode for loopback	false

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-10	Routing table number
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
localpref	unsignedInt	Localpref of network	4294967295
ospf	boolean	OSPF announce mode for route
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
bgp	bgpmode	BGP announce mode for network	true

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-10	Routing table number
as-path	List of up to 10 unsignedInt	Custom AS path as if network received
localpref	unsignedInt	Localpref of network	4294967295
ospf	boolean	OSPF announce mode for route
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
gateway	List of IPAddr	One or more target gateway IPs
bgp	bgpmode	BGP announce mode for route	false

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	string	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-10	Routing table number for copy of RADIUS request
test	List of IPAddr	List of IPs that must have routing for this target to be valid
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	string	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-10	Routing table number for copy of RADIUS request
test	List of IPAddr	List of IPs that must have routing for this target to be valid
source	string	Source of data, used in automated config management
comment	string	Comment
port	unsignedShort	Authentication UDP port	1812
secret	string	Shared secret for RADIUS requests (needed for replies)

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

HTTP service settings

Web management pages

http-service: Attributes
Attribute	Type	Description
table	routetable 0-10	Routing table number
port	unsignedShort	Service port
allow	List of IPPrefix	List of IP ranges from which service can be accessed
trusted	List of IPPrefix	List of IP ranges from which trusted access is allowed

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-10	Routing table number
port	unsignedShort	Service port
allow	List of IPPrefix	List of IP ranges from which service can be accessed
timeserver	List of IPAddr	List of time servers 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-10	Routing table number
port	unsignedShort	Service port
allow	List of IPPrefix	List of IP ranges from which service can be accessed
community	string	Community string	public

General service settings

The service settings allow basic control of the service, the port on which it operates (if not default for the service) and access controls.

service: Attributes
Attribute	Type	Description
table	routetable 0-10	Routing table number
port	unsignedShort	Service port
allow	List of IPPrefix	List of IP ranges from which service can be accessed

TFTP service settings

The TFTP service has general service settings plus file names for specific TFTP operations

tftp-service: Attributes
Attribute	Type	Description	Default
table	routetable 0-10	Routing table number
port	unsignedShort	Service port
allow	List of IPPrefix	List of IP ranges from which service can be accessed
config	string	Filename used to save/load config	config
image	string	Filename used to save/load images	image

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
tftp	tftp-service (service)	Optional	TFTP server settings (image and config load/save)
snmp	snmp-service (service)	Optional	SNMP server settings
ntp	ntp-service (service)	Optional	NTP client settings (server not implimented yet)
telnet	service	Optional	Telnet server settings
http	http-service (service)	Optional	HTTP server settings
platform-radius	platform-radius (platform-radius-target)	Optional	Platform RADIUS server/proxy settings

VRRP settings

VRRP settings provide virtual router redundancy for the FireBrick

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
low-priority	unsignedByte	Lower priority applicable until routing established	1
delay	unsignedLong	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-errors	boolean	Whether to log errors	false
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 (omit for DHCP client)
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-test	List of IPAddr	One or more IPs to which routing must exist else RA is lower priority
localpref	unsignedInt	Localpref for subnet	4294967295
bgp	bgpmode	BGP announce mode for subnet
ospf	boolean	OSPF announce mode for subnet
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
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
graph	string	Graph name
port	port 0-1	Physical port	0
vlan	vlan 0-4095	VLAN (0=untagged)	0
ra	boolean	Accept IPv6 RA and create auto config subnets and routes	true
table	routetable 0-10	Routing table applicable
mtu	unsignedShort	MTU for this interface	1500
cug	cug 1-32767	Closed user group ID
cug-restrict	boolean	Closed user group restricted traffic (only to/from same CUG ID)
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

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-10	Routing table number for sending syslogs

Admin users

User names, passwords and abilities for admin users

user: Attributes
Attribute	Type	Description	Default
name	string	User name	Not optional
password	Password	User password
timeout	unsignedShort	Login idle timeout (seconds)	300
source	string	Source of data, used in automated config management
comment	string	Comment
level	user-level	Login level	ADMIN

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
contact	string	Contact name
location	string	Location description
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
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

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

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
drop	Drop routes (used in-tag or out-tag)
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

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

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

User login level

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

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

Basic types

Type	Description
ses-id	[unsignedShort] Local session ID (1-65535)
tun-id	[unsignedShort] Local tunnel ID (1-1000)
bgp-prefix-limit	[unsignedInt] Maximum prefixes accepted on BGP session (1-100)
prefixlist	[IPPrefix] List of IP Prefixes
unsignedIntList	[unsignedInt] List of integers
aslist	[unsignedIntList] List of AS numbers
stringlist	[string] List of strings
datenum	[unsignedByte] Day number in month (1-31)
iprangelist	[IPPrefix] List of IPranges
cug	[unsignedShort] CUG ID (1-32767)
vlan	[unsignedShort] VLAN ID (0=untagged) (0-4095)
port	[unsignedByte] Physical port (0-1)
ip4list	[IP4Addr] List of IPv4 addresses
ra-min	[unsignedByte] Route announcement min interval (seconds) (3-1350)
ra-max	[unsignedShort] Route announcement max interval (seconds) (4-1800)
iplist	[IPAddr] List of IP addresses
subnetlist	[IPSubnet] List of subnets
routetable	[unsignedByte] Route table number (0-10)
Colour	#rgb #rrggbb #rgba #rrggbbaa colour
Password	Password
IPSubnet	IP address / bitlen
IPPrefix	IP address / bitlen
IP4Addr	IPv4 address
IPAddr	IP address
dateTime	YYYY-MM-DDTHH:MM:SS date/time
duration	duration in seconds
boolean	Boolean
unsignedByte	unsigned byte integer (0-255)
unsignedShort	unsigned short integer (0-65535)
unsignedInt	unsigned integer (0-4294967295)
unsignedLong	unsigned long integer (0-4294967295)
string	text string