all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-docs 1/1] network: update documentation for network-interface-pinning
Date: Thu, 31 Jul 2025 14:18:25 +0200	[thread overview]
Message-ID: <20250731121827.311601-1-s.hanreich@proxmox.com> (raw)

It is now possible to use arbitrary prefix names and target names for
network interfaces. Update the documentation to reflect this behavior
and add some more examples.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 pve-network.adoc | 32 +++++++++++++++++++++++++++-----
 1 file changed, 27 insertions(+), 5 deletions(-)

diff --git a/pve-network.adoc b/pve-network.adoc
index 2dec882..1c6b723 100644
--- a/pve-network.adoc
+++ b/pve-network.adoc
@@ -168,31 +168,53 @@ occurences of the old interface name in the following files:
 * `/etc/network/interfaces`
 * `/etc/pve/nodes/<nodename>/host.fw`
 * `/etc/pve/sdn/controllers.cfg`
+* `/etc/pve/sdn/fabrics.cfg`
 
 NOTE: Since the generated mapping is local to the node it is generated on,
 interface names contained in the Firewall Datacenter configuration
 (`/etc/pve/firewall/cluster.fw`) are **not** automatically updated.
 
-The generated link files are stored in `/usr/local/lib/systemd/network`.
+The generated link files are stored in `/usr/local/lib/systemd/network`. For the
+configuration files a new file will be generated in the same place with a `.new`
+suffix. This way you can inspect the changes made to the configuration by
+using diff (or another diff viewer of your choice):
 
-It is currently only possible to generate names with the prefix `nic`, since
-otherwise the interfaces would not get recognized as a physical interface. When
-auto-generating new interface names, the tool will use `nic0`, `nic1`, ...
+----
+diff -y /etc/network/interfaces /etc/network/interfaces.new
+----
+
+If you see any problematic changes or want to revert the changes made by the
+pinning tool **before rebooting**, simply delete all `.new` files and the
+respective link files from `/usr/local/lib/systemd/network`.
 
 The following command will generate a .link file for all physical network
 interfaces that do not yet have a .link file and update selected Proxmox VE
-configuration files (see above):
+configuration files (see above). The generated names will use the default prefix
+`nic`, so the resulting interface names will be `nic1`, `nic2`, ...
 
 ----
 proxmox-network-interface-pinning generate
 ----
 
+You can override the default prefix with the `--prefix` flag:
+
+----
+proxmox-network-interface-pinning generate --prefix myprefix
+----
+
 It is also possible to pin only a specific interface:
 
 ----
 proxmox-network-interface-pinning generate --interface enp1s0
 ----
 
+When pinning a specific interface, you can specify the exact name that the
+interface should be pinned to:
+
+----
+proxmox-network-interface-pinning generate --interface enp1s0 --target-name if42
+----
+
 In order to apply the changes made by `proxmox-network-interface-pinning` to the
 network configuration, the node needs to be rebooted.
 
-- 
2.47.2


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


                 reply	other threads:[~2025-07-31 12:17 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250731121827.311601-1-s.hanreich@proxmox.com \
    --to=s.hanreich@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal