summaryrefslogtreecommitdiffstats
path: root/docs/ethernet
blob: 09877c8ae678bdf4d4e27fa42b8a18d1390c303e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
% Ethernet connections
% Arch Linux
%

# Ethernet options reference

## Description
This connection method uses the iproute suite of tools and dhcpcd to gain an IP address.

## Options
INTERFACE (required)
:    The wireless interface to configure
IP (required for IPv4)
:   Can be either 'static' or 'dhcp'.  Static requires at least one of ADDR or IPCFG. 
ADDR (requires IP of 'static')
:   A single IP address to configure a static IP. For example:
GATEWAY (requires IP of 'static')
:   Set specified gateway
NETMASK (requires IP of 'static')
:   Set specified netmask. Defaults to 24
ROUTES
:   An array of custom routes (<address range> via <gateway>)
IPCFG
:   Array of arguments to pass to 'ip'. The power of this options is that it allows both simple and complicated routing configurations, within the framework of netcfg.
IFOPTS (deprecated, requires IP of 'static')
:   Arguments to pass to 'ifconfig'. This allows you to use the syntax for the older 'ifconfig' tool. Retained for compatability.
## IPv6 options
IP6 (required for IPv6)
:   Either 'dhcp', 'dhcp-noaddr', 'stateless', 'static'.
ADDR6 (required for IP6=static)
:   An array of IPv6 addresses: prefix length may be specified via '1234:bcd::11/64' syntax.
GATEWAY6 (for IP6=static)
:   The gateway address for IPv6 routing.
ROUTES6
:   An array of custom routes (<address range> via <gateway>)
### DNS
DNS
:   Array of DNS nameservers. Simply specify the IP's of each of the DNS nameservers. 
SEARCH
:   "search" line for /etc/resolv.conf
DOMAIN
:   "domain" line for /etc/resolv.conf
HOSTNAME
:   Set the system hostname. Ensure any hostname is correctly referenced in /etc/hosts.
DNS1, DNS2 (deprecated)
:   First and second DNS servers for /etc/resolv.conf
### DHCP
DHCP_OPTIONS (ipv4)
:   String. Any extra arguments to pass to the dhcp client, presently dhcpcd.
DHCP_TIMEOUT
:   Integer. Maximum time to try for a DHCP IP. Default is 10 seconds.
DHCLIENT
:   yes/no. Use dhclient instead of dhcpcd. Defaults to no
DHCLIENT_OPTIONS (ipv4)
:   String. Extra options to pass to dhclient for IPv4.
DHCLIENT6_OPTIONS (ipv6)
:   String. Extra options to pass to dhclient for IPv6.
### 802.11x Authentication
AUTH8021X 
:   Use 802.11x authentication. Enable with 'yes'. 
WPA_CONF (required for an AUTH8021X of 'yes' only)
:   Path to wpa_supplicant configuration. Defaults to '/etc/wpa_supplicant.conf'
WPA_OPTS (optional for an AUTH8021X of 'yes')
:   Extra arguments for wpa_supplicant not specified otherwise. Any option here must specify wpa_supplicant driver. Defaults to '-Dwired'. 

## Examples
### Using ADDR and GATEWAY to set static IP and gateway

    IP="static"
    ADDR="192.168.1.23"
    GATEWAY="192.168.1.1"
 
### Using IPCFG to set a static IP and gateway with custom DNS

    IP="static"
    IPCFG=("addr add dev eth0 192.168.1.23/24 brd +" "route add default via 192.168.1.1")
    DNS=("208.67.222.222" "208.67.220.220")