Skip to content

Commit

Permalink
docs: Clarify v2 set-name behavior (#5639)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRealFalcon authored Aug 30, 2024
1 parent 93f30bb commit 5ff1a4a
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions doc/rtd/reference/network-config-format-v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,20 @@ Example: ::
``set-name: <(scalar)>``
------------------------

When matching on unique properties such as path or MAC, or with additional
assumptions such as "there will only ever be one wifi device", match rules
can be written so that they only match one device. Then this property can be
When matching on unique properties such as MAC, match rules
can be written so that they match only one device. Then this property can be
used to give that device a more specific/desirable/nicer name than the default
from udev’s ``ifnames``. Any additional device that satisfies the match rules
will then fail to get renamed and keep the original kernel name (and dmesg
will show an error).

While multiple properties can be used in a match, ``macaddress`` is
**required** for cloud-init to perform the rename.

.. note::
On a netplan-based system, cloud-init will perform the rename
independently and prior to netplan.

``wakeonlan: <(bool)>``
-----------------------

Expand Down

0 comments on commit 5ff1a4a

Please sign in to comment.