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 <[email protected]> --- 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
