public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH pve-docs 10/10] sdn: fabrics: wireguard: document status values and keepalive column
Date: Fri, 20 Nov 2026 17:00:25 +0100	[thread overview]
Message-ID: <20261120160026.512565-11-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20261120160026.512565-1-s.hanreich@proxmox.com>

The interface status no longer falls back to the configured public key
and listen port, and only reports the type 'wireguard' if the interface
on the node actually is a WireGuard interface. Status values that
WireGuard does not report are shown as '-'.

Also document the new persistent keepalive column of the neighbors,
which shows the interval that WireGuard currently uses.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 pvesdn.adoc | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

diff --git a/pvesdn.adoc b/pvesdn.adoc
index 0d7eea7..4ebf43a 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -1158,7 +1158,8 @@ with the following properties:
 
 Name:: The name of the network interface on the host.
 
-Type:: Interfaces are always of type 'wireguard'.
+Type:: 'wireguard' if the interface on the node is a WireGuard interface,
+shown as '-' otherwise.
 
 State:: The state of the interface on the node:
 +
@@ -1168,14 +1169,13 @@ State:: The state of the interface on the node:
   applying the configuration failed on the node.
 * 'unknown': The interface exists, but its WireGuard state could not be read.
 * 'error': The interface exists, but is not a WireGuard interface.
-+
-If WireGuard does not report a public key for an interface, the configured
-public key and listen port are shown.
 
 Public Key:: The public key that can be used for communicating with the
-WireGuard instance on this interface.
+WireGuard instance on this interface. Shown as '-' if WireGuard does not report
+one, for example because the interface has no private key.
 
 Listen Port:: The port that can be used to reach this WireGuard instance.
+Shown as '-' if WireGuard does not report the interface.
 
 .Neighbors
 
@@ -1183,13 +1183,14 @@ Lists the peers that WireGuard reports for the interfaces of the node, with the
 following properties:
 
 Name:: The name of the peer in the fabric configuration. For a node of the
-cluster, its interface follows in parentheses. A peer without a name has a
-public key that is not configured for this interface.
+cluster, its interface follows in parentheses. A peer without a name, shown
+as '-', has a public key that is not configured for this interface.
 
 Neighbor:: The endpoint that is currently used to reach this peer (e.g.
 192.0.2.1:51820). WireGuard updates the endpoint to the address it last
 received traffic from, so this can differ from the configured endpoint, for
-example if the peer is behind NAT. Empty if the endpoint is not known yet.
+example if the peer is behind NAT. Shown as '-' if the endpoint is not known
+yet.
 
 Interface:: The interface that has this neighbor configured.
 
@@ -1207,11 +1208,16 @@ Public Key:: The public key of the neighbor.
 
 Allowed IPs:: A comma-separated list of CIDRs. On this interface, traffic to a
 destination is sent to the neighbor with the most specific matching prefix, and
-traffic from a source address is only accepted from that neighbor.
+traffic from a source address is only accepted from that neighbor. Shown as
+'-' if no allowed IPs are configured for the neighbor.
 
 Latest Handshake:: The time of the latest handshake with this neighbor. A dash
 means that there was no handshake yet.
 
+Persistent Keepalive (s):: The persistent keepalive interval that WireGuard
+currently uses for this neighbor, or 'off' if it is disabled. This can differ
+from the configured interval, for example if applying the configuration failed.
+
 Bytes transmitted:: The amount of traffic that has been sent to this neighbor.
 
 Bytes received:: The amount of traffic that has been received from this
-- 
2.47.3





      parent reply	other threads:[~2026-11-20 16:01 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-20 16:00 [PATCH docs/manager/network/proxmox-perl-rs 00/10] WireGuard fabric follow-ups Stefan Hanreich
2026-11-20 16:00 ` [PATCH proxmox-perl-rs 01/10] pve-rs: sdn: fabrics: wireguard: return empty status for non-member nodes Stefan Hanreich
2026-11-20 16:00 ` [PATCH proxmox-perl-rs 02/10] pve-rs: sdn: status: wireguard: only report type of WireGuard interfaces Stefan Hanreich
2026-11-20 16:00 ` [PATCH proxmox-perl-rs 03/10] pve-rs: sdn: status: wireguard: only report running interface keys and ports Stefan Hanreich
2026-11-20 16:00 ` [PATCH pve-network 04/10] api: fabric status: document omitted WireGuard interface values Stefan Hanreich
2026-11-20 16:00 ` [PATCH pve-manager 05/10] ui: sdn: fabrics: wireguard: block saving invalid " Stefan Hanreich
2026-11-20 16:00 ` [PATCH pve-manager 06/10] ui: sdn: fabrics: wireguard: show persistent keepalive of neighbors Stefan Hanreich
2026-11-20 16:00 ` [PATCH pve-manager 07/10] ui: sdn: fabrics: wireguard: show '-' for unknown status values Stefan Hanreich
2026-11-20 16:00 ` [PATCH pve-manager 08/10] ui: sdn: fabrics: wireguard: add reload button to status grids Stefan Hanreich
2026-11-20 16:00 ` [PATCH pve-manager 09/10] ui: sdn: fabrics: wireguard: support resetting the interfaces Stefan Hanreich
2026-11-20 16:00 ` Stefan Hanreich [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=20261120160026.512565-11-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal