[deployment-guide] Removed deprecated comments.
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 18 16:31:50 UTC 2011
commit 0dac58417b4ff40d626da4ffd91b1170abd16459
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Tue Oct 18 18:31:02 2011 +0200
Removed deprecated comments.
en-US/Network_Interfaces.xml | 165 +++---------------------------------------
1 files changed, 9 insertions(+), 156 deletions(-)
---
diff --git a/en-US/Network_Interfaces.xml b/en-US/Network_Interfaces.xml
index b1d015e..1eb5859 100644
--- a/en-US/Network_Interfaces.xml
+++ b/en-US/Network_Interfaces.xml
@@ -18,10 +18,6 @@
</indexterm>
<para>Under &MAJOROS;, all network communications occur between configured software <firstterm>interfaces</firstterm> and <firstterm>physical networking devices</firstterm> connected to the system.</para>
<para>The configuration files for network interfaces are located in the <filename>/etc/sysconfig/network-scripts/</filename> directory. The scripts used to activate and deactivate these network interfaces are also located here. Although the number and type of interface files can differ from system to system, there are three categories of files that exist in this directory:</para>
- <!-- RHEL5: ddomingo at redhat.com: above replaced below, for clarity
- <para>The configuration files for network interfaces, and the scripts used to activate and deactivate them, are located in the <filename>/etc/sysconfig/network-scripts/</filename> directory. Although the number and type of interface files can
- differ from system to system, there are three categories of files that exist in this directory:</para>
- --><!-- RHEL5: ddomingo at redhat.com: replaced <itemizedlist> with <orderedlist> -->
<orderedlist>
<listitem>
<para>
@@ -87,27 +83,6 @@
</listitem>
</varlistentry>
</variablelist>
- <!-- RHEL5: ddomingo at redhat.com: changed list below to <variablelist> above
- <orderedlist>
- <listitem>
- <para><filename>/etc/hosts</filename> — The main purpose of this file is to resolve hostnames that cannot be resolved any other way. It can also be used to resolve hostnames on small networks with no DNS server. Regardless of the type
- of network the computer is on, this file should contain a line specifying the IP address of the loopback device (<command>127.0.0.1</command>) as <command>localhost.localdomain</command>. For more information, refer to
- the <filename>hosts</filename> man page.</para>
- </listitem>
- <listitem>
- <para><filename>/etc/resolv.conf</filename> — This file specifies the IP addresses of DNS servers and the search domain. Unless configured to do otherwise, the network initialization scripts populate this file. For more information
- about this file, refer to the <filename>resolv.conf</filename> man page.</para>
- </listitem>
- <listitem>
- <para><filename>/etc/sysconfig/network</filename> — Specifies routing and host information for all network interfaces. For more information about this file and the directives it accepts, refer to
- <xref linkend="s2-sysconfig-network"/>.</para>
- </listitem>
- <listitem>
- <para><filename>/etc/sysconfig/network-scripts/ifcfg-<replaceable><interface-name></replaceable></filename> — For each network interface, there is a corresponding interface configuration script. Each of these files provide
- information specific to a particular network interface. Refer to <xref linkend="s1-networkscripts-interfaces"/> for more information on this type of file and the directives it accepts.</para>
- </listitem>
- </orderedlist>
- --><!-- RHEL5: ddomingo at redhat.com: changed title from "Caution"; minor edits -->
<important>
<title>Network interface names</title>
<para>
@@ -165,7 +140,7 @@ ONBOOT=yes
NETMASK=255.255.255.0
IPADDR=10.0.1.27
USERCTL=no</programlisting>
- <para>The values required in an interface configuration file can change based on other values. For example, the <filename>ifcfg-eth0</filename> file for an interface using DHCP looks <!-- RHEL5: quite a bit -->different because IP information is provided by the DHCP server:</para>
+ <para>The values required in an interface configuration file can change based on other values. For example, the <filename>ifcfg-eth0</filename> file for an interface using DHCP looks different because IP information is provided by the DHCP server:</para>
<programlisting>DEVICE=eth0
BOOTPROTO=dhcp
ONBOOT=yes</programlisting>
@@ -177,7 +152,6 @@ ONBOOT=yes</programlisting>
</para>
<para>However, it is also possible to manually edit the configuration files for a given network interface.</para>
<para>Below is a listing of the configurable parameters in an Ethernet interface configuration file:</para>
- <!-- RHEL5: added BONDING_OPTS as per BZ#221423 -->
<variablelist>
<varlistentry>
<term>
@@ -305,7 +279,6 @@ ONBOOT=yes</programlisting>
</para>
</listitem>
</varlistentry>
- <!-- RHEL5: BZ#492539: "This directive is useful..." to "This directive must be used..." -->
<varlistentry>
<term>
<command>HWADDR=<replaceable>MAC-address</replaceable>
@@ -354,7 +327,7 @@ ONBOOT=yes</programlisting>
</term>
<listitem>
<para>where <command><replaceable>bond-interface</replaceable>
- </command> is the channel bonding interface to which <!-- RHEL5: the interface -->the Ethernet interface is linked.</para>
+ </command> is the channel bonding interface to which the Ethernet interface is linked.</para>
<para>This directive is used in conjunction with the <command>SLAVE</command> directive.</para>
<para>Refer to <xref
linkend="s2-networkscripts-interfaces-chan"/> for more information about channel bonding interfaces.</para>
@@ -506,17 +479,13 @@ ONBOOT=yes</programlisting>
<para>The contents of the file can be identical to whatever type of interface is getting bonded, such as an Ethernet interface. The only difference is that the <command>DEVICE=</command> directive must be <command>bond<replaceable>N</replaceable>
</command>, replacing <replaceable>N</replaceable> with the number for the interface.</para>
<para>The following is a sample channel bonding configuration file:</para>
- <example
- id="ex-Sample_ifcfg-bond0_interface_configuration_file">
- <title>Sample ifcfg-bond0 interface configuration file</title>
- <programlisting>DEVICE=bond0
+ <programlisting>DEVICE=bond0
IPADDR=192.168.1.1
NETMASK=255.255.255.0
ONBOOT=yes
BOOTPROTO=none
USERCTL=no
BONDING_OPTS="<replaceable>bonding parameters separated by spaces</replaceable>"</programlisting>
- </example>
<para>After the channel bonding interface is created, the network interfaces to be bound together must be configured by adding the <command>MASTER=</command> and <command>SLAVE=</command> directives to their configuration files. The configuration files for each of the channel-bonded interfaces can be nearly identical.</para>
<para>For example, if two Ethernet interfaces are being channel bonded, both <filename>eth0</filename> and <filename>eth1</filename> may look like the following example:</para>
<programlisting>DEVICE=eth<replaceable>N</replaceable>
@@ -613,8 +582,7 @@ DEMAND=no
IDLETIMEOUT=600</programlisting>
<para>
<firstterm>Serial Line Internet Protocol (SLIP)</firstterm> is another dialup interface, although it is used less frequently. SLIP files have interface configuration file names such as <filename>ifcfg-sl0</filename>.</para>
- <para>Other options<!-- RHEL5: , not already discussed, --> that may be used in these files include:</para>
- <!-- RHEL5: ddomingo at redhat.com: replacement list -->
+ <para>Other options that may be used in these files include:</para>
<variablelist>
<varlistentry>
<term>
@@ -767,85 +735,11 @@ IDLETIMEOUT=600</programlisting>
</listitem>
</varlistentry>
</variablelist>
- <!-- RHEL5: ddomingo at redhat.com: above <variablelist> replaced below <itemizedlist>
- <itemizedlist>
- <listitem>
- <para><command>DEFROUTE=<replaceable><answer></replaceable></command>, where <command><replaceable><answer></replaceable></command> is one of the following:</para>
- <itemizedlist>
- <listitem>
- <para><command>yes</command> — Set this interface as the default route.</para>
- </listitem>
- <listitem>
- <para><command>no</command> — Do not set this interface as the default route.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para><command>DEMAND=<replaceable><answer></replaceable></command>, where <command><replaceable><answer></replaceable></command> is one of the following:</para>
- <itemizedlist>
- <listitem>
- <para><command>yes</command> — This interface allows <command>pppd</command> to initiate a connection when someone attempts to use it.</para>
- </listitem>
- <listitem>
- <para><command>no</command> — A connection must be manually established for this interface.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para><command>IDLETIMEOUT=<replaceable><value></replaceable></command>, where <command><replaceable><value></replaceable></command> is the number of seconds of idle activity before the interface disconnects
- itself.</para>
- </listitem>
- <listitem>
- <para><command>INITSTRING=<replaceable><string></replaceable></command>, where <command><replaceable><string></replaceable></command> is the initialization string passed to the modem device. This option is
- primarily used in conjunction with SLIP interfaces.</para>
- </listitem>
- <listitem>
- <para><command>LINESPEED=<replaceable><value></replaceable></command>, where <command><replaceable><value></replaceable></command> is the baud rate of the device. Possible standard values include
- <command>57600</command>, <command>38400</command>, <command>19200</command>, and <command>9600</command>.</para>
- </listitem>
- <listitem>
- <para><command>MODEMPORT=<replaceable><device></replaceable></command>, where <command><replaceable><device></replaceable></command> is the name of the serial device that is used to establish the connection
- for the interface.</para>
- </listitem>
- <listitem>
- <para><command>MTU=<replaceable><value></replaceable></command>, where <command><replaceable><value></replaceable></command> is the <firstterm>Maximum Transfer Unit (MTU)</firstterm> setting for the
- interface. The MTU refers to the largest number of bytes of data a frame can carry, not counting its header information. In some dialup situations, setting this to a value of <command>576</command> results in fewer packets dropped and
- a slight improvement to the throughput for a connection.</para>
- </listitem>
- <listitem>
- <para><command>NAME=<replaceable><name></replaceable></command>, where <command><replaceable><name></replaceable></command> is the reference to the title given to a collection of dialup connection
- configurations.</para>
- </listitem>
- <listitem>
- <para><command>PAPNAME=<replaceable><name></replaceable></command>, where <command><replaceable><name></replaceable></command> is the username given during the <firstterm>Password Authentication Protocol
- (PAP)</firstterm> exchange that occurs to allow connections to a remote system.</para>
- </listitem>
- <listitem>
- <para><command>PERSIST=<replaceable><answer></replaceable></command>, where <command><replaceable><answer></replaceable></command> is one of the following:</para>
- <itemizedlist>
- <listitem>
- <para><command>yes</command> — This interface should be kept active at all times, even if deactivated after a modem hang up.</para>
- </listitem>
- <listitem>
- <para><command>no</command> — This interface should not be kept active at all times.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para><command>REMIP=<replaceable><address></replaceable></command>, where <command><replaceable><address></replaceable></command> is the remote system's IP address. This is usually left unspecified.</para>
- </listitem>
- <listitem>
- <para><command>WVDIALSECT=<replaceable><name></replaceable></command>, where <command><replaceable><name></replaceable></command> associates this interface with a dialer configuration in
- <filename>/etc/wvdial.conf</filename>. This file contains the phone number to be dialed and other important information for the interface.</para>
- </listitem>
- </itemizedlist>
- -->
</section>
<section
id="s2-networkscripts-interfaces-other">
<title>Other Interfaces</title>
<para>Other common interface configuration files include the following:</para>
- <!-- RHEL5: ddomingo at redhat.com: replacement <variablelist> -->
<variablelist>
<varlistentry>
<term>
@@ -855,7 +749,7 @@ IDLETIMEOUT=600</programlisting>
<para>A local <firstterm>loopback interface</firstterm> is often used in testing, as well as being used in a variety of applications that require an IP address pointing back to the same system. Any data sent to the loopback device is immediately returned to the host's network layer.</para>
<warning>
<title>Do not manually edit the ifcfg-lo script</title>
- <para><!-- RHEL5: Never edit the loopback interface script, <filename>/etc/sysconfig/network-scripts/ifcfg-lo</filename>, manually -->The loopback interface script, <filename>/etc/sysconfig/network-scripts/ifcfg-lo</filename>, should never be edited manually. Doing so can prevent the system from operating correctly.</para>
+ <para>The loopback interface script, <filename>/etc/sysconfig/network-scripts/ifcfg-lo</filename>, should never be edited manually. Doing so can prevent the system from operating correctly.</para>
</warning>
</listitem>
</varlistentry>
@@ -909,8 +803,7 @@ IDLETIMEOUT=600</programlisting>
<command>ifdown</command>
</primary>
</indexterm>
- <para>The interface control scripts activate and deactivate system interfaces. <!-- RHEL5: There are two primary interface control scripts, <command>/sbin/ifdown</command> and <command>/sbin/ifup</command>, that call on control scripts
- located in the <filename>/etc/sysconfig/network-scripts/</filename> directory. -->There are two primary interface control scripts that call on control scripts located in the <filename>/etc/sysconfig/network-scripts/</filename> directory: <command>/sbin/ifdown</command> and <command>/sbin/ifup</command>.</para>
+ <para>The interface control scripts activate and deactivate system interfaces. There are two primary interface control scripts that call on control scripts located in the <filename>/etc/sysconfig/network-scripts/</filename> directory: <command>/sbin/ifdown</command> and <command>/sbin/ifup</command>.</para>
<para>The <filename>ifup</filename> and <filename>ifdown</filename> interface scripts are symbolic links to scripts in the <filename>/sbin/</filename> directory. When either of these scripts are called, they require the value of the interface to be specified, such as:</para>
<screen><command>ifup eth0</command></screen>
<warning>
@@ -921,7 +814,6 @@ IDLETIMEOUT=600</programlisting>
<para>Two files used to perform a variety of network initialization tasks during the process of bringing up a network interface are <filename>/etc/rc.d/init.d/functions</filename> and <filename>/etc/sysconfig/network-scripts/network-functions</filename>. Refer to <xref
linkend="s1-networkscripts-functions"/> for more information.</para>
<para>After verifying that an interface has been specified and that the user executing the request is allowed to control the interface, the correct script brings the interface up or down. The following are common interface control scripts found within the <filename>/etc/sysconfig/network-scripts/</filename> directory:</para>
- <!-- RHEL5: ddomingo at redhat.com: replacement <variablelist> -->
<variablelist>
<varlistentry>
<term>
@@ -939,15 +831,6 @@ IDLETIMEOUT=600</programlisting>
<para>Brings ISDN interfaces up and down.</para>
</listitem>
</varlistentry>
- <!-- notting: ifup/ifdown-ipsec, ifup/ifdown-sl and ifup/ifdown-ipx have been removed.
- <varlistentry>
- <term>
- <filename>ifup-ipsec</filename> and <filename>ifdown-ipsec</filename>
- </term>
- <listitem>
- <para>Brings IPsec interfaces up and down.</para>
- </listitem>
- </varlistentry>-->
<varlistentry>
<term>
<filename>ifup-ipv6</filename> and <filename>ifdown-ipv6</filename>
@@ -956,15 +839,6 @@ IDLETIMEOUT=600</programlisting>
<para>Brings IPv6 interfaces up and down.</para>
</listitem>
</varlistentry>
-<!-- notting: ifup/ifdown-ipsec, ifup/ifdown-sl and ifup/ifdown-ipx have been removed.
-<varlistentry>
- <term>
- <filename>ifup-ipx</filename>
- </term>
- <listitem>
- <para>Brings up an IPX interface.</para>
- </listitem>
- </varlistentry>-->
<varlistentry>
<term>
<filename>ifup-plip</filename>
@@ -1013,15 +887,6 @@ IDLETIMEOUT=600</programlisting>
<para>Contains function calls related to bringing up and down an IPv6 tunnel within an IPv4 connection.</para>
</listitem>
</varlistentry>
-<!-- notting: ifup/ifdown-ipsec, ifup/ifdown-sl and ifup/ifdown-ipx have been removed.
-<varlistentry>
- <term>
- <filename>ifup-sl</filename> and <filename>ifdown-sl</filename>
- </term>
- <listitem>
- <para>Brings a SLIP interface up or down.</para>
- </listitem>
- </varlistentry>-->
<varlistentry>
<term>
<filename>ifup-wireless</filename>
@@ -1037,7 +902,7 @@ IDLETIMEOUT=600</programlisting>
</warning>
<para>The easiest way to manipulate all network scripts simultaneously is to use the <command>systemctl</command> command on the network service (<filename>/etc/rc.d/init.d/network</filename>), as illustrated the following command:</para>
<screen><command>systemctl <replaceable>action</replaceable> network.service</command></screen>
- <para><!-- RHEL5: In this example -->Here, <replaceable>action</replaceable> can be either <command>start</command>, <command>stop</command>, or <command>restart</command>.</para>
+ <para>Here, <replaceable>action</replaceable> can be either <command>start</command>, <command>stop</command>, or <command>restart</command>.</para>
<para>To view a list of configured devices and currently active network interfaces, use the following command:</para>
<screen><command>service network status</command></screen>
</section>
@@ -1119,8 +984,8 @@ GATEWAY0=10.10.10.1</programlisting>
<secondary>functions</secondary>
</indexterm>
<para>&MAJOROS; makes use of several files that contain important common functions used to bring interfaces up and down. Rather than forcing each interface control file to contain these functions, they are grouped together in a few files that are called upon when necessary.</para>
- <para>The <filename>/etc/sysconfig/network-scripts/network-functions</filename> file contains the most commonly used IPv4 functions, which are useful to many interface control scripts. These functions include contacting running programs that have requested information about changes in <!-- RHEL5: an interface's status -->the status of an interface, setting hostnames, finding a gateway device, verifying whether or not <!-- RHEL5: if -->a particular device is down, and adding a default route.</para>
- <para>As the functions required for IPv6 interfaces are different <!-- RHEL5: than -->from IPv4 interfaces, a <filename>/etc/sysconfig/network-scripts/network-functions-ipv6</filename> file exists specifically to hold this information. The functions in this file configure and delete static IPv6 routes, create and remove tunnels, add and remove IPv6 addresses to an interface, and test for the existence of an IPv6 address on an interface.</para>
+ <para>The <filename>/etc/sysconfig/network-scripts/network-functions</filename> file contains the most commonly used IPv4 functions, which are useful to many interface control scripts. These functions include contacting running programs that have requested information about changes in the status of an interface, setting hostnames, finding a gateway device, verifying whether or not a particular device is down, and adding a default route.</para>
+ <para>As the functions required for IPv6 interfaces are different from IPv4 interfaces, a <filename>/etc/sysconfig/network-scripts/network-functions-ipv6</filename> file exists specifically to hold this information. The functions in this file configure and delete static IPv6 routes, create and remove tunnels, add and remove IPv6 addresses to an interface, and test for the existence of an IPv6 address on an interface.</para>
</section>
<section
id="s1-networkscripts-resources">
@@ -1134,7 +999,6 @@ GATEWAY0=10.10.10.1</programlisting>
<section
id="s2-networkscripts-docs-inst">
<title>Installed Documentation</title>
- <!-- RHEL5: ddomingo at redhat.com: replacement <variablelist> -->
<variablelist>
<varlistentry>
<term>
@@ -1153,17 +1017,6 @@ GATEWAY0=10.10.10.1</programlisting>
</listitem>
</varlistentry>
</variablelist>
- <!-- RHEL5: ddomingo at redhat.com: above <variablelist> replaces <itemizedlist> below
- <itemizedlist>
- <listitem>
- <para><filename>/usr/share/doc/initscripts-<replaceable><version></replaceable>/sysconfig.txt</filename> — A guide to available options for network configuration files, including IPv6 options not covered in this chapter.</para>
- </listitem>
- <listitem>
- <para><filename>/usr/share/doc/iproute-<replaceable><version></replaceable>/ip-cref.ps</filename> — This file contains a wealth of information about the <command>ip</command> command, which can be used to
- manipulate routing tables, among other things. Use the <application>ggv</application> or <application>kghostview</application> application to view this file.</para>
- </listitem>
- </itemizedlist>
- -->
</section>
</section>
</chapter>
More information about the docs-commits
mailing list