FireBrick NULL User Manual
   Next

FireBrick NULL User Manual

This User Manual documents Software version V1.29.000

Copyright © 2012-2013 FireBrick Ltd.

Table of Contents

Preface
1. Introduction
1.1. The FB2500
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.1.6. Migration from previous FireBrick models
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. White Papers
1.3.5. Training Courses
2. Getting Started
2.1. IP addressing
2.2. Accessing the web-based user interface
2.2.1. Add a new user
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. Web User Interface Overview
3.4.1. User Interface layout
3.4.1.1. Customising the layout
3.4.2. Config pages and the object hierarchy
3.4.2.1. Configuration categories
3.4.2.2. Object settings
3.4.3. Navigating around the User Interface
3.4.4. Backing up / restoring the configuration
3.5. Configuration using XML
3.5.1. Introduction to XML
3.5.2. The root element - <config>
3.5.3. Viewing or editing XML
3.5.4. Example XML configuration
3.6. Downloading/Uploading the configuration
3.6.1. Download
3.6.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. One Time Password
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.2. Setting up DHCP server parameters
6.3.2.1. Fixed/Static DHCP allocations
6.3.2.1.1. Special DHCP attributes
6.3.2.2. Partial-MAC-address based allocations
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
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.2. Multiple shapers
9.3. Basic principles
10. System Services
10.1. Protecting the FB2500
10.2. Common settings
10.3. HTTP Server configuration
10.3.1. Access control
10.3.1.1. Trusted addresses
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
D. VLANs : A primer
E. FireBrick specific SNMP objects
F. Command line reference
F.1. General commands
F.1.1. Trace off
F.1.2. Trace on
F.1.3. Uptime
F.1.4. General status
F.1.5. Memory usage
F.1.6. Process/task usage
F.1.7. Login
F.1.8. Logout
F.1.9. See XML configuration
F.1.10. Load XML configuration
F.1.11. Show profile status
F.1.12. Enable profile control switch
F.1.13. Disable profile control switch
F.1.14. Show RADIUS servers
F.1.15. Show DNS resolvers
F.2. Networking commands
F.2.1. Subnets
F.2.2. Ping and trace
F.2.3. Show a route from the routing table
F.2.4. List routes
F.2.5. List routing next hops
F.2.6. See DHCP allocations
F.2.7. Clear DHCP allocations
F.2.8. Lock DHCP allocations
F.2.9. Unlock DHCP allocations
F.2.10. Name DHCP allocations
F.2.11. Show ARP/ND status
F.2.12. Show VRRP status
F.2.13. Send Wake-on-LAN packet
F.2.14. Check access to services
F.3. Advanced commands
F.3.1. Panic
F.3.2. Reboot
F.3.3. Screen width
F.3.4. Make outbound command session
F.3.5. Show command sessions
F.3.6. Kill command session
F.3.7. Flash memory list
F.3.8. Delete block from flash
F.3.9. Boot log
F.3.10. Flash log
G. Constant Quality Monitoring - technical details
G.1. Access to graphs and csvs
G.1.1. Trusted access
G.1.2. Dated information
G.1.3. Authenticated access
G.2. Graph display options
G.2.1. Data points
G.2.2. Additional text
G.2.3. Other colours and spacing
G.3. Overnight archiving
G.3.1. Full URL format
G.3.2. load handling
G.4. Graph scores
G.5. Creating graphs, and graph names
H. Configuration Objects
H.1. Top level
H.1.1. config: Top level config
H.2. Objects
H.2.1. system: System settings
H.2.2. link: Web links
H.2.3. user: Admin users
H.2.4. log: Log target controls
H.2.5. log-syslog: Syslog logger settings
H.2.6. log-email: Email logger settings
H.2.7. services: System services
H.2.8. snmp-service: SNMP service settings
H.2.9. ntp-service: NTP service settings
H.2.10. telnet-service: Telnet service settings
H.2.11. http-service: HTTP service settings
H.2.12. dns-service: DNS service settings
H.2.13. dns-host: Fixed local DNS host settings
H.2.14. dns-block: Fixed local DNS blocks
H.2.15. ethernet: Physical port controls
H.2.16. portdef: Port grouping and naming
H.2.17. interface: Port-group/VLAN interface settings
H.2.18. subnet: Subnet settings
H.2.19. vrrp: VRRP settings
H.2.20. dhcps: DHCP server settings
H.2.21. dhcp-attr-hex: DHCP server attributes (hex)
H.2.22. dhcp-attr-string: DHCP server attributes (string)
H.2.23. dhcp-attr-number: DHCP server attributes (numeric)
H.2.24. dhcp-attr-ip: DHCP server attributes (IP)
H.2.25. route: Static routes
H.2.26. blackhole: Dead end networks
H.2.27. loopback: Locally originated networks
H.2.28. cqm: Constant Quality Monitoring settings
H.2.29. ip-group: IP Group
H.3. Data types
H.3.1. autoloadtype: Type of s/w auto load
H.3.2. config-access: Type of access user has to config
H.3.3. user-level: User login level
H.3.4. syslog-severity: Syslog severity
H.3.5. syslog-facility: Syslog facility
H.3.6. month: Month name (3 letter)
H.3.7. day: Day name (3 letter)
H.3.8. port: Physical port
H.3.9. Crossover: Crossover configuration
H.3.10. LinkSpeed: Physical port speed
H.3.11. LinkDuplex: Physical port duplex setting
H.3.12. LinkFlow: Physical port flow control setting
H.3.13. LinkClock: Physical port Gigabit clock master/slave setting
H.3.14. LinkLED: LED settings
H.3.15. LinkPower: PHY power saving options
H.3.16. LinkFault: Link fault type to send
H.3.17. ramode: IPv6 route announce level
H.3.18. dhcpv6control: Control for RA and DHCPv6 bits
H.3.19. sfoption: Source filter option
H.4. Basic types
Index

