Appendix A. Command line reference

A.1. General commands

A.1.1. Trace off

troff

Stop interactive logging to this CLI session, lasts until logout or tron.

A.1.2. Trace on

tron

Restart interactive logging to this CLI session. Some types of logging can be set to log to console which shows on the CLI.

A.1.3. Uptime

uptime
show uptime

Shows how long since the FB2700 restarted.

A.1.4. General status

show status

Shows general status information, including uptime, who owns the FireBrick, etc. This is the same as the Status on the web control pages.

A.1.5. Memory usage

show memory

Shows memory usage summary.

A.1.6. Process/task usage

show tasks

Shows internal task list. This is mainly for diagnostics purposes.

A.1.7. Login

login

Normally when you connect you are prompted for a username and password. If this is incorrect you can use the login to try again.

A.1.8. Logout

logout
quit
exit

You can also use Ctrl-D to exit, or close the connection (if using telnet)

A.1.9. See XML configuration

show run
show configuration

Dumps the full XML configuration to the screen

A.1.10. Load XML configuration

import configuration

You then send the XML configuration, ending with a blank line. You would not normally import a configuration using this command, as you can use the web interface, and tools like curl to load configtations. This command is provided as a last resort for emergency use, so use with care.

A.2. Networking commands

A.2.1. Subnets

show subnets
show subnet <integer>

You can list all current subnets, or details of a specific subnet. This shows the same information as the web status pages for subnets.

A.2.2. Ping and trace

ping <IPNameAddr> [table=<routetable>] [source=<IPAddr>]
     [gateway=<IPAddr>] [flow=<unsignedShort>]
     [count=<positiveInteger>] [ttl=<unsignedByte>]
     [size=<unsignedShort>] [xml=<boolean>]
traceroute <IPNameAddr> [table=<routetable>] [source=<IPAddr>]
           [gateway=<IPAddr>] [flow=<unsignedShort>]
	   [count=<positiveInteger>] [ttl=<unsignedByte>]
	   [size=<unsignedShort>] [xml=<boolean>]

This sends a series of ICMP echo requests (ping) to a specified destination and confirms a response is received and the round trip time. For the traceroute variant, the TTL/Hopcount is increased by one each time to show a series of response hops. There are a number of controls allowing you to fine tune what is sent. Obviously you should only send from a source address that will return to the FB2700 correctly. You can also ask for the results to be presented in an XML format.

Where possible, the reverse DNS name is shown next to replies, but there is (deliberately) no delay waiting for DNS responses, so you may find it useful to run a trace a second time as results from the first attempt will be cached.

Note

This command summary is not yet complete, please see www.firebrick.co.uk for details

A.3. Firewalling commands

Note

This command summary is not yet complete, please see www.firebrick.co.uk for details

A.4. L2TP commands

Note

This command summary is not yet complete, please see www.firebrick.co.uk for details

A.5. BGP commands

Note

This command summary is not yet complete, please see www.firebrick.co.uk for details

A.6. VoIP commands

Note

This command summary is not yet complete, please see www.firebrick.co.uk for details

A.7. Advanced commands

Some commands are only available when logged in as a user set with DEBUG level access.

A.7.1. Panic

panic [<string>] [confirm=<string>]

This causes the FB2700 to crash, causing a panic event with a specified message. You need to specify confirm=yes for the command to work. This can be useful to test fallback scenarios by simulating a fatal error. Note that panic crash logs are emailed to the FireBrick support by default, so please use a meaningful string. e.g. panic "testing fallback" confirm=yes

A.7.2. Reboot

reboot [<unsignedInt>] [hard] [confirm=<string>]

A reboot is a more controlled shutdown and restart, unlike the panic command. The first argument is a block number (see show flash contents) and forces reboot to run a specific software stored in flash. Normally the reboot will run the latest valid code. The hard option forces the reboot to clear the Ethernet ports and other hardware so takes a couple of seconds. You must specify confirm=yes for this to work.

A.7.3. Screen width

set command screen width <unsignedInt>

This allows you to set the screen width.

A.7.4. Make outbound command session

start command session <IPAddr> [port=<unsignedShort>] [table=<routetable>]

This allows a reverse telnet connection to be made. A TCP connection is made to the IP address (and port) where a user can login. This can be useful where a firewall policy prevents incoming access to allow someone to have access from outside, e.g. the FireBrick support team.

A.7.5. Show command sessions

show command sessions

The FB2700 can have multiple telnet connections at the same time. This lists all of the current connections.

A.7.6. Kill command session

kill command session <IPAddr>

You can kill a command session by IP address. This is useful if you know you have left a telnet connected from somewhere else. Telnet sessions usually have a timeout, but this can be overridden in the configuration for each user.

A.7.7. Flash memory list

show flash contents

Lists the content of flash memory - this includes various files such as software releases, configuration, and so on. Multiple copies are usually stored allowing you to delete a later version if needed, and roll-back to an older version.

A.7.8. Delete block from flash

delete config <unsignedInt> [confirm=<string>]
delete data <unsignedInt> [confirm=<string>]
delete image <unsignedInt> [confirm=<string>]

Delete a block from flash memory. This cannot be undone. You have to specify the correct type of block, and specify confirm=yes for the command to work.

A.7.9. Boot log

show boot log [<unsignedInt>]

Show log of recent boots. You can specify the number of bytes of recent log to show.

A.7.10. Flash log

show flash log [<unsignedInt>]

The logging system can log to flash for a permanent record. This is done automatically for some system events and when booting. You can specify the number of bytes of recent log to show..