FireBrick FB2700 User manual

FireBrick NULL
User Manual
FB2700 Versatile Network Appliance

FireBrick NULL User Manual
This User Manual documents Software version V1.28.000
Copyright © 2012-2013 FireBrick Ltd.

iv
Table of Contents
Preface .................................................................................................................................. xiii
1. Introduction .......................................................................................................................... 1
1.1. The FB2700 ............................................................................................................... 1
1.1.1. Where do I start? .............................................................................................. 1
1.1.2. What can it do? ................................................................................................ 1
1.1.3. Ethernet port capabilities .................................................................................... 2
1.1.4. Differences between the devices in the FB2x00 series .............................................. 2
1.1.5. Software features .............................................................................................. 2
1.1.6. Migration from previous FireBrick models ............................................................ 2
1.2. About this Manual ....................................................................................................... 3
1.2.1. Version ........................................................................................................... 3
1.2.2. Intended audience ............................................................................................. 3
1.2.3. Technical details ............................................................................................... 3
1.2.4. Document style ................................................................................................. 3
1.2.5. Document conventions ....................................................................................... 4
1.2.6. Comments and feedback .................................................................................... 4
1.3. Additional Resources ................................................................................................... 4
1.3.1. Technical Support ............................................................................................. 4
1.3.2. IRC Channel .................................................................................................... 5
1.3.3. Application Notes ............................................................................................. 5
1.3.4. White Papers .................................................................................................... 5
1.3.5. Training Courses ............................................................................................... 5
2. Getting Started ...................................................................................................................... 6
2.1. IP addressing .............................................................................................................. 6
2.2. Accessing the web-based user interface ........................................................................... 6
2.2.1. Add a new user ................................................................................................ 7
3. Configuration ........................................................................................................................ 9
3.1. The Object Hierarchy ................................................................................................... 9
3.2. The Object Model ....................................................................................................... 9
3.2.1. Formal definition of the object model ................................................................. 10
3.2.2. Common attributes .......................................................................................... 10
3.3. Configuration Methods ............................................................................................... 10
3.4. Web User Interface Overview ...................................................................................... 10
3.4.1. User Interface layout ........................................................................................ 11
3.4.1.1. Customising the layout .......................................................................... 11
3.4.2. Config pages and the object hierarchy ................................................................. 12
3.4.2.1. Configuration categories ......................................................................... 12
3.4.2.2. Object settings ...................................................................................... 13
3.4.3. Navigating around the User Interface .................................................................. 15
3.4.4. Backing up / restoring the configuration .............................................................. 16
3.5. Configuration using XML ........................................................................................... 16
3.5.1. Introduction to XML ........................................................................................ 16
3.5.2. The root element - <config> ............................................................................. 17
3.5.3. Viewing or editing XML .................................................................................. 17
3.5.4. Example XML configuration ............................................................................. 17
3.6. Downloading/Uploading the configuration ...................................................................... 19
3.6.1. Download ...................................................................................................... 19
3.6.2. Upload .......................................................................................................... 19
4. System Administration .......................................................................................................... 20
4.1. User Management ...................................................................................................... 20
4.1.1. Login level ..................................................................................................... 20
4.1.2. Configuration access level ................................................................................ 21
4.1.3. Login idle timeout ........................................................................................... 21
4.1.4. Restricting user logins ...................................................................................... 21

