X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd-networkd.service.xml;h=2517efc4a79c6ffe19faeb2b5897f8bef096bf7c;hb=d8148cc59d0faa44d26fe27f91eb177334b4e08b;hp=3403a7a1a709f5ce50709006b34632c301ebfaf7;hpb=54abf461d6b10dc270c4bb2aeac65f240ff1c5cd;p=elogind.git
diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml
index 3403a7a1a..2517efc4a 100644
--- a/man/systemd-networkd.service.xml
+++ b/man/systemd-networkd.service.xml
@@ -61,11 +61,16 @@
network devices as they appear, as well as creating virtual
network devices.
+ To configure low-level link settings independently of
+ networks, see
+ udev7
+ .
+
Network configurations applied before networkd is started
- are not removed, and configuration applied by networkd are not
- removed when networkd exits. This ensures restarting networkd
- does not cut the network connection, and, in particular, that
- it is safe to transition between the initrd and the real root,
+ are not removed, and static configuration applied by networkd
+ is not removed when networkd exits. This ensures restarting
+ networkd does not cut the network connection, and, in particular,
+ that it is safe to transition between the initrd and the real root,
and back.
@@ -87,38 +92,89 @@
disables the configuration file entirely.
Virtual Network Devices
- Netdev files must have the extension .netdev;
- other extensions are ignored. Virtual network devices are created as soon
- as networkd is started.
+ Virtual Network Device files must have the extension
+ .netdev; other extensions are ignored. Virtual
+ network devices are created as soon as networkd is started.
+
+ 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
+ The [NetDev] section accepts the following
keys:
- Name
+ Name=
The interface name used when creating the
- bridge. This option is compulsory.
+ netdev. This option is compulsory.
- Kind
+ Kind=
- The netdev kind. Currently, 'bridge', 'bond' and 'vlan'
+ 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 keys:
+ The [VLAN] section only applies for netdevs of kind vlan,
+ and accepts the following key:
- Id
+ Id=
- The VLAN ID to use. This option is compulsory.
+ The VLAN ID to use. An integer in the range 0â4094.
+ This option is compulsory.
@@ -142,38 +198,84 @@
- MACAddress
+ MACAddress=
The hardware address.
- Path
+ Path=
The persistent path, as exposed by the udev
- property ID_PATH.
+ property ID_PATH. May contain shell
+ style globs.
- Driver
+ Driver=
The driver currently bound to the device, as
- exposed by the udev property DRIVER.
-
+ 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
+ Type=
The device type, as exposed by the udev property
DEVTYPE.
- Name
+ Name=
The device name, as exposed by the udev property
- INTERFACE.
+ 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.
+
@@ -182,30 +284,30 @@
- Description
+ Description=
A description of the device. This is only used for
presentation purposes.
- DHCP
+ DHCP=
- A boolean. When true enables basic DHCPv4 support.
+ A boolean. When true, enables basic DHCPv4 support.
- Address
+ Address=
A static IPv4 or IPv6 address and its prefix length,
- separated by a '/' character. The format of the address must
+ separated by a / character. 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
+ Gateway=
The gateway address, which must be in the format described in
inet_pton3
@@ -213,7 +315,7 @@
- DNS
+ DNS=
A DNS server address, which must be in the format described in
inet_pton3
@@ -221,15 +323,22 @@
- Bridge
+ Bridge=
- The name of the bridge to add the configured link to.
+ The name of the bridge to add the link to.
- Bond
+ Bond=
- The name of the bond to add the configured link to.
+ 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.
@@ -238,13 +347,22 @@
- Address
+ Address=
As in the [Network] section. This key is mandatory.
- Label
+ 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.
@@ -255,13 +373,13 @@
- Gateway
+ Gateway=
As in the [Network] section. This key is mandatory.
- Destination
+ Destination=
The destination prefix of the route. Possibly followed by a slash and the
prefixlength, if ommitted a full-length host route is assumed.
@@ -273,26 +391,34 @@
- UseDNS
+ UseDNS=
- When true (the default) the DNS servers received from the DHCP server will
- be used, and take precedence over any statically configured ones.
+ When true (the default), the DNS servers received from the DHCP server will
+ be used and take precedence over any statically configured ones.
- UseMTU
+ UseMTU=
- When true the interface maximum transmission unit from the DHCP server will
+ When true, the interface maximum transmission unit from the DHCP server will
be used on the current link. Defaults to false.
- UseHostname
+ UseHostname=
- When true (the default) the hostname received from the DHCP server
+ 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.
+
+
@@ -302,7 +428,7 @@
See Also
systemd1,
- udev7,
+ udev7