FireBrick FB9000 User Manual
   Next

FireBrick FB9000 User Manual

This User Manual documents Software version V1.61.010

Copyright © 2012-2022 FireBrick Ltd.

Table of Contents

Preface
1. Introduction
1.1. The FB9000
1.1.1. Where do I start?
1.1.2. What can it do?
1.1.3. Ethernet port capabilities
1.1.4. Differences between the devices in the FB2x00 series
1.1.5. Software features
1.2. About this Manual
1.2.1. Version
1.2.2. Intended audience
1.2.3. Technical details
1.2.4. Document style
1.2.5. Document conventions
1.2.6. Comments and feedback
1.3. Additional Resources
1.3.1. Technical Support
1.3.2. IRC Channel
1.3.3. Application Notes
1.3.4. Training Courses
2. Getting Started
2.1. IP addressing
2.2. Accessing the web-based user interface
2.2.1. Setup wizard
2.2.1.1. Login username/password
2.2.1.2. WAN/PPPoE settings
2.2.1.3. LAN settings
2.2.1.4. Initial config
3. Configuration
3.1. The Object Hierarchy
3.2. The Object Model
3.2.1. Formal definition of the object model
3.2.2. Common attributes
3.3. Configuration Methods
3.4. Data types
3.4.1. Sending and receiving values
3.4.2. Lists of values
3.4.3. Set of possible values
3.4.4. Dates, times, and durations
3.4.5. Colours
3.4.6. Passwords and secrets
3.4.7. IP addresses
3.4.7.1. Simple IP addresses
3.4.7.2. Subnets and prefixes
3.4.7.3. Ranges
3.5. Web User Interface Overview
3.5.1. User Interface layout
3.5.1.1. Customising the layout
3.5.2. Config pages and the object hierarchy
3.5.2.1. Configuration categories
3.5.2.2. Object settings
3.5.3. Navigating around the User Interface
3.5.4. Backing up / restoring the configuration
3.6. Configuration using XML
3.6.1. Introduction to XML
3.6.2. The root element - <config>
3.6.3. Viewing or editing XML
3.6.4. Example XML configuration
3.7. Downloading/Uploading the configuration
3.7.1. Download
3.7.2. Upload
4. System Administration
4.1. User Management
4.1.1. Login level
4.1.2. Configuration access level
4.1.3. Login idle timeout
4.1.4. Restricting user logins
4.1.4.1. Restrict by IP address
4.1.4.2. Logged in IP address
4.1.4.3. Restrict by profile
4.1.5. Password change
4.1.6. One Time Password (OTP)
4.2. General System settings
4.2.1. System name (hostname)
4.2.2. Administrative details
4.2.3. System-level event logging control
4.2.4. Home page web links
4.3. Software Upgrades
4.3.1. Software release types
4.3.1.1. Breakpoint releases
4.3.2. Identifying current software version
4.3.3. Internet-based upgrade process
4.3.3.1. Manually initiating upgrades
4.3.3.2. Controlling automatic software updates
4.3.4. Manual upgrade
4.4. Boot Process
4.4.1. LED indications
4.4.1.1. Power LED status indications
4.4.1.2. Port LEDs
5. Event Logging
5.1. Overview
5.1.1. Log targets
5.1.1.1. Logging to Flash memory
5.1.1.2. Logging to the Console
5.2. Enabling logging
5.3. Logging to external destinations
5.3.1. Syslog
5.3.2. Email
5.3.2.1. E-mail process logging
5.4. Factory reset configuration log targets
5.5. Performance
5.6. Viewing logs
5.6.1. Viewing logs in the User Interface
5.6.2. Viewing logs in the CLI environment
5.7. System-event logging
5.8. Using Profiles
6. Interfaces and Subnets
6.1. Relationship between Interfaces and Physical Ports
6.1.1. Port groups
6.1.2. Interfaces
6.2. Defining port groups
6.3. Defining an interface
6.3.1. Defining subnets
6.3.1.1. Source filtering
6.3.1.2. Using DHCP to configure a subnet
6.3.1.3. Using SLAAC (IPv6 router announcements) to configure a subnet
6.3.1.4. Providing IPv6 addresses to devices on a network (IPv6 router announcements)
6.3.2. Setting up DHCP server parameters
6.3.2.1. Fixed/Static DHCP allocations
6.3.2.2. Restricted allocations
6.3.2.3. Special DHCP options
6.3.2.4. Logging
6.4. Physical port settings
6.4.1. Disabling auto-negotiation
6.4.2. Setting port speed
6.4.3. Setting duplex mode
6.4.4. Defining port LED functions
7. Routing
7.1. Routing logic
7.2. Routing targets
7.2.1. Subnet routes
7.2.2. Routing to an IP address (gateway route)
7.2.3. Special targets
7.3. Dynamic route creation / deletion
7.4. Routing tables
7.5. Bonding
8. Profiles
8.1. Overview
8.2. Creating/editing profiles
8.2.1. Timing control
8.2.2. Tests
8.2.2.1. General tests
8.2.2.2. Time/date tests
8.2.2.3. Ping tests
8.2.3. Inverting overall test result
8.2.4. Manual override
8.2.5. Scripting
9. Traffic Shaping
9.1. Graphs and Shapers
9.1.1. Graphs
9.1.2. Shapers
9.1.3. Ad hoc shapers
9.1.4. Long term shapers
9.1.5. Shared shapers
9.2. Multiple shapers
9.3. Basic principles
10. System Services
10.1. Protecting the FB9000
10.2. Common settings
10.3. HTTP Server configuration
10.3.1. Access control
10.3.1.1. Trusted addresses
10.3.2. HTTPS access
10.4. Telnet Server configuration
10.4.1. Access control
10.5. DNS configuration
10.5.1. Blocking DNS names
10.5.2. Local DNS responses
10.5.3. Auto DHCP DNS
10.6. NTP configuration
10.7. SNMP configuration
11. Network Diagnostic Tools
11.1. Access check
11.2. Packet Dumping
11.2.1. Dump parameters
11.2.2. Security settings required
11.2.3. IP address matching
11.2.4. Packet types
11.2.5. Snaplen specification
11.2.6. Using the web interface
11.2.7. Using an HTTP client
11.2.7.1. Example using curl and tcpdump
12. VRRP
12.1. Virtual Routers
12.2. Configuring VRRP
12.2.1. Advertisement Interval
12.2.2. Priority
12.3. Using a virtual router
12.4. VRRP versions
12.4.1. VRRP version 2
12.4.2. VRRP version 3
12.5. Compatibility
13. Command Line Interface
A. Factory Reset Procedure
B. CIDR and CIDR Notation
C. MAC Addresses usage
C.1. Multiple MAC addresses?
C.2. How the FireBrick allocates MAC addresses
C.2.1. Interface
C.2.2. Subnet
C.2.3. PPPoE
C.2.4. Base MAC
C.2.5. Running out of MACs
C.3. MAC address on label
C.4. Using with a DHCP server
D. Scripted access
D.1. Tools
D.2. Access control
D.2.1. Username and password
D.2.2. OTP
D.2.3. Allow list
D.2.4. Allowed access
D.3. XML data for common functions
D.4. XML data from diagnostics and tests
D.4.1. Cross site scripting security
D.4.2. Arguments to scripts
D.5. Special URLs
D.6. Web sockets
E. VLANs : A primer
F. FireBrick specific SNMP objects
F.1. Firebrick CPU usage
F.2. Firebrick system stats
F.3. Monitoring for general system features
G. Command line reference
G.1. General commands
G.1.1. Trace off
G.1.2. Trace on
G.1.3. Uptime
G.1.4. General status
G.1.5. Memory usage
G.1.6. Process/task usage
G.1.7. Login
G.1.8. Logout
G.1.9. See XML configuration
G.1.10. Load XML configuration
G.1.11. Show profile status
G.1.12. Enable profile control switch
G.1.13. Disable profile control switch
G.1.14. Show RADIUS servers
G.1.15. Show DNS resolvers
G.2. Networking commands
G.2.1. Subnets
G.2.2. Renegotiate DHCP for a subnet
G.2.3. Ping and trace
G.2.4. Show a route from the routing table
G.2.5. List routes
G.2.6. List routing next hops
G.2.7. See DHCP allocations
G.2.8. Clear DHCP allocations
G.2.9. Lock DHCP allocations
G.2.10. Unlock DHCP allocations
G.2.11. Name DHCP allocations
G.2.12. Show ARP/ND status
G.2.13. Show VRRP status
G.2.14. Send Wake-on-LAN packet
G.2.15. Check access to services
G.3. Advanced commands
G.3.1. Panic
G.3.2. Reboot
G.3.3. Screen width
G.3.4. Make outbound command session
G.3.5. Show command sessions
G.3.6. Kill command session
G.3.7. Flash memory list
G.3.8. Delete block from flash
G.3.9. Boot log
G.3.10. Flash log
H. Constant Quality Monitoring - technical details
H.1. Access to graphs and csvs
H.1.1. Trusted access
H.1.2. Dated information
H.1.3. Authenticated access
H.2. Graph display options
H.2.1. Scaleable Vector Graphics
H.2.2. Data points
H.2.3. Additional text
H.2.4. Other colours and spacing
H.3. Overnight archiving
H.3.1. Full URL format
H.3.2. load handling
H.4. Graph scores
H.5. Creating graphs, and graph names
I. Hashed passwords
I.1. Password hashing
I.1.1. Salt
I.2. One Time Password seed hashing
J. Configuration Objects
J.1. Top level
J.1.1. config: Top level config
J.2. Objects
J.2.1. system: System settings
J.2.2. link: Web links
J.2.3. routing-table: Default source IP for services using a given table
J.2.4. user: Admin users
J.2.5. eap: User access controlled by EAP
J.2.6. log: Log target controls
J.2.7. log-syslog: Syslog logger settings
J.2.8. log-email: Email logger settings
J.2.9. services: System services
J.2.10. http-service: Web service settings
J.2.11. dns-service: DNS service settings
J.2.12. dns-host: Fixed local DNS host settings
J.2.13. dns-block: Fixed local DNS blocks
J.2.14. telnet-service: Telnet service settings
J.2.15. snmp-service: SNMP service settings
J.2.16. time-service: System time server settings
J.2.17. ethernet: Physical port controls
J.2.18. portdef: Port grouping and naming
J.2.19. interface: Port-group/VLAN interface settings
J.2.20. subnet: Subnet settings
J.2.21. vrrp: VRRP settings
J.2.22. dhcps: DHCP server settings
J.2.23. dhcp-attr-hex: DHCP server attributes (hex)
J.2.24. dhcp-attr-string: DHCP server attributes (string)
J.2.25. dhcp-attr-number: DHCP server attributes (numeric)
J.2.26. dhcp-attr-ip: DHCP server attributes (IP)
J.2.27. route: Static routes
J.2.28. blackhole: Dead end networks
J.2.29. loopback: Locally originated networks
J.2.30. cqm: Constant Quality Monitoring settings
J.2.31. ip-group: IP Group
J.3. Data types
J.3.1. user-level: User login level
J.3.2. ppp-dump: PPP dump format
J.3.3. autoloadtype: Type of s/w auto load
J.3.4. config-access: Type of access user has to config
J.3.5. eap-subsystem: Subsystem with EAP access control
J.3.6. eap-method: EAP access method
J.3.7. syslog-severity: Syslog severity
J.3.8. syslog-facility: Syslog facility
J.3.9. http-mode: HTTP/HTTPS security mode
J.3.10. month: Month name (3 letter)
J.3.11. day: Day name (3 letter)
J.3.12. port: Physical port
J.3.13. LinkFlow: Physical port flow control setting
J.3.14. LinkClock: Physical port Gigabit clock master/slave setting
J.3.15. LinkFault: Link fault type to send
J.3.16. trunk-mode: Trunk port mode
J.3.17. ramode: IPv6 route announce level
J.3.18. sfoption: Source filter option
J.4. Basic types
Index