FireBrick NULL User Manual
v
4.1.4.1. Restrict by IP address ............................................................................ 21
4.1.4.2. Logged in IP address ............................................................................. 21
4.1.4.3. Restrict by profile ................................................................................. 22
4.2. General System settings .............................................................................................. 22
4.2.1. System name (hostname) .................................................................................. 22
4.2.2. Administrative details ...................................................................................... 22
4.2.3. System-level event logging control ..................................................................... 22
4.2.4. Home page web links ...................................................................................... 23
4.3. Software Upgrades ..................................................................................................... 23
4.3.1. Software release types ...................................................................................... 23
4.3.1.1. Breakpoint releases ............................................................................... 24
4.3.2. Identifying current software version .................................................................... 24
4.3.3. Internet-based upgrade process .......................................................................... 24
4.3.3.1. Manually initiating upgrades ................................................................... 25
4.3.3.2. Controlling automatic software updates ..................................................... 25
4.3.4. Manual upgrade .............................................................................................. 25
4.4. Boot Process ............................................................................................................. 26
4.4.1. LED indications .............................................................................................. 26
4.4.1.1. Power LED status indications ................................................................. 26
4.4.1.2. Port LEDs ........................................................................................... 26
5. Event Logging ..................................................................................................................... 28
5.1. Overview .................................................................................................................. 28
5.1.1. Log targets ..................................................................................................... 28
5.1.1.1. Logging to Flash memory ...................................................................... 28
5.1.1.2. Logging to the Console .......................................................................... 29
5.2. Enabling logging ....................................................................................................... 29
5.3. Logging to external destinations ................................................................................... 29
5.3.1. Syslog ........................................................................................................... 29
5.3.2. Email ............................................................................................................ 30
5.3.2.1. E-mail process logging .......................................................................... 31
5.4. Factory reset configuration log targets ........................................................................... 31
5.5. Performance .............................................................................................................. 31
5.6. Viewing logs ............................................................................................................. 31
5.6.1. Viewing logs in the User Interface ..................................................................... 31
5.6.2. Viewing logs in the CLI environment ................................................................. 32
5.7. System-event logging ................................................................................................. 32
5.8. Using Profiles ........................................................................................................... 32
6. Interfaces and Subnets .......................................................................................................... 33
6.1. Relationship between Interfaces and Physical Ports .......................................................... 33
6.1.1. Port groups .................................................................................................... 33
6.1.2. Interfaces ....................................................................................................... 33
6.2. Defining port groups .................................................................................................. 33
6.3. Defining an interface .................................................................................................. 34
6.3.1. Defining subnets ............................................................................................. 34
6.3.1.1. Using DHCP to configure a subnet .......................................................... 35
6.3.2. Setting up DHCP server parameters .................................................................... 35
6.3.2.1. Fixed/Static DHCP allocations ................................................................ 36
6.3.2.1.1. Special DHCP attributes .............................................................. 37
6.3.2.2. Partial-MAC-address based allocations ..................................................... 37
6.4. Physical port settings .................................................................................................. 37
6.4.1. Disabling auto-negotiation ................................................................................ 37
6.4.2. Setting port speed ............................................................................................ 38
6.4.3. Setting duplex mode ........................................................................................ 38
6.4.4. Defining port LED functions ............................................................................. 38
7. Routing .............................................................................................................................. 40
7.1. Routing logic ............................................................................................................ 40

FireBrick NULL User Manual
vi
7.2. Routing targets .......................................................................................................... 41
7.2.1. Subnet routes .................................................................................................. 41
7.2.2. Routing to an IP address (gateway route) ............................................................. 41
7.2.3. Special targets ................................................................................................ 42
7.3. Dynamic route creation / deletion ................................................................................. 42
7.4. Routing tables ........................................................................................................... 42
7.5. Bonding ................................................................................................................... 42
8. Profiles ............................................................................................................................... 44
8.1. Overview .................................................................................................................. 44
8.2. Creating/editing profiles .............................................................................................. 44
8.2.1. Timing control ................................................................................................ 44
8.2.2. Tests ............................................................................................................. 45
8.2.2.1. General tests ........................................................................................ 45
8.2.2.2. Time/date tests ..................................................................................... 45
8.2.2.3. Ping tests ............................................................................................. 45
8.2.3. Inverting overall test result ................................................................................ 45
8.2.4. Manual override .............................................................................................. 45
9. Traffic Shaping .................................................................................................................... 47
9.1. Graphs and Shapers ................................................................................................... 47
9.1.1. Graphs ........................................................................................................... 47
9.1.2. Shapers .......................................................................................................... 48
9.1.3. Ad hoc shapers ............................................................................................... 48
9.1.4. Long term shapers ........................................................................................... 48
9.2. Multiple shapers ........................................................................................................ 48
9.3. Basic principles ......................................................................................................... 49
10. System Services ................................................................................................................. 50
10.1. Protecting the FB2700 .............................................................................................. 50
10.2. Common settings ..................................................................................................... 50
10.3. HTTP Server configuration ........................................................................................ 51
10.3.1. Access control ............................................................................................... 51
10.3.1.1. Trusted addresses ................................................................................ 51
10.4. Telnet Server configuration ........................................................................................ 51
10.4.1. Access control ............................................................................................... 52
10.5. DNS configuration ................................................................................................... 52
10.5.1. Blocking DNS names ..................................................................................... 52
10.5.2. Local DNS responses ..................................................................................... 52
10.5.3. Auto DHCP DNS .......................................................................................... 52
10.6. NTP configuration .................................................................................................... 53
10.7. SNMP configuration ................................................................................................. 53
11. Network Diagnostic Tools .................................................................................................... 54
11.1. Access check ........................................................................................................... 54
11.2. Packet Dumping ...................................................................................................... 55
11.2.1. Dump parameters ........................................................................................... 55
11.2.2. Security settings required ................................................................................ 56
11.2.3. IP address matching ....................................................................................... 56
11.2.4. Packet types .................................................................................................. 56
11.2.5. Snaplen specification ...................................................................................... 56
11.2.6. Using the web interface .................................................................................. 57
11.2.7. Using an HTTP client .................................................................................... 57
11.2.7.1. Example using curl and tcpdump ........................................................... 57
12. VRRP ............................................................................................................................... 58
12.1. Virtual Routers ........................................................................................................ 58
12.2. Configuring VRRP ................................................................................................... 59
12.2.1. Advertisement Interval .................................................................................... 59
12.2.2. Priority ........................................................................................................ 59
12.3. Using a virtual router ................................................................................................ 59

