man/network-route.8.in

   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
   7 \fBnetwork [OPTIONS] route add <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
   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
  21 \fBadd <network> <--gateway=..., --unreachable, --prohibit, --blackhole> [--mtu=N]\fR
  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.
  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.
  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
  47 \fBlist [--protocol=ipv6|ipv4]\fR
  48 .RS 4
  49 Shows a list of all configured routes.
  50 .PP
  51 Pass the protocol option to filter the output only for the given
  52 protocol.
  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)