From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 42B2E1FF146 for ; Tue, 23 Jun 2026 11:45:35 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 6BF801DD67; Tue, 23 Jun 2026 11:45:19 +0200 (CEST) From: Christoph Heiss To: pve-devel@lists.proxmox.com Subject: [PATCH docs 3/7] pve-network-interface-pinning: init man(1) page Date: Tue, 23 Jun 2026 11:43:20 +0200 Message-ID: <20260623094419.330174-4-c.heiss@proxmox.com> X-Mailer: git-send-email 2.54.0 In-Reply-To: <20260623094419.330174-1-c.heiss@proxmox.com> References: <20260623094419.330174-1-c.heiss@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1782207874358 X-SPAM-LEVEL: Spam detection results: 1 AWL -2.825 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible spam tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment KAM_SOMETLD_ARE_BAD_TLD 5 .bar, .beauty, .buzz, .cam, .casa, .cfd, .club, .date, .guru, .link, .live, .monster, .online, .press, .pw, .quest, .rest, .sbs, .shop, .stream, .top, .trade, .wiki, .work, .xyz TLD abuse SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: 5EXD2ZD2IAXNJ2OTS43BOVMPI3UUXI52 X-Message-ID-Hash: 5EXD2ZD2IAXNJ2OTS43BOVMPI3UUXI52 X-MailFrom: c.heiss@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Signed-off-by: Christoph Heiss --- FWIW; this already includes the help text for the new `rename` subcommand introduced in patch #6. ...-network-interface-pinning.1-synopsis.adoc | 50 ++++++++++++++++ pve-admin-guide.adoc | 8 +++ pve-network-interface-pinning.adoc | 60 +++++++++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 generated/pve-network-interface-pinning.1-synopsis.adoc create mode 100644 pve-network-interface-pinning.adoc diff --git a/generated/pve-network-interface-pinning.1-synopsis.adoc b/generated/pve-network-interface-pinning.1-synopsis.adoc new file mode 100644 index 0000000..f8eb18d --- /dev/null +++ b/generated/pve-network-interface-pinning.1-synopsis.adoc @@ -0,0 +1,50 @@ +[[cli_pve-network-interface-pinning]] +*pve-network-interface-pinning* ` [ARGS] [OPTIONS]` + +[[cli_pve-network-interface-pinning_generate]] +*pve-network-interface-pinning generate* `[OPTIONS]` + +Generate systemd.link files to pin the names of one or more network +interfaces and update all network-related configuration files. + +`--interface` `` ('default =' ``):: + +Only pin a specific interface. + +`--prefix` `^[a-zA-Z][a-zA-Z0-9-_]{0,7}$` ('default =' `nic`):: + +Use a specific prefix for automatically choosing the pinned name. + +`--target-name` `` :: + +Pin the interface to a specific name. ++ +NOTE: Requires option(s): `interface` + +[[cli_pve-network-interface-pinning_help]] +*pve-network-interface-pinning help* `[OPTIONS]` + +Get help about specified command. + +`--extra-args` `` :: + +Shows help for a specific command + +`--verbose` `` :: + +Verbose output format. + +[[cli_pve-network-interface-pinning_rename]] +*pve-network-interface-pinning rename* ` ` + +Rename an existing pin for a network interface to a specific name. + +``: `` :: + +The interface to rename. + +``: `` :: + +The new pinned interface name. + + diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index fd37b1e..c086377 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -226,6 +226,14 @@ include::generated/ha-manager.1-synopsis.adoc[] :leveloffset: 0 +*pve-network-interface-pinning* - {pve} Network Interface Pinning Tool +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::generated/pve-network-interface-pinning.1-synopsis.adoc[] + +:leveloffset: 0 + [appendix] Service Daemons diff --git a/pve-network-interface-pinning.adoc b/pve-network-interface-pinning.adoc new file mode 100644 index 0000000..79d6aeb --- /dev/null +++ b/pve-network-interface-pinning.adoc @@ -0,0 +1,60 @@ +ifdef::manvolnum[] +pve-network-interface-pinning(1) +================================ +:pve-toplevel: + +NAME +---- + +pve-network-interface-pinning - Proxmox VE Network Interface Pinning Tool + +SYNOPSIS +-------- + +include::generated/pve-network-interface-pinning.1-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +Overriding Network Device Names +=============================== +endif::manvolnum[] + +Command line tool to generate and rename pinned network interface names. + +ifdef::manvolnum[] + +In order to apply the changes made by `pve-network-interface-pinning`, the node +needs to be rebooted. + +EXAMPLES +-------- + +To generate .link for all present physical interfaces: + +---- +pve-network-interface-pinning generate +---- + +As above, but with a custom prefix instead of `nic`: + +---- +pve-network-interface-pinning generate --prefix myprefix +---- + +Or just pin a specific network interface to a chosen name: + +---- +pve-network-interface-pinning generate --interface enp1s0 --target-name mynic +---- + +To rename an already pinned interface, e.g. `nic0` to `fiber10g0`: + +---- +pve-network-interface-pinning rename nic0 fiber10g0 +---- + +include::pve-copyright.adoc[] +endif::manvolnum[] -- 2.54.0