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-network 05/13] api2: add route maps api module
Date: Wed, 25 Mar 2026 10:41:30 +0100	[thread overview]
Message-ID: <20260325094142.174364-20-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20260325094142.174364-1-s.hanreich@proxmox.com>

Contains the following API endpoints:

GET /route-maps - lists all route map entries
POST /route-maps - creates a new route map entry

The following commits contain the API modules for accessing specific
route maps / route map entries.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 src/PVE/API2/Network/SDN.pm           |   7 ++
 src/PVE/API2/Network/SDN/RouteMaps.pm | 131 ++++++++++++++++++++++++++
 2 files changed, 138 insertions(+)
 create mode 100644 src/PVE/API2/Network/SDN/RouteMaps.pm

diff --git a/src/PVE/API2/Network/SDN.pm b/src/PVE/API2/Network/SDN.pm
index d999ad0..16d1536 100644
--- a/src/PVE/API2/Network/SDN.pm
+++ b/src/PVE/API2/Network/SDN.pm
@@ -23,6 +23,7 @@ use PVE::API2::Network::SDN::Ipams;
 use PVE::API2::Network::SDN::Dns;
 use PVE::API2::Network::SDN::Fabrics;
 use PVE::API2::Network::SDN::PrefixLists;
+use PVE::API2::Network::SDN::RouteMaps;
 
 use base qw(PVE::RESTHandler);
 
@@ -61,6 +62,11 @@ __PACKAGE__->register_method({
     path => 'prefix-lists',
 });
 
