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 v3 24/44] api2: add route maps module
Date: Mon,  4 May 2026 13:39:21 +0200	[thread overview]
Message-ID: <20260504113943.159905-25-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20260504113943.159905-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 | 135 ++++++++++++++++++++++++++
 2 files changed, 142 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 778a29b..ef64df2 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..33d800b
--- /dev/null
+++ b/src/PVE/API2/Network/SDN/RouteMaps.pm
@@ -0,0 +1,135 @@
+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.",
+        user => 'all',
+    },
+    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();
+            my $running_config = PVE::Network::SDN::RouteMaps::config(1);
+
+            my $pending_route_maps = PVE::Network::SDN::pending_config(
+                { 'route-maps' => { ids => $running_config->list() } },
+                { ids => $current_config->list() },
+                '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, "/sdn/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',
+    protected => 1,
+    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-05-04 11:42 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-04 11:38 [PATCH access-control/cluster/manager/network/proxmox{-ve-rs,-perl-rs} v3 00/44] Add support for route maps / prefix lists to SDN Stefan Hanreich
2026-05-04 11:38 ` [PATCH pve-cluster v3 01/44] cfs: add 'sdn/route-maps.cfg' to observed files Stefan Hanreich
2026-05-04 11:38 ` [PATCH pve-cluster v3 02/44] cfs: add 'sdn/prefix-lists.cfg' " Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-access-control v3 03/44] permissions: add ACL path for prefix-lists and route-maps Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 04/44] frr: add constructor to prefix list name Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 05/44] sdn-types: add common route-map helper types Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 06/44] frr: change order type to u16 Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 07/44] frr: implement routemap match/set statements via adjacent tagging Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 08/44] frr: implement support for call and exit action Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 09/44] frr-templates: change route maps template to adapt to new frr types Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 10/44] ve-config: fabrics: adapt frr config generation Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 11/44] ve-config: add prefix list section config Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 12/44] ve-config: frr: implement frr config generation for prefix lists Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 13/44] ve-config: add route map section config Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 14/44] ve-config: frr: implement frr config generation for route maps Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 15/44] ve-config: add prefix lists integration tests Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-ve-rs v3 16/44] ve-config: add route maps " Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-perl-rs v3 17/44] pve-rs: sdn: add route maps module Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-perl-rs v3 18/44] pve-rs: sdn: add prefix lists module Stefan Hanreich
2026-05-04 11:39 ` [PATCH proxmox-perl-rs v3 19/44] sdn: add prefix list / route maps to frr config generation helper Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 20/44] controller: bgp: evpn: adapt to new match / set frr config syntax Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 21/44] sdn: add prefix lists module Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 22/44] sdn: add route map module Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 23/44] api2: add prefix list module Stefan Hanreich
2026-05-04 11:39 ` Stefan Hanreich [this message]
2026-05-04 11:39 ` [PATCH pve-network v3 25/44] api2: add route map module Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 26/44] api2: add route map entry module Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 27/44] evpn controller: add route_map_{in,out} parameter Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 28/44] bgp controller: allow configuring custom route maps Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 29/44] sdn: change detection for route maps / prefix lists Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 30/44] sdn: generate route map / prefix list configuration on sdn apply Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 31/44] sdn: frr: consider route maps and prefix lists in dry-run Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 32/44] fabrics: ospf: openfabric: add route_filter property Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 33/44] tests: add simple route map test case Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 34/44] tests: add bgp evpn route map/prefix list testcase Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 35/44] tests: add route map with prefix " Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-network v3 36/44] tests: add exit node with custom route map testcase Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 37/44] ui: sdn: add route map selector Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 38/44] ui: sdn: add prefix list selector Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 39/44] ui: sdn: add panel for managing prefix lists Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 40/44] ui: sdn: add panel for managing route map entries Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 41/44] ui: sdn: bgp controller: allow configuring route maps Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 42/44] ui: sdn: evpn " Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 43/44] ui: sdn: openfabric: add route filter Stefan Hanreich
2026-05-04 11:39 ` [PATCH pve-manager v3 44/44] ui: sdn: ospf: add route filter setting Stefan Hanreich
2026-05-04 16:37 ` superseded: [PATCH access-control/cluster/manager/network/proxmox{-ve-rs,-perl-rs} v3 00/44] Add support for route maps / prefix lists to SDN 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=20260504113943.159905-25-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