From: Tom Gundersen Date: Tue, 25 Feb 2014 18:30:40 +0000 (+0100) Subject: man: split out systemd.net{work,dev}(5) from systemd-networkd(8) X-Git-Tag: v211~208 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=eac684ef1c29684b1bcd27a89c38c202e568e469 man: split out systemd.net{work,dev}(5) from systemd-networkd(8) --- diff --git a/Makefile-man.am b/Makefile-man.am index cb6ed94ed..40810e3f0 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -101,6 +101,8 @@ MANPAGES += \ man/systemd.timer.5 \ man/systemd.unit.5 \ man/systemd.link.5 \ + man/systemd.netdev.5 \ + man/systemd.network.5 \ man/telinit.8 \ man/tmpfiles.d.5 \ man/udev.7 \ @@ -1469,6 +1471,8 @@ EXTRA_DIST += \ man/systemd.timer.xml \ man/systemd.unit.xml \ man/systemd.link.xml \ + man/systemd.netdev.xml \ + man/systemd.network.xml \ man/systemd.xml \ man/telinit.xml \ man/timedatectl.xml \ diff --git a/man/systemd.link.xml b/man/systemd.link.xml index c1176ba17..debe65ee5 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -348,23 +348,25 @@ Example - /etc/systemd/network/wireless.link + /etc/systemd/network/bridge.netdev - [Match] -MACAddress=12:34:56:78:9a:bc -Driver=brcmsmac -Path=pci-0000:02:00.0-* -Type=wlan -Virtualization=no -Host=my-laptop -Architecture=x86-64 + [NetDev] +Name=bridge0 +Kind=bridge + + + + + Example + + /etc/systemd/network/vlan1.netdev + + [NetDev] +Name=vlan1 +Kind=vlan -[Link] -Name=wireless0 -MTUBytes=1450 -BitsPerSecond=10M -WakeOnLan=magic -MACAddress=cb:a9:87:65:43:21 +[VLAN] +Id=1 diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml new file mode 100644 index 000000000..26cc6158c --- /dev/null +++ b/man/systemd.netdev.xml @@ -0,0 +1,200 @@ + + + + + + + + + systemd.network + systemd + + + + Developer + Tom + Gundersen + teg@jklm.no + + + + + + systemd.netdev + 5 + + + + systemd.netdev + Virtual Network Device configuration + + + + netdev.netdev + + + + Description + + Network setup is performed by + systemd-networkd8. + + + Virtual Network Device files must have the extension + .netdev; other extensions are ignored. Virtual + network devices are created as soon as networkd is started. + + The .netdev files are read from the files located in the + system network directory /usr/lib/systemd/network, + the volatile runtime network directory + /run/systemd/network and the local administration + network directory /etc/systemd/network. + All configuration files are collectively sorted and processed in lexical order, + regardless of the directories in which they live. However, files with + identical filenames replace each other. Files in + /etc have the highest priority, files in + /run take precedence over files with the same + name in /usr/lib. This can be used to override a + system-supplied configuration file with a local file if needed; a symlink in + /etc with the same name as a configuration file in + /usr/lib, pointing to /dev/null, + disables the configuration file entirely. + + A virtual network device is only created if the + [Match] section matches the current + environment, or if the section is empty. The following keys are accepted: + + + + Host= + + Matches against the hostname or machine ID of the + host. See ConditionHost= in + systemd.unit5 + for details. + + + + + Virtualization= + + Checks whether the system is executed in a virtualized + environment and optionally test whether it is a specific + implementation. See ConditionVirtualization= in + systemd.unit5 + for details. + + + + + KernelCommandLine= + + Checks whether a specific kernel command line option is + set (or if prefixed with the exclamation mark unset). See + ConditionKernelCommandLine= in + systemd.unit5 + for details. + + + + + Architecture= + + Checks whether the system is running on a specific + architecture. See ConditionArchitecture= in + systemd.unit5 + for details. + + + + + + The [NetDev] section accepts the following + keys: + + + + Name= + + The interface name used when creating the + netdev. This option is compulsory. + + + + Kind= + + The netdev kind. Currently, bridge, + bond and vlan + are supported. This option is compulsory. + + + + + The [VLAN] section only applies for netdevs of kind vlan, + and accepts the following key: + + + + Id= + + The VLAN ID to use. An integer in the range 0–4094. + This option is compulsory. + + + + + + + + Example + + /etc/systemd/network/bridge.netdev + + [NetDev] +Name=bridge0 +Kind=bridge + + + + /etc/systemd/network/vlan1.netdev + + [Match] +Virtualization=no + +[NetDev] +Name=vlan1 +Kind=vlan + +[VLAN] +Id=1 + + + + + + See Also + + systemd1, + systemd-networkd8 + + + + diff --git a/man/systemd.network.xml b/man/systemd.network.xml new file mode 100644 index 000000000..1ba4f4a97 --- /dev/null +++ b/man/systemd.network.xml @@ -0,0 +1,356 @@ + + + + + + + + + systemd.network + systemd + + + + Developer + Tom + Gundersen + teg@jklm.no + + + + + + systemd.network + 5 + + + + systemd.network + Network configuration + + + + network.network + + + + Description + + Network setup is performed by + systemd-networkd8. + + + Network files must have the extension .network; + other extensions are ignored. Networks are applied to links whenever the links + appear. + + The .network files are read from the files located in the + system network directory /usr/lib/systemd/network, + the volatile runtime network directory + /run/systemd/network and the local administration + network directory /etc/systemd/network. + All configuration files are collectively sorted and processed in lexical order, + regardless of the directories in which they live. However, files with + identical filenames replace each other. Files in + /etc have the highest priority, files in + /run take precedence over files with the same + name in /usr/lib. This can be used to override a + system-supplied configuration file with a local file if needed; a symlink in + /etc with the same name as a configuration file in + /usr/lib, pointing to /dev/null, + disables the configuration file entirely. + + The network file contains a [Match] section, + which determines if a given network file may be applied to a given device; + and a [Network] section specifying how the device should + be configured. The first (in lexical order) of the network files that + matches a given device is applied. + + A network file is said to match a device if each of the entries in the + [Match] section matches, or if the section is empty. + The following keys are accepted: + + + + MACAddress= + + The hardware address. + + + + Path= + + The persistent path, as exposed by the udev + property ID_PATH. May contain shell + style globs. + + + + Driver= + + The driver currently bound to the device, as + exposed by the udev property DRIVER + of its parent device, or if that is not set the driver + as exposed by ethtool -i of the + device itself. + + + + Type= + + The device type, as exposed by the udev property + DEVTYPE. + + + + Name= + + The device name, as exposed by the udev property + INTERFACE. May contain shell style + globs. + + + + Host= + + Matches against the hostname or machine ID of the + host. See ConditionHost= in + systemd.unit5 + for details. + + + + + Virtualization= + + Checks whether the system is executed in a virtualized + environment and optionally test whether it is a specific + implementation. See ConditionVirtualization= in + systemd.unit5 + for details. + + + + + KernelCommandLine= + + Checks whether a specific kernel command line option is + set (or if prefixed with the exclamation mark unset). See + ConditionKernelCommandLine= in + systemd.unit5 + for details. + + + + + Architecture= + + Checks whether the system is running on a specific + architecture. See ConditionArchitecture= in + systemd.unit5 + for details. + + + + + + The [Network] section accepts the following keys: + + + + Description= + + A description of the device. This is only used for + presentation purposes. + + + + DHCP= + + A boolean. When true, enables basic DHCPv4 support. + + + + Address= + + A static IPv4 or IPv6 address and its prefix length, + separated by a / character. Specify this + key more than once to configure several addresses. + The format of the address must be as described in + inet_pton3 + . This is a short-hand for an [Address] section only containing an Address key (see below). + + + + + Gateway= + + The gateway address, which must be in the format described in + inet_pton3 + . This is a short-hand for a [Route] section only containing a Gateway key. + + + + DNS= + + A DNS server address, which must be in the format described in + inet_pton3 + . + + + + Bridge= + + The name of the bridge to add the link to. + + + + Bond= + + The name of the bond to add the link to. + + + + VLAN= + + The name of a VLAN to create on the link. This option + may be specified more than once. + + + + + An [Address] section accepts the following keys. + Specify several [Address] sections to configure several + addresses. + + + + Address= + + As in the [Network] section. This key is mandatory. + + + + Broadcast= + + The broadcast address, which must be in the format described in + inet_pton3 + . This key only applies to IPv4 addresses. If it is not given, it is + derived from the Address key. + + + + Label= + + An address label. + + + + + The [Route] section accepts the following keys. Specify + several [Route] sections to configure several routes. + + + + Gateway= + + As in the [Network] section. This key is mandatory. + + + + Destination= + + The destination prefix of the route. Possibly followed by a slash and the + prefixlength, if ommitted a full-length host route is assumed. + + + + + The [DHCPv4] section accepts the following keys: + + + + UseDNS= + + When true (the default), the DNS servers received from the DHCP server will + be used and take precedence over any statically configured ones. + + + + UseMTU= + + When true, the interface maximum transmission unit from the DHCP server will + be used on the current link. Defaults to false. + + + + UseHostname= + + When true (the default), the hostname received from the DHCP server + will be used as the transient hostname. + + + + CriticalConnection= + + When true, the connection will never be torn down even if the DHCP lease + expires. This is contrary to the DHCP specification, but may be the best choice + if, say, the root filesystem relies on this connection. Defaults to false. + + + + + + + + Example + + /etc/systemd/network/50-static.network + + [Match] +Name=enp2s0 + +[Network] +Address=192.168.0.15/24 +Gateway=192.168.0.1 + + + + /etc/systemd/network/80-dhcp.network + + [Match] +Name=en* + +[Network] +DHCP=yes + + + + + + See Also + + systemd1, + systemd-networkd8 + + + +