FireBrick NULL User Manual
vii
12.4. VRRP versions ........................................................................................................ 59
12.4.1. VRRP version 2 ............................................................................................ 59
12.4.2. VRRP version 3 ............................................................................................ 60
12.5. Compatibility ........................................................................................................... 60
13. Command Line Interface ...................................................................................................... 61
A. Factory Reset Procedure ....................................................................................................... 62
B. CIDR and CIDR Notation ..................................................................................................... 64
C. MAC Addresses usage .......................................................................................................... 66
D. VLANs : A primer ............................................................................................................... 68
E. Command line reference ....................................................................................................... 69
E.1. General commands .................................................................................................... 69
E.1.1. Trace off ....................................................................................................... 69
E.1.2. Trace on ........................................................................................................ 69
E.1.3. Uptime .......................................................................................................... 69
E.1.4. General status ................................................................................................. 69
E.1.5. Memory usage ................................................................................................ 69
E.1.6. Process/task usage ........................................................................................... 69
E.1.7. Login ............................................................................................................ 69
E.1.8. Logout .......................................................................................................... 70
E.1.9. See XML configuration .................................................................................... 70
E.1.10. Load XML configuration ................................................................................ 70
E.1.11. Show profile status ........................................................................................ 70
E.1.12. Enable profile control switch ........................................................................... 70
E.1.13. Disable profile control switch .......................................................................... 70
E.1.14. Show RADIUS servers ................................................................................... 70
E.1.15. Show DNS resolvers ...................................................................................... 70
E.2. Networking commands ............................................................................................... 71
E.2.1. Subnets ......................................................................................................... 71
E.2.2. Ping and trace ................................................................................................ 71
E.2.3. Show a route from the routing table ................................................................... 71
E.2.4. List routes ..................................................................................................... 71
E.2.5. List routing next hops ...................................................................................... 71
E.2.6. See DHCP allocations ...................................................................................... 72
E.2.7. Clear DHCP allocations ................................................................................... 72
E.2.8. Lock DHCP allocations .................................................................................... 72
E.2.9. Unlock DHCP allocations ................................................................................. 72
E.2.10. Name DHCP allocations ................................................................................. 72
E.2.11. Show ARP/ND status ..................................................................................... 72
E.2.12. Show VRRP status ........................................................................................ 72
E.2.13. Send Wake-on-LAN packet ............................................................................. 72
E.2.14. Check access to services ................................................................................. 73
E.3. Advanced commands ................................................................................................. 73
E.3.1. Panic ............................................................................................................ 73
E.3.2. Reboot .......................................................................................................... 73
E.3.3. Screen width .................................................................................................. 73
E.3.4. Make outbound command session ...................................................................... 73
E.3.5. Show command sessions .................................................................................. 73
E.3.6. Kill command session ...................................................................................... 73
E.3.7. Flash memory list ........................................................................................... 74
E.3.8. Delete block from flash .................................................................................... 74
E.3.9. Boot log ........................................................................................................ 74
E.3.10. Flash log ...................................................................................................... 74
F. Constant Quality Monitoring - technical details ......................................................................... 75
F.1. Access to graphs and csvs ........................................................................................... 75
F.1.1. Trusted access ................................................................................................ 75
F.1.2. Dated information ........................................................................................... 75

