-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: networking: Convert alias.txt to rst
The kernel documentation is now restructured text. Convert the IP aliasing documentation and include it in the toplevel kernel documentation. - Fix heading adornments. - Correctly indent code snippets. - Limit line length to 72 characters inline with kernel documentation standards. - Add license identifier. Signed-off-by: Tobin C. Harding <me@tobin.cc> Signed-off-by: David S. Miller <davem@davemloft.net>
- Loading branch information
Showing
4 changed files
with
50 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
.. SPDX-License-Identifier: GPL-2.0 | ||
=========== | ||
IP-Aliasing | ||
=========== | ||
|
||
IP-aliases are an obsolete way to manage multiple IP-addresses/masks | ||
per interface. Newer tools such as iproute2 support multiple | ||
address/prefixes per interface, but aliases are still supported | ||
for backwards compatibility. | ||
|
||
An alias is formed by adding a colon and a string when running ifconfig. | ||
This string is usually numeric, but this is not a must. | ||
|
||
|
||
Alias creation | ||
============== | ||
|
||
Alias creation is done by 'magic' interface naming: eg. to create a | ||
200.1.1.1 alias for eth0 ... | ||
:: | ||
|
||
# ifconfig eth0:0 200.1.1.1 etc,etc.... | ||
~~ -> request alias #0 creation (if not yet exists) for eth0 | ||
|
||
The corresponding route is also set up by this command. Please note: | ||
The route always points to the base interface. | ||
|
||
|
||
Alias deletion | ||
============== | ||
|
||
The alias is removed by shutting the alias down:: | ||
|
||
# ifconfig eth0:0 down | ||
~~~~~~~~~~ -> will delete alias | ||
|
||
|
||
Alias (re-)configuring | ||
====================== | ||
|
||
Aliases are not real devices, but programs should be able to configure | ||
and refer to them as usual (ifconfig, route, etc). | ||
|
||
|
||
Relationship with main device | ||
============================= | ||
|
||
If the base device is shut down the added aliases will be deleted too. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,6 +17,7 @@ Contents: | |
msg_zerocopy | ||
failover | ||
net_failover | ||
alias | ||
|
||
.. only:: subproject | ||
|
||
|