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 EEB111FF15C for ; Fri, 22 Aug 2025 15:50:26 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 28721115B1; Fri, 22 Aug 2025 15:50:26 +0200 (CEST) From: Stefan Hanreich To: pdm-devel@lists.proxmox.com Date: Fri, 22 Aug 2025 15:49:29 +0200 Message-ID: <20250822134942.380480-24-s.hanreich@proxmox.com> X-Mailer: git-send-email 2.47.2 In-Reply-To: <20250822134942.380480-1-s.hanreich@proxmox.com> References: <20250822134942.380480-1-s.hanreich@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.188 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 KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods RDNS_NONE 0.793 Delivered to internal network by a host with no rDNS SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record Subject: [pdm-devel] [PATCH proxmox-datacenter-manager v2 06/15] api: sdn: add list_controllers endpoint X-BeenThere: pdm-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Datacenter Manager development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Datacenter Manager development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pdm-devel-bounces@lists.proxmox.com Sender: "pdm-devel" Add an endpoint for listing the controllers of all configured PVE remotes. They can be filtered by type / remote and it exposes options for querying the pending / running configuration. This call is quite expensive, since it makes a GET call to every configured PVE remote, which can take awhile depending on the network connection. For the future we might want to introduce a caching mechanism for this call. Signed-off-by: Stefan Hanreich --- lib/pdm-api-types/src/sdn.rs | 21 ++++++++- lib/pdm-client/src/lib.rs | 21 ++++++++- server/src/api/sdn/controllers.rs | 78 +++++++++++++++++++++++++++++++ server/src/api/sdn/mod.rs | 2 + 4 files changed, 119 insertions(+), 3 deletions(-) create mode 100644 server/src/api/sdn/controllers.rs diff --git a/lib/pdm-api-types/src/sdn.rs b/lib/pdm-api-types/src/sdn.rs index 5aaeb49..4f6df48 100644 --- a/lib/pdm-api-types/src/sdn.rs +++ b/lib/pdm-api-types/src/sdn.rs @@ -1,5 +1,5 @@ use proxmox_schema::{api, const_regex, ApiStringFormat, IntegerSchema, Schema, StringSchema}; -use pve_api_types::{SdnVnet, SdnZone}; +use pve_api_types::{SdnController, SdnVnet, SdnZone}; use serde::{Deserialize, Serialize}; use crate::remotes::REMOTE_ID_SCHEMA; @@ -110,6 +110,25 @@ pub struct CreateVnetParams { pub remotes: Vec, } +#[api( + properties: { + remote: { + schema: REMOTE_ID_SCHEMA, + }, + controller: { + type: pve_api_types::SdnController, + flatten: true, + } + } +)] +/// SDN controller with additional information about which remote it belongs to +#[derive(Serialize, Deserialize, Clone, PartialEq)] +pub struct ListController { + pub remote: String, + #[serde(flatten)] + pub controller: SdnController, +} + #[api( properties: { remote: { diff --git a/lib/pdm-client/src/lib.rs b/lib/pdm-client/src/lib.rs index 25885cd..1e4cace 100644 --- a/lib/pdm-client/src/lib.rs +++ b/lib/pdm-client/src/lib.rs @@ -58,8 +58,10 @@ pub mod types { pub use pve_api_types::PveUpid; - pub use pdm_api_types::sdn::{CreateVnetParams, CreateZoneParams, ListVnet, ListZone}; - pub use pve_api_types::ListZonesType; + pub use pdm_api_types::sdn::{ + CreateVnetParams, CreateZoneParams, ListController, ListVnet, ListZone, + }; + pub use pve_api_types::{ListControllersType, ListZonesType, SdnObjectState}; } pub struct PdmClient(pub T); @@ -870,6 +872,21 @@ impl PdmClient { Ok(self.0.get(&path).await?.expect_json()?.data) } + pub async fn pve_sdn_list_controllers( + &self, + pending: impl Into>, + running: impl Into>, + ty: impl Into>, + ) -> Result, Error> { + let path = ApiPathBuilder::new("/api2/extjs/sdn/controllers".to_string()) + .maybe_arg("pending", &pending.into()) + .maybe_arg("running", &running.into()) + .maybe_arg("ty", &ty.into()) + .build(); + + Ok(self.0.get(&path).await?.expect_json()?.data) + } + pub async fn pve_sdn_list_zones( &self, pending: impl Into>, diff --git a/server/src/api/sdn/controllers.rs b/server/src/api/sdn/controllers.rs new file mode 100644 index 0000000..3a3ee5c --- /dev/null +++ b/server/src/api/sdn/controllers.rs @@ -0,0 +1,78 @@ +use anyhow::Error; +use pbs_api_types::REMOTE_ID_SCHEMA; +use pdm_api_types::{remotes::RemoteType, sdn::ListController}; +use proxmox_router::Router; +use proxmox_schema::api; +use pve_api_types::ListControllersType; + +use crate::api::pve::{connect, get_remote}; + +pub const ROUTER: Router = Router::new().get(&API_METHOD_LIST_CONTROLLERS); + +#[api( + input: { + properties: { + pending: { + type: Boolean, + optional: true, + description: "Include a list of attributes whose changes are currently pending.", + }, + running: { + type: Boolean, + optional: true, + description: "If true shows the running configuration, otherwise the pending configuration.", + }, + ty: { + type: ListControllersType, + optional: true, + }, + remotes: { + type: Array, + optional: true, + description: "Only return controllers from the specified remotes.", + items: { + schema: REMOTE_ID_SCHEMA, + } + }, + } + }, + returns: { + type: Array, + description: "Get a list of controllers fitting the filtering criteria.", + items: { + type: ListController, + }, + }, +)] +/// Query controllers of remotes with optional filtering options +pub async fn list_controllers( + pending: Option, + running: Option, + ty: Option, + remotes: Option>, +) -> Result, Error> { + let (remote_config, _) = pdm_config::remotes::config()?; + + let remote_ids = remotes.unwrap_or_else(|| { + remote_config + .values() + .filter(|remote| (remote.ty == RemoteType::Pve)) + .map(|remote| remote.id.clone()) + .collect() + }); + + let mut result = Vec::new(); + + for remote in remote_ids { + let client = connect(get_remote(&remote_config, &remote)?)?; + + for controller in client.list_controllers(pending, running, ty).await? { + result.push(ListController { + remote: remote.clone(), + controller, + }) + } + } + + Ok(result) +} diff --git a/server/src/api/sdn/mod.rs b/server/src/api/sdn/mod.rs index ccf7123..ef0f8b9 100644 --- a/server/src/api/sdn/mod.rs +++ b/server/src/api/sdn/mod.rs @@ -1,11 +1,13 @@ use proxmox_router::{list_subdirs_api_method, Router, SubdirMap}; use proxmox_sortable_macro::sortable; +pub mod controllers; pub mod vnets; pub mod zones; #[sortable] pub const SUBDIRS: SubdirMap = &sorted!([ + ("controllers", &controllers::ROUTER), ("vnets", &vnets::ROUTER), ("zones", &zones::ROUTER), ]); -- 2.47.2 _______________________________________________ pdm-devel mailing list pdm-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel