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 3607F1FF137 for ; Tue, 03 Feb 2026 17:03:29 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id B322A24FFB; Tue, 3 Feb 2026 17:03:29 +0100 (CET) From: Gabriel Goller To: pve-devel@lists.proxmox.com Subject: [PATCH pve-docs 1/1] docs: add man page for the `pvesdn` cli Date: Tue, 3 Feb 2026 17:01:30 +0100 Message-ID: <20260203160246.353351-24-g.goller@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260203160246.353351-1-g.goller@proxmox.com> References: <20260203160246.353351-1-g.goller@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1770134498041 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.003 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_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment 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: 7DQYB4BCYHQTUJFYTOEX2NRNNZTGBB7W X-Message-ID-Hash: 7DQYB4BCYHQTUJFYTOEX2NRNNZTGBB7W X-MailFrom: g.goller@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: Add the man page for the `pvesdn` cli. The man page is on top of the general `SDN` page, as it is done in `ceph` and `pct`. Signed-off-by: Gabriel Goller --- pvesdn.1-synopsis.adoc | 39 +++++++++++++++++++++++++++++++++++++++ pvesdn.adoc | 24 +++++++++++++++++++++++- 2 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 pvesdn.1-synopsis.adoc diff --git a/pvesdn.1-synopsis.adoc b/pvesdn.1-synopsis.adoc new file mode 100644 index 000000000000..8ef0e7071e89 --- /dev/null +++ b/pvesdn.1-synopsis.adoc @@ -0,0 +1,39 @@ +[[cli_pvesdn]] +*pvesdn* ` [ARGS] [OPTIONS]` + +[[cli_pvesdn_template_diff]] +*pvesdn template diff* + +Show the diff between the default frr config templates and the override +templates in `/etc/proxmox-frr/templates/`. + +[[cli_pvesdn_template_override]] +*pvesdn template override* `` + +Create a override file in `/etc/proxmox-frr/templates/` for a specific protocol +or a specific template. + +``: `` :: + +The protocol name (e.g. 'bgp', 'openfabric') or a template name (e.g. 'bgpd.jinja', 'access_lists.jinja'). + +[[cli_pvesdn_template_reset]] +*pvesdn template reset* `[OPTIONS]` + +Reset the override template files in `/etc/proxmox-frr/templates/`. If no +specific template is passed, then reset all. + +`--name` `` :: + +Reset a specific template file (e.g. 'frr.conf.jinja'). + +[[cli_pvesdn_template_show]] +*pvesdn template show* `` + +Show the default content of a specific template. + +``: `` :: + +The template name (e.g. 'bgpd.jinja', 'access_lists.jinja'). + + diff --git a/pvesdn.adoc b/pvesdn.adoc index d20a0eb85b0e..479468f506de 100644 --- a/pvesdn.adoc +++ b/pvesdn.adoc @@ -1,7 +1,25 @@ [[chapter_pvesdn]] +ifdef::manvolnum[] +pvesdn(1) +========== +:pve-toplevel: + +NAME +---- + +pvesdn - Manage Proxmox VE Software Defined Network (SDN) + +SYNOPSIS +-------- + +include::pvesdn.1-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] +ifndef::manvolnum[] Software-Defined Network ======================== -ifndef::manvolnum[] :pve-toplevel: endif::manvolnum[] @@ -1469,3 +1487,7 @@ and add the key to `/etc/ipsec.secrets`, so that the file contents looks like: ---- Copy the PSK and the configuration to all nodes participating in the VXLAN network. + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] -- 2.47.3