all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Gabriel Goller <g.goller@proxmox.com>
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	[thread overview]
Message-ID: <20260203160246.353351-24-g.goller@proxmox.com> (raw)
In-Reply-To: <20260203160246.353351-1-g.goller@proxmox.com>

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 <g.goller@proxmox.com>
---
 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* `<COMMAND> [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* `<protocol>`
+
+Create a override file in `/etc/proxmox-frr/templates/` for a specific protocol
+or a specific template.
+
+`<protocol>`: `<string>` ::
+
+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` `<string>` ::
+
+Reset a specific template file (e.g. 'frr.conf.jinja').
+
+[[cli_pvesdn_template_show]]
+*pvesdn template show* `<template-name>`
+
+Show the default content of a specific template.
+
+`<template-name>`: `<string>` ::
+
+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





      parent reply	other threads:[~2026-02-03 16:03 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-03 16:01 [PATCH docs/manager/network/proxmox{-ve-rs,-perl-rs} 00/23] Generate frr config using jinja templates and rust types Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 1/9] ve-config: firewall: cargo fmt Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 2/9] frr: add proxmox-frr-templates package that contains templates Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 3/9] ve-config: remove FrrConfigBuilder struct Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 4/9] sdn-types: support variable-length NET identifier Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 5/9] frr: add template serializer and serialize fabrics using templates Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 6/9] frr: add isis configuration and templates Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 7/9] frr: support custom frr configuration lines Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 8/9] frr: add bgp support with templates and serialization Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-ve-rs 9/9] frr: store frr template content as a const map Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-perl-rs 1/2] sdn: add function to generate the frr config for all daemons Gabriel Goller
2026-02-03 16:01 ` [PATCH proxmox-perl-rs 2/2] sdn: add method to get a frr template Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 01/10] sdn: remove duplicate comment line '!' in frr config Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 02/10] sdn: tests: add missing comment " Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 03/10] tests: use Test::Differences to make test assertions Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 04/10] sdn: write structured frr config that can be rendered using templates Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 05/10] tests: rearrange some statements in the frr config Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 06/10] sdn: adjust frr.conf.local merging to rust template types Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 07/10] cli: add pvesdn cli tool for managing frr template overrides Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 08/10] debian: handle user modifications to FRR templates via ucf Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 09/10] api: add dry-run endpoint for sdn apply to preview changes Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-network 10/10] test: add test for frr.conf.local merging Gabriel Goller
2026-02-03 16:01 ` [PATCH pve-manager 1/1] sdn: add dry-run view for sdn apply Gabriel Goller
2026-02-03 16:01 ` Gabriel Goller [this message]

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=20260203160246.353351-24-g.goller@proxmox.com \
    --to=g.goller@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