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