Difference between revisions of "Netcfg"
m (.service not needed) |
m (→Configuration: use a proper wiki link) |
||
| (12 intermediate revisions by 12 users not shown) | |||
| Line 4: | Line 4: | ||
[[fr:Netcfg]] | [[fr:Netcfg]] | ||
[[it:Netcfg]] | [[it:Netcfg]] | ||
| + | [[ja:Netcfg]] | ||
[[ro:Netcfg]] | [[ro:Netcfg]] | ||
[[ru:Netcfg]] | [[ru:Netcfg]] | ||
| Line 18: | Line 19: | ||
{{Article summary end}} | {{Article summary end}} | ||
| − | Netcfg is used to configure and manage network connections via profiles. It has pluggable support for a range of connection types, such as wireless, Ethernet | + | Netcfg is used to configure and manage network connections via profiles. It has pluggable support for a range of connection types, such as wireless, Ethernet and [[Wikipedia:Point-to-point_protocol|PPP]]. It is also capable of starting/stopping many-to-one connections, that is, multiple connections within the same profile, optionally with bonding. Further it is useful for users seeking a simple and robust means of managing multiple network configurations (e.g. laptop users). With the push to drop support for {{Pkg|initscripts}}/SysV, netcfg is one of several choices users have to managing their network connectivity under [[systemd]]. |
| − | + | ||
| − | + | ||
== Preparation == | == Preparation == | ||
| Line 35: | Line 34: | ||
== Configuration == | == Configuration == | ||
| + | {{Note|1={{Pkg|netcfg}} >= 2.8.9 drops deprecated {{ic|/etc/[[rc.conf]]}} compatibility. Netcfg users should configure all interfaces in {{ic|/etc/conf.d/netcfg}} instead of {{ic|/etc/rc.conf}}.}} | ||
Network profiles are stored in {{ic|/etc/network.d/}}. To minimize the potential for errors, copy an example configuration from {{ic|/etc/network.d/examples/}} to {{ic|/etc/network.d/mynetwork}}. The file name is the name of the network profile, and {{ic|mynetwork}} is used as an example throughout this article. | Network profiles are stored in {{ic|/etc/network.d/}}. To minimize the potential for errors, copy an example configuration from {{ic|/etc/network.d/examples/}} to {{ic|/etc/network.d/mynetwork}}. The file name is the name of the network profile, and {{ic|mynetwork}} is used as an example throughout this article. | ||
| Line 67: | Line 67: | ||
* Ensure the {{ic|ESSID}} and {{ic|KEY}} (passphrase) are set correctly for wireless connections. Typos in these fields are common errors. | * Ensure the {{ic|ESSID}} and {{ic|KEY}} (passphrase) are set correctly for wireless connections. Typos in these fields are common errors. | ||
** Note that WEP ''string'' keys (not ''hex'' keys) must be specified with a leading {{ic|s:}} (e.g. {{ic|1=KEY="s:''somepasskey''"}}). | ** Note that WEP ''string'' keys (not ''hex'' keys) must be specified with a leading {{ic|s:}} (e.g. {{ic|1=KEY="s:''somepasskey''"}}). | ||
| + | |||
| + | {{Note|If you are using netcfg inside a VPS, please see [[Virtual_Private_Server#Moving_your_VPS_from_network_configuration_in_rc.conf_to_netcfg_.28tested_with_OpenVZ.29|the appropriate page]].}} | ||
{{Note|Netcfg configurations are valid Bash scripts. Any configuration involving special characters such as {{ic|$}} or {{ic|\}} needs to be quoted correctly otherwise it will be interpreted by Bash. To avoid interpretation, use single quotes or backslash escape characters where appropriate.}} | {{Note|Netcfg configurations are valid Bash scripts. Any configuration involving special characters such as {{ic|$}} or {{ic|\}} needs to be quoted correctly otherwise it will be interpreted by Bash. To avoid interpretation, use single quotes or backslash escape characters where appropriate.}} | ||
| Line 73: | Line 75: | ||
{{Note|For WPA-Personal, it is also possible to [[Wpa_supplicant#Classic_method:_.2Fetc.2Fwpa_supplicant.conf|encode the WPA passkey into a hexadecimal string]]. Save the new hexadecimal string into the wireless WPA profile in {{ic|/etc/network.d/mynetwork}} as the value of the {{ic|KEY}} variable (make sure this will be the only {{ic|KEY}} variable enabled), to look similar to this: {{ic|1=KEY='7b271c9a7c8a6ac07d12403a1f0792d7d92b5957ff8dfd56481ced43ec6a6515'}}. That should disable the need to reveal the passkey.}} | {{Note|For WPA-Personal, it is also possible to [[Wpa_supplicant#Classic_method:_.2Fetc.2Fwpa_supplicant.conf|encode the WPA passkey into a hexadecimal string]]. Save the new hexadecimal string into the wireless WPA profile in {{ic|/etc/network.d/mynetwork}} as the value of the {{ic|KEY}} variable (make sure this will be the only {{ic|KEY}} variable enabled), to look similar to this: {{ic|1=KEY='7b271c9a7c8a6ac07d12403a1f0792d7d92b5957ff8dfd56481ced43ec6a6515'}}. That should disable the need to reveal the passkey.}} | ||
| + | |||
| + | {{ | ||
| + | Note|1=By default netcfg uses dhcpcd for configuring network interfaces. An alternate to dhcpcd is dhclient. To use dhclient, set DHCLIENT='yes' in appropriate profile configuration. | ||
| + | }} | ||
== Manual Operation == | == Manual Operation == | ||
| Line 94: | Line 100: | ||
=== Just one profile === | === Just one profile === | ||
| − | + | In the simplest case, only one profile will be used and is always desired to start on boot: | |
# systemctl enable netcfg@myprofile | # systemctl enable netcfg@myprofile | ||
| Line 100: | Line 106: | ||
=== Net-Profiles === | === Net-Profiles === | ||
| − | Edit the {{ic|NETWORKS}} array in {{ic|/etc/conf.d/netcfg}} to refer to | + | Edit the {{ic|NETWORKS}} array in {{ic|/etc/conf.d/netcfg}} to refer to the network config file {{ic|/etc/network.d/mynetwork}}. |
{{hc|/etc/conf.d/netcfg|2= | {{hc|/etc/conf.d/netcfg|2= | ||
| Line 114: | Line 120: | ||
NETWORKS=(last)}} | NETWORKS=(last)}} | ||
| − | Finally, {{ic|net-profiles}} can be configured to display a menu & | + | {{Note|For {{ic|NETWORKS=(last)}} to work, you will have to connect to your network manually first and then stop the daemon for Netcfg to remember the network. You can stop the Netcfg daemon by running {{ic|netcfg-daemon stop}} as root.}} |
| + | |||
| + | Finally, {{ic|net-profiles}} can be configured to display a menu—allowing users to choose a desired profile—by setting the contents of the {{ic|NETWORKS}} array to {{ic|menu}}: | ||
{{hc|/etc/conf.d/netcfg|2= | {{hc|/etc/conf.d/netcfg|2= | ||
| Line 120: | Line 128: | ||
Additionally, the {{Pkg|dialog}} package is required. | Additionally, the {{Pkg|dialog}} package is required. | ||
| + | |||
| + | {{Note|The {{ic|1=NETWORKS=(menu)}} setting cannot be used anymore when switching to systemd. See {{bug|31377}} for details.}} | ||
{{Tip|Access the menu at any time by running {{ic|netcfg-menu}} in a terminal.}} | {{Tip|Access the menu at any time by running {{ic|netcfg-menu}} in a terminal.}} | ||
| Line 125: | Line 135: | ||
=== Net-Auto-Wireless === | === Net-Auto-Wireless === | ||
| − | This allows users to automatically connect to wireless networks with proper roaming support. To use this feature, the {{Pkg|wpa_actiond}} package is required. Note that {{ic|wireless-wpa-config}} profiles do not work with {{ic|net-auto-wireless}}. Convert them to {{ic|wireless-wpa-configsection}} instead. | + | This allows users to automatically connect to wireless networks with proper roaming support. To use this feature, the {{Pkg|wpa_actiond}} package is required. Note that {{ic|wireless-wpa-config}} profiles do not work with {{ic|net-auto-wireless}}. Convert them to {{ic|wireless-wpa-configsection}} or {{ic|wireless-wpa}} instead. |
Specify the desired wireless interface with the {{ic|WIRELESS_INTERFACE}} variable in {{ic|/etc/conf.d/netcfg}} or define a list of wireless networks that should be automatically connected with the {{ic|AUTO_PROFILES}} variable in {{ic|/etc/conf.d/netcfg}}. | Specify the desired wireless interface with the {{ic|WIRELESS_INTERFACE}} variable in {{ic|/etc/conf.d/netcfg}} or define a list of wireless networks that should be automatically connected with the {{ic|AUTO_PROFILES}} variable in {{ic|/etc/conf.d/netcfg}}. | ||
Revision as of 23:13, 5 December 2012
Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary link Template:Article summary end
Netcfg is used to configure and manage network connections via profiles. It has pluggable support for a range of connection types, such as wireless, Ethernet and PPP. It is also capable of starting/stopping many-to-one connections, that is, multiple connections within the same profile, optionally with bonding. Further it is useful for users seeking a simple and robust means of managing multiple network configurations (e.g. laptop users). With the push to drop support for initscripts/SysV, netcfg is one of several choices users have to managing their network connectivity under systemd.
Contents
Preparation
In the simplest cases, users must at least know the name of their network interface(s) (e.g. eth0, wlan0). If configuring a static IP address, the IP addresses of the default gateway and name server(s) must also be known.
If connecting to a wireless network, have some basic information ready. For a wireless network this includes what type of security is used, the network name (ESSID), and any passphrase or encryption keys. Additionally, ensure the proper drivers and firmware are installed for the wireless device, as described in Wireless Setup.
Installation
The netcfg package is available in the official repositories. As of netcfg version 2.5.x, optional dependencies include wpa_actiond, which is required for automatic/roaming wireless connections, and ifplugd, which is required for automatic Ethernet configuration. See the announcement.
Users wanting Bash completion support for netcfg, install the bash-completion package from the official repositories.
Configuration
Network profiles are stored in /etc/network.d/. To minimize the potential for errors, copy an example configuration from /etc/network.d/examples/ to /etc/network.d/mynetwork. The file name is the name of the network profile, and mynetwork is used as an example throughout this article.
Depending on the connection type and security, use one of the following examples from /etc/network.d/examples/ as a base.
| Connection | Type | Example Profile | Information |
|---|---|---|---|
| Wired | Dynamic IP | ethernet-dhcp |
|
| Static IP | ethernet-static |
||
| Routed | ethernet-iproute |
Can be checked with route from the net-tools package.
| |
| Wireless | WPA-Personal | wireless-wpa |
Uses a passphrase/pre-shared key. |
| WPA-Enterprise | wireless-wpa-config |
The wpa_supplicant configuration is external. | |
wireless-wpa-configsection |
The wpa_supplicant configuration is stored as a string. |
Modify the new configuration file, /etc/network.d/mynetwork:
- Set
INTERFACEto the correct wireless or Ethernet interface. This can be checked withip linkandiwconfig. - Ensure the
ESSIDandKEY(passphrase) are set correctly for wireless connections. Typos in these fields are common errors.- Note that WEP string keys (not hex keys) must be specified with a leading
s:(e.g.KEY="s:somepasskey").
- Note that WEP string keys (not hex keys) must be specified with a leading
Manual Operation
To connect a profile:
# netcfg mynetwork
To disconnect a profile:
# netcfg down mynetwork
If successful, users can configure netcfg to connect automatically or during boot. If the connection fails, see Netcfg Troubleshooting for solutions and for how to ask for help.
Additionally, see:
$ netcfg help
Automatic Operation
Just one profile
In the simplest case, only one profile will be used and is always desired to start on boot:
# systemctl enable netcfg@myprofile
Net-Profiles
Edit the NETWORKS array in /etc/conf.d/netcfg to refer to the network config file /etc/network.d/mynetwork.
/etc/conf.d/netcfg
NETWORKS=(mynetwork yournetwork)
Start the service on startup:
# systemctl enable netcfg
Alternatively, the profiles that were active at last shutdown can be restored by setting the NETWORKS array to last.
/etc/conf.d/netcfg
NETWORKS=(last)
Finally, net-profiles can be configured to display a menu—allowing users to choose a desired profile—by setting the contents of the NETWORKS array to menu:
/etc/conf.d/netcfg
NETWORKS=(menu)
Additionally, the dialog package is required.
Net-Auto-Wireless
This allows users to automatically connect to wireless networks with proper roaming support. To use this feature, the wpa_actiond package is required. Note that wireless-wpa-config profiles do not work with net-auto-wireless. Convert them to wireless-wpa-configsection or wireless-wpa instead.
Specify the desired wireless interface with the WIRELESS_INTERFACE variable in /etc/conf.d/netcfg or define a list of wireless networks that should be automatically connected with the AUTO_PROFILES variable in /etc/conf.d/netcfg.
Enable net-auto-wireless.service so systemd manages it.
# systemctl enable net-auto-wireless
Net-Auto-Wired
This allows users to automatically connect to wired networks. To use this feature, the ifplugd package is required.
Specify the desired wired interface with the WIRED_INTERFACE variable in /etc/conf.d/netcfg.
Enable net-auto-wired.service so systemd manages it.
# systemctl enable net-auto-wired
The daemon starts an ifplugd process which runs /etc/ifplugd/netcfg.action when the status of the wired interface changes (e.g. a cable is plugged in or unplugged). On plugging in a cable, attempts are made to start any profiles with CONNECTION = "ethernet" or "ethernet-iproute" and INTERFACE = WIRED_INTERFACE until one of them succeeds.