List of Figures

2.1. Initial web page in factory reset state
2.2. Initial "Users" page
2.3. Setting up a new user
2.4. Configuration being stored
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
G.1. File types
G.2. Colours
G.3. Text
G.4. Text
G.5. URL formats
H.1. config: Attributes
H.2. config: Elements
H.3. system: Attributes
H.4. system: Elements
H.5. link: Attributes
H.6. user: Attributes
H.7. log: Attributes
H.8. log: Elements
H.9. log-syslog: Attributes
H.10. log-email: Attributes
H.11. services: Elements
H.12. snmp-service: Attributes
H.13. ntp-service: Attributes
H.14. telnet-service: Attributes
H.15. http-service: Attributes
H.16. dns-service: Attributes
H.17. dns-service: Elements
H.18. dns-host: Attributes
H.19. dns-block: Attributes
H.20. ethernet: Attributes
H.21. portdef: Attributes
H.22. interface: Attributes
H.23. interface: Elements
H.24. subnet: Attributes
H.25. vrrp: Attributes
H.26. dhcps: Attributes
H.27. dhcps: Elements
H.28. dhcp-attr-hex: Attributes
H.29. dhcp-attr-string: Attributes
H.30. dhcp-attr-number: Attributes
H.31. dhcp-attr-ip: Attributes
H.32. route: Attributes
H.33. blackhole: Attributes
H.34. loopback: Attributes
H.35. cqm: Attributes
H.36. ip-group: Attributes
H.37. autoloadtype: Type of s/w auto load
H.38. config-access: Type of access user has to config
H.39. user-level: User login level
H.40. syslog-severity: Syslog severity
H.41. syslog-facility: Syslog facility
H.42. month: Month name (3 letter)
H.43. day: Day name (3 letter)
H.44. port: Physical port
H.45. Crossover: Crossover configuration
H.46. LinkSpeed: Physical port speed
H.47. LinkDuplex: Physical port duplex setting
H.48. LinkFlow: Physical port flow control setting
H.49. LinkClock: Physical port Gigabit clock master/slave setting
H.50. LinkLED: LED settings
H.51. LinkPower: PHY power saving options
H.52. LinkFault: Link fault type to send
H.53. ramode: IPv6 route announce level
H.54. dhcpv6control: Control for RA and DHCPv6 bits
H.55. sfoption: Source filter option
H.56. Basic data types
   Next
   Preface