+__PACKAGE__->register_method({
+    subclass => "PVE::API2::Network::SDN::RouteMaps",
+    path => 'route-maps',
+});
+
 __PACKAGE__->register_method({
     name => 'index',
     path => '',
@@ -94,6 +100,7 @@ __PACKAGE__->register_method({
             { id => 'dns' },
             { id => 'fabrics' },
             { id => 'prefix-lists' },
+            { id => 'route-maps' },
         ];
 
         return $res;
diff --git a/src/PVE/API2/Network/SDN/RouteMaps.pm b/src/PVE/API2/Network/SDN/RouteMaps.pm
new file mode 100644
index 0000000..f3c3583
--- /dev/null
+++ b/src/PVE/API2/Network/SDN/RouteMaps.pm
@@ -0,0 +1,131 @@
+package PVE::API2::Network::SDN::RouteMaps;
+
+use strict;
+use warnings;
+
+use PVE::Exception qw(raise_param_exc);
+use PVE::JSONSchema qw(get_standard_option);
+use PVE::Network::SDN::RouteMaps;
+use PVE::Tools qw(extract_param);
+
+use PVE::RESTHandler;
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method({
+    name => 'list_route_maps',
+    path => '',
+    method => 'GET',
+    permissions => {
+        description =>
+            "Only returns route map entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions.",
+    },
+    description => "List Route Maps",
+    parameters => {
+        properties => {
+            running => {
+                type => 'boolean',
+                optional => 1,
+                description => "Display running config.",
+            },
+            pending => {
+                type => 'boolean',
+                optional => 1,
+                description => "Display pending config.",
+            },
+        },
+    },
+    returns => {
+        type => 'array',
+        items => {
+            type => "object",
+            properties => PVE::Network::SDN::RouteMaps::route_map_properties(0),
+        },
+        links => [{ rel => 'child', href => "{route-map-id}" }],
+    },
+    code => sub {
+        my ($param) = @_;
+
+        my $pending = extract_param($param, 'pending');
+        my $running = extract_param($param, 'running');
+
+        my $digest;
+        my $route_maps;
+
+        if ($pending) {
+            my $current_config = PVE::Network::SDN::RouteMaps::config()->list();
+            my $running_config = PVE::Network::SDN::RouteMaps::config(1)->list();
+
+            my $pending_route_maps = PVE::Network::SDN::pending_config(
+                $running_config,
+                $current_config,
+                'route-maps',
+            );
+
+            $digest = $current_config->digest();
+            $route_maps = $pending_route_maps->{ids}
+        } elsif ($running) {
+            $route_maps = PVE::Network::SDN::RouteMaps::config(1)->list();
+        } else {
+            my $current_config = PVE::Network::SDN::RouteMaps::config();
+
+            $digest = $current_config->digest();
+            $route_maps = $current_config->list();
+        }
+
+        my $rpcenv = PVE::RPCEnvironment::get();
+        my $authuser = $rpcenv->get_user();
+        my $route_map_privs = ['SDN.Audit', 'SDN.Allocate'];
+
+        my @res;
+        for my $route_map_id (sort keys $route_maps->%*) {
+            next if !$rpcenv->check_any($authuser, "/route-maps/$route_map_id", $route_map_privs, 1);
+            $route_maps->{$route_map_id}->{digest} = $digest if $digest;
+            push @res, $route_maps->{$route_map_id};
+        }
+
+        return \@res;
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'create_route_map_entry',
+    path => '',
+    method => 'POST',
+    permissions => {
+        check => ['perm', '/sdn/route-maps', ['SDN.Allocate']],
+    },
+    description => "Create Route Map entry",
+    parameters => {
+        properties => {
+            digest => get_standard_option('pve-config-digest'),
+            'lock-token' => get_standard_option('pve-sdn-lock-token'),
+            PVE::Network::SDN::RouteMaps::route_map_properties(0)->%*,
+        },
+    },
+    returns => {
+        type => "null",
+    },
+    code => sub {
+        my ($param) = @_;
+
+        my $lock_token = extract_param($param, 'lock-token');
+
+        PVE::Network::SDN::lock_sdn_config(
+            sub {
+                my $config = PVE::Network::SDN::RouteMaps::config();
+
+                my $digest = extract_param($param, 'digest');
+                PVE::Tools::assert_if_modified($config->digest(), $digest) if $digest;
+
+                $config->create($param);
+                PVE::Network::SDN::RouteMaps::write_config($config);
+            },
+            "creating route map entry failed",
+            $lock_token,
+        );
+
+        return;
+    },
+});
+
+1;
-- 
2.47.3





  parent reply	other threads:[~2026-03-25  9:44 UTC|newest]

Thread overview: 62+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-25  9:41 [PATCH cluster/network/proxmox{-ve-rs,-perl-rs} 00/27] Add support for route maps / prefix lists to SDN Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-cluster 1/2] cfs: add 'sdn/route-maps.cfg' to observed files Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-cluster 2/2] cfs: add 'sdn/prefix-lists.cfg' " Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 1/9] sdn-types: add common route-map helper types Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 2/9] frr: implement routemap match/set statements via adjacent tagging Stefan Hanreich
2026-03-26 14:44   ` Hannes Laimer
2026-03-27  9:02     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 3/9] frr: allow rendering prefix-lists/route-maps separately Stefan Hanreich
2026-03-25 14:32   ` Gabriel Goller
2026-03-26 12:17     ` Stefan Hanreich
2026-03-27 10:50   ` Hannes Laimer
2026-03-27 11:34     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 4/9] frr-templates: change route maps template to adapt to new types Stefan Hanreich
2026-03-25 14:33   ` Gabriel Goller
2026-03-25 14:58     ` Gabriel Goller
2026-03-27 11:01   ` Hannes Laimer
2026-03-27 11:17     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 5/9] ve-config: add prefix list section config Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 6/9] ve-config: frr: implement frr config generation for prefix lists Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 7/9] ve-config: add route map section config Stefan Hanreich
2026-03-25 14:35   ` Gabriel Goller
2026-03-26 13:49     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 8/9] ve-config: frr: implement frr config generation for route maps Stefan Hanreich
2026-03-25 15:03   ` Gabriel Goller
2026-03-26 13:50     ` Stefan Hanreich
2026-03-27 11:17   ` Hannes Laimer
2026-03-27 11:21     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 9/9] ve-config: fabrics: adapt frr config generation to new format Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-perl-rs 1/3] pve-rs: sdn: add route maps module Stefan Hanreich
2026-03-26 10:32   ` Wolfgang Bumiller
2026-03-26 13:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-perl-rs 2/3] pve-rs: sdn: add prefix lists module Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-perl-rs 3/3] sdn: add prefix list / route maps to frr config generation helper Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 01/13] controller: bgp: evpn: adapt to new match / set frr config syntax Stefan Hanreich
2026-03-26 15:19   ` Hannes Laimer
2026-03-27 10:05     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 02/13] sdn: add prefix lists module Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 03/13] api2: add prefix list module Stefan Hanreich
2026-03-26 15:01   ` Hannes Laimer
2026-03-27  9:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 04/13] sdn: add route map module Stefan Hanreich
2026-03-25  9:41 ` Stefan Hanreich [this message]
2026-03-26 15:05   ` [PATCH pve-network 05/13] api2: add route maps api module Hannes Laimer
2026-03-27  9:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 06/13] api2: add route map module Stefan Hanreich
2026-03-26 15:07   ` Hannes Laimer
2026-03-27  9:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 07/13] api2: add route map entry module Stefan Hanreich
2026-03-26 15:13   ` Hannes Laimer
2026-03-27 10:01     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 08/13] evpn controller: add route_map_{in,out} parameter Stefan Hanreich
2026-03-27 10:44   ` Hannes Laimer
2026-03-27 11:12     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 09/13] sdn: generate route map / prefix list configuration on sdn apply Stefan Hanreich
2026-03-27 10:47   ` Hannes Laimer
2026-03-27 11:13     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 10/13] tests: add simple route map test case Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 11/13] tests: add bgp evpn route map/prefix list testcase Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 12/13] tests: add route map with prefix " Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 13/13] bgp controller: allow configuring custom route maps Stefan Hanreich
2026-03-25 11:38 ` [PATCH cluster/network/proxmox{-ve-rs,-perl-rs} 00/27] Add support for route maps / prefix lists to SDN Stefan Hanreich
2026-03-27 10:17 ` Stefan Hanreich

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=20260325094142.174364-20-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