List of Figures

2.1. Initial web page in factory reset state
2.2. Setup Wizard
3.1. Main menu
3.2. Icons for layout controls
3.3. Icons for configuration categories
3.4. The "Setup" category
3.5. Editing an "Interface" object
3.6. Show hidden attributes
3.7. Attribute definitions
3.8. Navigation controls
4.1. Setting up a new user
4.2. Software upgrade available notification
4.3. Manual Software upload
C.1. Product label showing MAC address range

List of Tables

2.1. IP addresses for computer
2.2. IP addresses to access the FireBrick
2.3. IP addresses to access the FireBrick
3.1. Special character sequences
4.1. User login levels
4.2. Configuration access levels
4.3. General administrative details attributes
4.4. Attributes controlling auto-upgrades
4.5. Power LED status indications
5.1. Logging attributes
5.2. System-Event Logging attributes
6.1. Port LED functions
6.2. Example modified Port LED functions
7.1. Example route targets
10.1. List of system services
10.2. List of system services
11.1. Packet dump parameters
11.2. Packet types that can be captured
C.1. DHCP client names used
D.1. Special URLs
F.1. CPU usage for this Firebrick - iso.3.6.1.4.1.24693.100.2.1.fbCpuPeriod.fbCpuCore.
F.2. The table of runtime stats for this Firebrick - iso.3.6.1.4.1.24693.100.3.1.fbRunCore.
F.3. The list of readings for this Firebrick - iso.3.6.1.4.1.24693.100.1.1.fbMonReadingIndex.
H.1. File types
H.2. Colours
H.3. Text
H.4. Text
H.5. URL formats
J.1. config: Attributes
J.2. config: Elements
J.3. system: Attributes
J.4. system: Elements
J.5. link: Attributes
J.6. routing-table: Attributes
J.7. user: Attributes
J.8. eap: Attributes
J.9. log: Attributes
J.10. log: Elements
J.11. log-syslog: Attributes
J.12. log-email: Attributes
J.13. services: Elements
J.14. http-service: Attributes
J.15. dns-service: Attributes
J.16. dns-service: Elements
J.17. dns-host: Attributes
J.18. dns-block: Attributes
J.19. telnet-service: Attributes
J.20. snmp-service: Attributes
J.21. time-service: Attributes
J.22. ethernet: Attributes
J.23. portdef: Attributes
J.24. interface: Attributes
J.25. interface: Elements
J.26. subnet: Attributes
J.27. vrrp: Attributes
J.28. dhcps: Attributes
J.29. dhcps: Elements
J.30. dhcp-attr-hex: Attributes
J.31. dhcp-attr-string: Attributes
J.32. dhcp-attr-number: Attributes
J.33. dhcp-attr-ip: Attributes
J.34. route: Attributes
J.35. blackhole: Attributes
J.36. loopback: Attributes
J.37. cqm: Attributes
J.38. ip-group: Attributes
J.39. user-level: User login level
J.40. ppp-dump: PPP dump format
J.41. autoloadtype: Type of s/w auto load
J.42. config-access: Type of access user has to config
J.43. eap-subsystem: Subsystem with EAP access control
J.44. eap-method: EAP access method
J.45. syslog-severity: Syslog severity
J.46. syslog-facility: Syslog facility
J.47. http-mode: HTTP/HTTPS security mode
J.48. month: Month name (3 letter)
J.49. day: Day name (3 letter)
J.50. port: Physical port
J.51. LinkFlow: Physical port flow control setting
J.52. LinkClock: Physical port Gigabit clock master/slave setting
J.53. LinkFault: Link fault type to send
J.54. trunk-mode: Trunk port mode
J.55. ramode: IPv6 route announce level
J.56. sfoption: Source filter option
J.57. Basic data types
   Next
   Preface