FireBrick NULL User Manual
viii
F.1.3. Authenticated access ........................................................................................ 76
F.2. Graph display options ................................................................................................. 76
F.2.1. Data points .................................................................................................... 76
F.2.2. Additional text ................................................................................................ 76
F.2.3. Other colours and spacing ................................................................................ 77
F.3. Overnight archiving ................................................................................................... 77
F.3.1. Full URL format ............................................................................................. 77
F.3.2. load handling .................................................................................................. 78
F.4. Graph scores ............................................................................................................. 78
F.5. Creating graphs, and graph names ................................................................................ 78
G. Configuration Objects .......................................................................................................... 80
G.1. Top level ................................................................................................................. 80
G.1.1. config: Top level config .................................................................................. 80
G.2. Objects .................................................................................................................... 80
G.2.1. system: System settings ................................................................................... 80
G.2.2. link: Web links .............................................................................................. 81
G.2.3. user: Admin users ........................................................................................... 81
G.2.4. log: Log target controls ................................................................................... 82
G.2.5. log-syslog: Syslog logger settings ...................................................................... 82
G.2.6. log-email: Email logger settings ........................................................................ 83
G.2.7. services: System services ................................................................................. 83
G.2.8. snmp-service: SNMP service settings ................................................................. 84
G.2.9. ntp-service: NTP service settings ....................................................................... 84
G.2.10. telnet-service: Telnet service settings ................................................................ 85
G.2.11. http-service: HTTP service settings .................................................................. 85
G.2.12. dns-service: DNS service settings .................................................................... 86
G.2.13. dns-host: Fixed local DNS host settings ............................................................ 87
G.2.14. dns-block: Fixed local DNS blocks .................................................................. 87
G.2.15. ethernet: Physical port controls ........................................................................ 87
G.2.16. portdef: Port grouping and naming ................................................................... 88
G.2.17. interface: Port-group/VLAN interface settings .................................................... 88
G.2.18. subnet: Subnet settings ................................................................................... 89
G.2.19. vrrp: VRRP settings ...................................................................................... 90
G.2.20. dhcps: DHCP server settings ........................................................................... 90
G.2.21. dhcp-attr-hex: DHCP server attributes (hex) ....................................................... 91
G.2.22. dhcp-attr-string: DHCP server attributes (string) ................................................. 91
G.2.23. dhcp-attr-number: DHCP server attributes (numeric) ........................................... 92
G.2.24. dhcp-attr-ip: DHCP server attributes (IP) ........................................................... 92
G.2.25. route: Static routes ........................................................................................ 92
G.2.26. blackhole: Dead end networks ......................................................................... 93
G.2.27. loopback: Locally originated networks .............................................................. 93
G.2.28. cqm: Constant Quality Monitoring settings ........................................................ 93
G.2.29. ip-group: IP Group ........................................................................................ 95
G.3. Data types ............................................................................................................... 96
G.3.1. autoloadtype: Type of s/w auto load .................................................................. 96
G.3.2. config-access: Type of access user has to config .................................................. 96
G.3.3. user-level: User login level ............................................................................... 96
G.3.4. syslog-severity: Syslog severity ......................................................................... 96
G.3.5. syslog-facility: Syslog facility ........................................................................... 97
G.3.6. month: Month name (3 letter) ........................................................................... 97
G.3.7. day: Day name (3 letter) .................................................................................. 98
G.3.8. port: Physical port .......................................................................................... 98
G.3.9. Crossover: Crossover configuration .................................................................... 98
G.3.10. LinkSpeed: Physical port speed ....................................................................... 99
G.3.11. LinkDuplex: Physical port duplex setting .......................................................... 99
G.3.12. LinkFlow: Physical port flow control setting ...................................................... 99

FireBrick NULL User Manual
ix
G.3.13. LinkClock: Physical port Gigabit clock master/slave setting .................................. 99
G.3.14. LinkLED: LED settings ................................................................................. 99
G.3.15. LinkPower: PHY power saving options ........................................................... 100
G.3.16. LinkFault: Link fault type to send .................................................................. 100
G.3.17. ramode: IPv6 route announce level ................................................................. 101
G.3.18. dhcpv6control: Control for RA and DHCPv6 bits .............................................. 101
G.3.19. sfoption: Source filter option ......................................................................... 101
G.4. Basic types ............................................................................................................. 101
Index .................................................................................................................................... 104

x
List of Figures
2.1. Initial web page in factory reset state ...................................................................................... 7
2.2. Initial "Users" page .............................................................................................................. 7
2.3. Setting up a new user .......................................................................................................... 8
2.4. Configuration being stored .................................................................................................... 8
3.1. Main menu ....................................................................................................................... 11
3.2. Icons for layout controls ..................................................................................................... 12
3.3. Icons for configuration categories ......................................................................................... 12
3.4. The "Setup" category .......................................................................................................... 13
3.5. Editing an "Interface" object ................................................................................................ 14
3.6. Show hidden attributes ....................................................................................................... 14
3.7. Attribute definitions ........................................................................................................... 14
3.8. Navigation controls ............................................................................................................ 15
4.1. Setting up a new user ......................................................................................................... 20
4.2. Software upgrade available notification ................................................................................. 25
4.3. Manual Software upload ..................................................................................................... 26
C.1. Product label showing MAC address range ............................................................................ 66