c6c3feae2618d4edd0db43e6573ec3ec4c5c782b
[people/ms/network.git] / man / network-route-static.txt
1 = network-route-static(8)
2 Michael Tremer <michael.tremer@ipfire.org>
3
4 == NAME
5 network-route-static - Manage Static Routing
6
7 == SYNOPSIS
8 [verse]
9 'network route static' COMMAND ...
10 'network route static add' NETWORK [--gateway=GATEWAY,--unreachable,--prohibit,--blackhole] [--mtu=MTU]
11 'network route static remove' NETWORK
12 'network route static list' [--protocol=ipv6|ipv4]
13
14 == DESCRIPTION
15 This command helps to manage routes.
16
17 == COMMANDS
18 The following commands are understood:
19
20 'add' NETWORK ...::
21         A new route may be added by the 'add' command. It is required to pass a
22         valid network prefix NETWORK, which can be either IPv6 or IPv4.
23         +
24         For unicast routes, the '--gateway=GATEWAY' option must be passed, where
25         GATEWAY is a valid IP address of the same protocol type as the network
26         prefix is.
27         +
28         Use '--unreachable', '--prohibit', '--blackhole' can be used to create of
29         that type. See ROUTE TYPES below for more information about these options.
30         +
31         The optional '--mtu=MTU' parameter defines the MTU along the path to the
32         destination and must be an integer number. This will show you very
33         detailed information about the given device.
34
35 'remove' NETWORK::
36         A route can be removed with this command.
37         +
38         NETWORK is the network prefix of an existing route.
39
40 'list'::
41         Shows a list of all configured routes.
42         +
43         Output can be filtered by passing --protocol=[ipv6|ipv4].
44
45 == ROUTE TYPES
46
47 [horizontal]
48 'unicast'::
49         A unicast route is the most common route in routing tables. It is a route to
50         a destination network address, which describes the path to the destination.
51         Use the '--gateway=GATEWAY' option to create such a route.
52
53 'unreachable'::
54         When a route is determined and the routing decision process returns a
55         destination with an unreachable route type, an ICMP unreachable message is
56         generated and returned to the source address.
57
58 'prohibit'::
59         This works like an _unreachable_ route, but the returned ICMP message is an
60         ICMP prohibited message.
61
62 'blackhole'::
63         Packets matching this kind of route are silently discarded.
64         There will be no ICMP message sent to the source and no packet be forwarded.
65
66 == SEE ALSO
67 link:network[8],
68 link:network-route[8],
69 link:ip-route[8]