From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id A62461FF0AF for ; Fri, 20 Nov 2026 17:01:45 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 455992187F; Fri, 20 Nov 2026 17:00:41 +0100 (CET) From: Stefan Hanreich 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 Message-ID: <20261120160026.512565-11-s.hanreich@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261120160026.512565-1-s.hanreich@proxmox.com> References: <20261120160026.512565-1-s.hanreich@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1795190433594 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.196 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_FILL_THIS_FORM_SHORT 0.01 Fill in a short form with personal information Message-ID-Hash: 5LWRFVMO7ALROM6QQ7FI6U7RM4BZE7LN X-Message-ID-Hash: 5LWRFVMO7ALROM6QQ7FI6U7RM4BZE7LN X-MailFrom: s.hanreich@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: 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 --- 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