[people/stevee/network.git] / man / network-route.8.in

.TH network-route 8 "11 Aug 2012" "@VERSION@" "network man page"

.SH NAME
network-route \- Network Route Configuration Control Program

.SH SYNOPSIS
\fBnetwork [OPTIONS] route add <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
.P
\fBnetwork [OPTIONS] route remove <network>\fR
.P
\fBnetwork [OPTIONS] route list\fR

.SH DESCRIPTION
The route subcommands, help to configure static routes.
.PP
It is possible to create and remove static routes.

.SH COMMANDS
The \fBnetwork route\fR command offers various sub commands:

\fBadd <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
.RS 4
A new route may be added by the \fBadd\fR command.
It is always required to pass a valid network prefix (\fB<network>\fR), which
can be either IPv6 or IPv4.
.PP
For unicast routes, the \fB--gateway=<gateway>\fR option must be passed, where
\fB<gateway>\fR is a valid IP address of the same protocol type as the network
prefix is.
.PP
Use \fB--unreachable\fR, \fB--prohibit\fR, \fB--blackhole\fR can be used to create
of that type. See \fBROUTE TYPES\fR below for more information about these options.
.PP
The optional \fB--mtu\fR parameter defines the MTU along the path to the
destination and must be an integer number.
.RE
.PP

\fBremove <network>\fR
.RS 4
A route can be removed with this command.
.PP
\fB<network>\fR is the network prefix of a existing route.
.RE
.PP

\fBlist [--protocol=ipv6|ipv4]\fR
.RS 4
Shows a list of all configured routes.
.PP
Pass the protocol option to filter the output only for the given
protocol.
.RE
.PP

.SH ROUTE TYPES

\fBunicast\fR
.RS 4
A unicast route is the most common route in routing tables. It is a route to a destination
network address, which describes the path to the destination.
Use the \fB--gateway=...\fR option to create such a route.
.RE
.PP

\fBunreachable\fR
.RS 4
When a route is determined and the routing decision process returns a destination with
an unreachable route type, an ICMP unreachable message is generated and returned to
the source address.
.RE
.PP

\fBprohibit\fR
.RS 4
This works like an \fBunreachable\fR route, but the returned ICMP message is an
ICMP prohibited message.
.RE
.PP

\fBblackhole\fR
.RS 4
Packets matching this kind of route are silently discarded. There will be no ICMP message
sent to the source and no packet be forwarded.
.RE
.PP

.SH SEE ALSO
network(8), ip-route(8)

.SH AUTHOR
Michael Tremer (michael.tremer@ipfire.org)
Commit	Line	Data
3b655131 MT	1	.TH network-route 8 "11 Aug 2012" "@VERSION@" "network man page"
	2
	3	.SH NAME
	4	network-route \- Network Route Configuration Control Program
	5
	6	.SH SYNOPSIS
478de6f9	7	\fBnetwork [OPTIONS] route add <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
3b655131 MT	8	.P
	9	\fBnetwork [OPTIONS] route remove <network>\fR
	10	.P
	11	\fBnetwork [OPTIONS] route list\fR
	12
	13	.SH DESCRIPTION
	14	The route subcommands, help to configure static routes.
	15	.PP
	16	It is possible to create and remove static routes.
	17
	18	.SH COMMANDS
	19	The \fBnetwork route\fR command offers various sub commands:
	20
478de6f9	21	\fBadd <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
3b655131 MT	22	.RS 4
	23	A new route may be added by the \fBadd\fR command.
	24	It is always required to pass a valid network prefix (\fB<network>\fR), which
	25	can be either IPv6 or IPv4.
	26	.PP
	27	For unicast routes, the \fB--gateway=<gateway>\fR option must be passed, where
	28	\fB<gateway>\fR is a valid IP address of the same protocol type as the network
	29	prefix is.
	30	.PP
	31	Use \fB--unreachable\fR, \fB--prohibit\fR, \fB--blackhole\fR can be used to create
	32	of that type. See \fBROUTE TYPES\fR below for more information about these options.
478de6f9 MT	33	.PP
	34	The optional \fB--mtu\fR parameter defines the MTU along the path to the
	35	destination and must be an integer number.
3b655131 MT	36	.RE
	37	.PP
	38
	39	\fBremove <network>\fR
	40	.RS 4
	41	A route can be removed with this command.
	42	.PP
	43	\fB<network>\fR is the network prefix of a existing route.
	44	.RE
	45	.PP
	46
478de6f9	47	\fBlist [--protocol=ipv6\|ipv4]\fR
3b655131 MT	48	.RS 4
	49	Shows a list of all configured routes.
	50	.PP
478de6f9 MT	51	Pass the protocol option to filter the output only for the given
478de6f9 MT	52	protocol.
3b655131 MT	53	.RE
	54	.PP
	55
	56	.SH ROUTE TYPES
	57
	58	\fBunicast\fR
	59	.RS 4
	60	A unicast route is the most common route in routing tables. It is a route to a destination
	61	network address, which describes the path to the destination.
	62	Use the \fB--gateway=...\fR option to create such a route.
	63	.RE
	64	.PP
	65
	66	\fBunreachable\fR
	67	.RS 4
	68	When a route is determined and the routing decision process returns a destination with
	69	an unreachable route type, an ICMP unreachable message is generated and returned to
	70	the source address.
	71	.RE
	72	.PP
	73
	74	\fBprohibit\fR
	75	.RS 4
	76	This works like an \fBunreachable\fR route, but the returned ICMP message is an
	77	ICMP prohibited message.
	78	.RE
	79	.PP
	80
	81	\fBblackhole\fR
	82	.RS 4
	83	Packets matching this kind of route are silently discarded. There will be no ICMP message
	84	sent to the source and no packet be forwarded.
	85	.RE
	86	.PP
	87
	88	.SH SEE ALSO
	89	network(8), ip-route(8)
	90
	91	.SH AUTHOR
	92	Michael Tremer (michael.tremer@ipfire.org)