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]\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]\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 .RE
  34 .PP
  35
  36 \fBremove <network>\fR
  37 .RS 4
  38 A route can be removed with this command.
  39 .PP
  40 \fB<network>\fR is the network prefix of a existing route.
  41 .RE
  42 .PP
  43
  44 \fBlist [--ipv6|--ipv4]\fR
  45 .RS 4
  46 Shows a list of all configured routes.
  47 .PP
  48 Pass the protocol as shown above to filter.
  49 .RE
  50 .PP
  51
  52 .SH ROUTE TYPES
  53
  54 \fBunicast\fR
  55 .RS 4
  56 A unicast route is the most common route in routing tables. It is a route to a destination
  57 network address, which describes the path to the destination.
  58 Use the \fB--gateway=...\fR option to create such a route.
  59 .RE
  60 .PP
  61
  62 \fBunreachable\fR
  63 .RS 4
  64 When a route is determined and the routing decision process returns a destination with
  65 an unreachable route type, an ICMP unreachable message is generated and returned to
  66 the source address.
  67 .RE
  68 .PP
  69
  70 \fBprohibit\fR
  71 .RS 4
  72 This works like an \fBunreachable\fR route, but the returned ICMP message is an
  73 ICMP prohibited message.
  74 .RE
  75 .PP
  76
  77 \fBblackhole\fR
  78 .RS 4
  79 Packets matching this kind of route are silently discarded. There will be no ICMP message
  80 sent to the source and no packet be forwarded.
  81 .RE
  82 .PP
  83
  84 .SH SEE ALSO
  85 network(8), ip-route(8)
  86
  87 .SH AUTHOR
  88 Michael Tremer (michael.tremer@ipfire.org)