Route - Revision history

DrModiford: The default gateway is documented under gateway

2008-01-24T11:22:41Z

The default gateway is documented under gateway

DrModiford: Added warning of reboot loss of routing

2008-01-24T11:09:45Z

Added warning of reboot loss of routing

DrModiford: Added example usage (common ones)

2008-01-24T11:08:20Z

Added example usage (common ones)

DrModiford: Example use header

2008-01-24T10:42:11Z

Example use header

DrModiford: changed wording on Microsoft Windows equivalents

2008-01-24T10:40:47Z

changed wording on Microsoft Windows equivalents

DrModiford: Minor See Also change

2008-01-24T10:39:06Z

Minor See Also change

DrModiford: Added guide articles as See also

2008-01-24T10:38:39Z

Added guide articles as See also

DrModiford: Created initial route command reference

2008-01-24T10:37:11Z

Created initial route command reference

New page

{{System-Commands}}

The '''route''' command is used to manually configure the routing on FreeBSD. It differs in usage from the Microsoft command of the same name which can confuse system administrators migrating across platforms.

Typically the route command is not required since advanced routing requirements would ordinarily be maintained by the [[routed]] daemon.

== Usage ==

The command itself has only a few options but makes up for this with what is described as a ''programmatic'' command language interface. The available options are as follows.

=== Debug ===

The '''-d''' option executes the request but does not implement it. It allows the request to be tested to ensure there are no issues arising from doing so.

=== Name resolution ===

The '''-n''' option instructs the route command to not resolve IP addresses to DNS names. This is useful where name resolution may slow down the presentation of information or otherwise where no DNS name servers are available or configured for use.

=== Verbosity ===

The '''-v''' option presents additional information on the screen.

=== Quiet ===

The '''-q''' option suppresses information for certain commands, namely; 'add', 'change' and 'flush' (see below).

=== Commands ===

The following commands are exist:

==== Add ====

The '''add''' command creates a new route entry into the routing table.

==== Flush ====

The '''flush''' command removes all routes from the routing table ('''use with caution''').

==== Delete ====

The '''delete''' command removes a single route entry from the routing table.

==== Change ====

The '''change''' command changes a specific element of a route already in the routing table.

==== Get ====

The '''get''' command displays a specific entry of the routing table.

==== Monitor ====

The '''monitor''' command continuously displays changes to or queries from the routing table.

== Microsoft Windows equivalents ==

Many system administrators from the Microsoft world will be used to the '''route show''' command. This is not available from the FreeBSD 'route' command. To show current routing information in a similar way to Microsoft Windows use the command '''netstat -r''', as an example.

$ '''netstat -r'''
Routing tables

Internet:
Destination Gateway Flags Refs Use Netif Expire
default 172.27.0.1 UGS 0 1822642 fxp0
localhost localhost UH 0 3946 lo0
172.27/24 link#1 UC 0 0 fxp0
172.27.0.1 00:02:a5:77:5c:29 UHLW 2 0 fxp0 1193
mail 00:02:a5:84:d3:10 UHLW 1 22373 lo0

Internet6:
Destination Gateway Flags Netif Expire
localhost.domain localhost.domain UH lo0
fe80::%fxp0 link#1 UC fxp0
fe80::202:a5ff:fe8 00:02:a5:84:d3:10 UHL lo0
fe80::%lo0 fe80::1%lo0 U lo0
fe80::1%lo0 link#3 UHL lo0
ff01:1:: link#1 UC fxp0
ff01:3:: localhost.domain UC lo0
ff02::%fxp0 link#1 UC fxp0
ff02::%lo0 localhost.domain UC lo0

=== See also ===

See also: [[netstat]]

[[Category:System Commands]]

@@ Line 59: / Line 59: @@
 === Default route (gateway) ===
-Adding a [[default gateway]] is done using the following command:
+Adding a default [[gateway]] is done using the following command:
   #route add -net default 192.168.0.1

← Older revision		Revision as of 11:09, 24 January 2008
Line 54:		Line 54:

	== Example use ==		== Example use ==
		+
		+	'''Note:''' the following commands will modify the routing table but any changes will be lost upon the next reboot. See articles in the 'See also' section below for more advanced methods of route management.

	=== Default route (gateway) ===		=== Default route (gateway) ===

← Older revision		Revision as of 11:08, 24 January 2008
Line 54:		Line 54:

	== Example use ==		== Example use ==
		+
		+	=== Default route (gateway) ===
		+
		+	Adding a [[default gateway]] is done using the following command:
		+
		+	#route add -net default 192.168.0.1
		+	add net default: gateway 192.168.0.1
		+
		+	The 'default' option is an inbuilt alias for the default gateway and '192.168.0.1' is the router IP in this instance.
		+
		+	=== Manual route ===
		+
		+	Adding a static route is done using the following command:
		+
		+	#route add -net 192.168.20.0/24 192.168.0.2
		+	add net 192.168.20.0: gateway 192.168.0.2
		+
		+	The '192.168.20.0/24' is the subnet of the remote network, which would have been specified as '192.168.20.0 mask 255.255.255.0' on Microsoft Windows or '192.168.20.0 netmask 255.255.255.0' on Linux and other platforms. The '192.168.0.2' is the router IP connecting to the remote network.
		+
		+	=== Delete route ===
		+
		+	Deleting a route is done using the following command:
		+
		+	#route delete 192.168.20.0
		+	delete net 192.168.20.0
		+
		+	The '192.168.20.0' is the route entry being deleted. This can also be specified as '192.168.20.0/24' where a more specific route is used.

	== Microsoft Windows equivalents ==		== Microsoft Windows equivalents ==

← Older revision		Revision as of 10:42, 24 January 2008
Line 52:		Line 52:

	The '''monitor''' command continuously displays changes to or queries from the routing table.		The '''monitor''' command continuously displays changes to or queries from the routing table.
		+
		+	== Example use ==

	== Microsoft Windows equivalents ==		== Microsoft Windows equivalents ==

@@ Line 82: / Line 82: @@
 === See also ===
-See also: [[netstat]], [[Network Configuration (basic)]] and [[Network Configuration (Advanced)]].
+See also the articles on [[netstat]], [[Network Configuration (basic)]] and [[Network Configuration (Advanced)]].
 [[Category:System Commands]]

@@ Line 55: / Line 55: @@
 == Microsoft Windows equivalents ==
-Many system administrators from the Microsoft world will be used to the '''route show''' command.  This is not available from the FreeBSD 'route' command.  To show current routing information in a similar way to Microsoft Windows use the command '''netstat -r''', as an example.
+Many system administrators from the Microsoft world will be used to using the '''route show''' command to display current routing table information.  This is not available from the FreeBSD command of the same name.  However it is available using '''netstat -r''' command instead.
   $ '''netstat -r'''