[pdm-devel] [PATCH proxmox-datacenter-manager 05/16] api: sdn: add list_vnets endpoint

[Dominik Csapak]

one comment inline

On 8/27/25 1:40 PM, Stefan Hanreich wrote:
> Add an endpoint for listing the vnets 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, but for now we decided against it.
> 
> Signed-off-by: Stefan Hanreich <s.hanreich at proxmox.com>
> ---
>   lib/pdm-api-types/src/sdn.rs | 21 ++++++++++-
>   lib/pdm-client/src/lib.rs    | 15 +++++++-
>   server/src/api/sdn/mod.rs    |  2 +
>   server/src/api/sdn/vnets.rs  | 72 ++++++++++++++++++++++++++++++++++++
>   4 files changed, 108 insertions(+), 2 deletions(-)
>   create mode 100644 server/src/api/sdn/vnets.rs
> 
> diff --git a/lib/pdm-api-types/src/sdn.rs b/lib/pdm-api-types/src/sdn.rs
> index 2fd988f..e16e62a 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::SdnZone;
> +use pve_api_types::{SdnVnet, SdnZone};
>   use serde::{Deserialize, Serialize};
>   
>   use crate::remotes::REMOTE_ID_SCHEMA;
> @@ -65,6 +65,25 @@ pub struct CreateZoneParams {
>       pub remotes: Vec<CreateZoneRemote>,
>   }
>   
> +#[api(
> +    properties: {
> +        remote: {
> +            schema: REMOTE_ID_SCHEMA,
> +        },
> +        vnet: {
> +            type: pve_api_types::SdnVnet,
> +            flatten: true,
> +        }
> +    }
> +)]
> +/// SDN controller with additional information about which remote it belongs to
> +#[derive(Serialize, Deserialize, Clone, PartialEq)]
> +pub struct ListVnet {
> +    pub remote: String,
> +    #[serde(flatten)]
> +    pub vnet: SdnVnet,
> +}
> +
>   #[api(
>       properties: {
>           remote: {
> diff --git a/lib/pdm-client/src/lib.rs b/lib/pdm-client/src/lib.rs
> index ec48250..4a0cdb7 100644
> --- a/lib/pdm-client/src/lib.rs
> +++ b/lib/pdm-client/src/lib.rs
> @@ -8,7 +8,7 @@ use pdm_api_types::resource::{PveResource, RemoteResources, TopEntities};
>   use pdm_api_types::rrddata::{
>       LxcDataPoint, NodeDataPoint, PbsDatastoreDataPoint, PbsNodeDataPoint, QemuDataPoint,
>   };
> -use pdm_api_types::sdn::ListZone;
> +use pdm_api_types::sdn::{ListVnet, ListZone};
>   use pdm_api_types::BasicRealmInfo;
>   use pve_api_types::StartQemuMigrationType;
>   use serde::{Deserialize, Serialize};
> @@ -930,6 +930,19 @@ impl<T: HttpApiClient> PdmClient<T> {
>           Ok(self.0.get(&path).await?.expect_json()?.data)
>       }
>   
> +    pub async fn pve_sdn_list_vnets(
> +        &self,
> +        pending: impl Into<Option<bool>>,
> +        running: impl Into<Option<bool>>,
> +    ) -> Result<Vec<ListVnet>, Error> {
> +        let path = ApiPathBuilder::new("/api2/extjs/sdn/vnets".to_string())
> +            .maybe_arg("pending", &pending.into())
> +            .maybe_arg("running", &running.into())
> +            .build();
> +
> +        Ok(self.0.get(&path).await?.expect_json()?.data)
> +    }
> +
>       pub async fn pve_sdn_create_zone(&self, params: CreateZoneParams) -> Result<String, Error> {
>           let path = "/api2/extjs/sdn/zones";
>   
> diff --git a/server/src/api/sdn/mod.rs b/server/src/api/sdn/mod.rs
> index 2abdaf6..ccf7123 100644
> --- a/server/src/api/sdn/mod.rs
> +++ b/server/src/api/sdn/mod.rs
> @@ -1,10 +1,12 @@
>   use proxmox_router::{list_subdirs_api_method, Router, SubdirMap};
>   use proxmox_sortable_macro::sortable;
>   
> +pub mod vnets;
>   pub mod zones;
>   
>   #[sortable]
>   pub const SUBDIRS: SubdirMap = &sorted!([
> +    ("vnets", &vnets::ROUTER),
>       ("zones", &zones::ROUTER),
>   ]);
>   
> diff --git a/server/src/api/sdn/vnets.rs b/server/src/api/sdn/vnets.rs
> new file mode 100644
> index 0000000..2ac2956
> --- /dev/null
> +++ b/server/src/api/sdn/vnets.rs
> @@ -0,0 +1,72 @@
> +use anyhow::Error;
> +use pbs_api_types::REMOTE_ID_SCHEMA;
> +use pdm_api_types::{remotes::RemoteType, sdn::ListVnet};
> +use proxmox_router::Router;
> +use proxmox_schema::api;
> +
> +use crate::api::pve::{connect, get_remote};
> +
> +pub const ROUTER: Router = Router::new().get(&API_METHOD_LIST_VNETS);
> +
> +#[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.",
> +            },
> +            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: ListVnet,
> +        },
> +    },
> +)]
> +/// Query VNets of PVE remotes with optional filtering options
> +async fn list_vnets(
> +    pending: Option<bool>,
> +    running: Option<bool>,
> +    remotes: Option<Vec<String>>,
> +) -> Result<Vec<ListVnet>, 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 vnet in client.list_vnets(pending, running).await? {
> +            result.push(ListVnet {
> +                remote: remote.clone(),
> +                vnet,
> +            })
> +        }
> +    }

similar remark as for the other paralallizing stuff (just so we don't 
forget)

we could use a joinset + semaphores in the future to parallelize this 
more, but for now probably good enough

> +
> +    Ok(result)
> +}