public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Gabriel Goller <g.goller@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-network 14/17] fabric: ospf: add api endpoints
Date: Fri, 28 Mar 2025 18:13:29 +0100	[thread overview]
Message-ID: <20250328171340.885413-42-g.goller@proxmox.com> (raw)
In-Reply-To: <20250328171340.885413-1-g.goller@proxmox.com>

From: Stefan Hanreich <s.hanreich@proxmox.com>

Add CRUD endpoints for the ospf fabric and node section types.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Co-authored-by: Gabriel Goller <g.goller@proxmox.com>
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
 src/PVE/API2/Network/SDN/Fabrics/Makefile |   2 +-
 src/PVE/API2/Network/SDN/Fabrics/Ospf.pm  | 345 ++++++++++++++++++++++
 2 files changed, 346 insertions(+), 1 deletion(-)
 create mode 100644 src/PVE/API2/Network/SDN/Fabrics/Ospf.pm

diff --git a/src/PVE/API2/Network/SDN/Fabrics/Makefile b/src/PVE/API2/Network/SDN/Fabrics/Makefile
index 8f7c630ef3ab..e433f2e7d0a6 100644
--- a/src/PVE/API2/Network/SDN/Fabrics/Makefile
+++ b/src/PVE/API2/Network/SDN/Fabrics/Makefile
@@ -1,4 +1,4 @@
-SOURCES=OpenFabric.pm Common.pm
+SOURCES=OpenFabric.pm Ospf.pm Common.pm
 
 
 PERL5DIR=${DESTDIR}/usr/share/perl5
diff --git a/src/PVE/API2/Network/SDN/Fabrics/Ospf.pm b/src/PVE/API2/Network/SDN/Fabrics/Ospf.pm
new file mode 100644
index 000000000000..badf7c89c183
--- /dev/null
+++ b/src/PVE/API2/Network/SDN/Fabrics/Ospf.pm
@@ -0,0 +1,345 @@
+package PVE::API2::Network::SDN::Fabrics::Ospf;
+
+use strict;
+use warnings;
+
+use Storable qw(dclone);
+
+use PVE::RPCEnvironment;
+use PVE::Tools qw(extract_param);
+
+use PVE::Network::SDN;
+use PVE::Network::SDN::Fabrics;
+use PVE::API2::Network::SDN::Fabrics::Common;
+
+use PVE::RESTHandler;
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method({
+    name => 'delete_fabric',
+    path => '{fabric}',
+    method => 'DELETE',
+    description => 'Delete SDN Fabric',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    },
+	},
+    },
+    returns => {
+	type => 'null',
+    },
+    code => sub {
+	my ($param) = @_;
+
+	PVE::Network::SDN::lock_sdn_config(
+	    sub {
+		PVE::API2::Network::SDN::Fabrics::Common::delete_fabric("ospf", $param);
+	    }, "delete sdn fabric failed");
+	return undef;
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'delete_node',
+    path => '{fabric}/node/{node}',
+    method => 'DELETE',
+    description => 'Delete SDN Fabric Node',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}/node/{node}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    },
+	    node => {
+		type => 'string',
+		description => 'The hostname of the node',
+	    },
+	},
+    },
+    returns => {
+	type => 'null',
+    },
+    code => sub {
+	my ($param) = @_;
+
+	PVE::Network::SDN::lock_sdn_config(
+	    sub {
+		PVE::API2::Network::SDN::Fabrics::Common::delete_node("ospf", $param);
+	    }, "delete sdn fabric node failed");
+	return undef;
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'update_fabric',
+    path => '{fabric}',
+    method => 'PUT',
+    description => 'Update SDN Fabric configuration',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    },
+	},
+    },
+    returns => {
+	type => 'null',
+    },
+    code => sub {
+	my ($param) = @_;
+
+	PVE::Network::SDN::lock_sdn_config(
+	    sub {
+		PVE::API2::Network::SDN::Fabrics::Common::edit_fabric("ospf", $param);
+	    }, "edit sdn fabric failed");
+	return undef;
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'update_node',
+    path => '{fabric}/node/{node}',
+    method => 'PUT',
+    description => 'Update SDN Fabric Interface configuration',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    },
+	    node => {
+		type => 'string',
+		description => 'The hostname of the node',
+	    },
+	    router_id => {
+		type => 'string',
+		description => 'The OSPF router_id, an IPv4 address',
+	    },
+	    interfaces => {
+		type => 'array',
+		description => 'The OSPF interfaces on this node',
+		items => {
+		    type => 'string',
+		    description => 'Propertystring of the OSPF interface',
+		    format => 'pve-sdn-ospf-interface',
+		},
+	    },
+	},
+    },
+    returns => {
+	type => 'null',
+    },
+    code => sub {
+	my ($param) = @_;
+
+	PVE::Network::SDN::lock_sdn_config(
+	    sub {
+		PVE::API2::Network::SDN::Fabrics::Common::edit_node("ospf", $param);
+	    }, "edit sdn fabric node failed");
+	return undef;
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'get_fabric',
+    path => '{fabric}',
+    method => 'GET',
+    description => 'Get SDN Fabric configuration',
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    }
+	},
+    },
+    returns => {
+	type => 'object',
+	properties => {
+	    fabric => {
+		type => 'object',
+		description => 'The fabric object',
+		properties => {
+		    name => {
+			type => 'string',
+			description => 'The fabric id',
+		    },
+		    loopback_prefix => {
+			type => 'string',
+			description => 'The IP prefix for Loopback IPs',
+		    },
+		}
+	    }
+	}
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return PVE::API2::Network::SDN::Fabrics::Common::get_fabric("ospf", $param);
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'get_node',
+    path => '{fabric}/node/{node}',
+    method => 'GET',
+    description => 'Get SDN Fabric Node configuration',
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    },
+	    node => {
+		type => 'string',
+		description => 'The hostname of the node',
+	    },
+	},
+    },
+    returns => {
+	type => 'object',
+	properties => {
+	    node => {
+		type => 'object',
+		description => 'The node object',
+		properties => {
+		    router_id => {
+			type => 'string',
+			description => 'The OSPF router_id of the node',
+		    },
+		    node => {
+			type => 'string',
+			description => 'The hostname of the node',
+		    },
+		    interface => {
+			type => 'array',
+			description => 'The OSPF interfaces on this node',
+			items => {
+			    description => 'Propertystring of the OSPF interface',
+			    type => 'string',
+			    format => 'pve-sdn-ospf-interface',
+			}
+		    },
+		}
+	    }
+	}
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return PVE::API2::Network::SDN::Fabrics::Common::get_node("ospf", $param);
+    },
+});
+
+
+__PACKAGE__->register_method({
+    name => 'add_fabric',
+    path => '/',
+    method => 'POST',
+    description => 'Create SDN Fabric configuration',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    area => {
+		type => 'string',
+		description => 'The fabric area',
+	    },
+	    loopback_prefix => {
+		type => 'string',
+		description => 'The IP prefix for Loopback IPs',
+	    },
+	},
+    },
+    returns => {
+	type => 'null',
+    },
+    code => sub {
+	my ($param) = @_;
+
+	PVE::Network::SDN::lock_sdn_config(
+	    sub {
+		PVE::API2::Network::SDN::Fabrics::Common::add_fabric("ospf", $param);
+	    }, "add sdn fabric failed");
+	return undef;
+    },
+});
+
+__PACKAGE__->register_method({
+    name => 'add_node',
+    path => '{fabric}/node/{node}',
+    method => 'POST',
+    description => 'Create SDN Fabric Node configuration',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/sdn/fabrics/ospf/{fabric}/node/{node}', [ 'SDN.Allocate' ]],
+    },
+    parameters => {
+	properties => {
+	    fabric => {
+		type => 'string',
+		description => 'The fabric id',
+	    },
+	    node => {
+		type => 'string',
+		description => 'The hostname of the node',
+	    },
+	    router_id => {
+		type => 'string',
+		description => 'The OSPF router_id of this node',
+	    },
+	    interfaces => {
+		type => 'array',
+		description => 'The OSPF intefaces on this node',
+		items => {
+		    type => 'string',
+		    description => 'Propertystring of the  OSPF inteface',
+		    format => 'pve-sdn-ospf-interface',
+		},
+	    },
+	},
+    },
+    returns => {
+	type => 'null',
+    },
+    code => sub {
+	my ($param) = @_;
+
+	PVE::Network::SDN::lock_sdn_config(
+	    sub {
+		PVE::API2::Network::SDN::Fabrics::Common::add_node("ospf", $param);
+	    }, "add sdn fabric node failed");
+	return undef;
+    },
+});
+
+
+1;
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2025-03-28 17:22 UTC|newest]

Thread overview: 96+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-28 17:12 [pve-devel] [PATCH cluster/docs/manager/network/proxmox{, -ve-rs, -firewall, -perl-rs} 00/52] Add SDN Fabrics Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox 1/1] serde: add string_as_bool module for boolean string parsing Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 01/17] add proxmox-network-types crate Gabriel Goller
2025-03-31 14:09   ` Thomas Lamprecht
2025-03-31 14:38     ` Stefan Hanreich
2025-03-31 16:20       ` Thomas Lamprecht
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 02/17] network-types: add common hostname and openfabric types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 03/17] network-types: add openfabric NET type Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 04/17] network-types: move Ipv4Cidr and Ipv6Cidr types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 05/17] frr: create proxmox-frr crate Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 06/17] frr: add common frr types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 07/17] frr: add openfabric types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 08/17] frr: add ospf types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 09/17] frr: add route-map types Gabriel Goller
2025-03-28 17:12 ` [pve-devel] [PATCH proxmox-ve-rs 10/17] frr: add generic types over openfabric and ospf Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 11/17] frr: add serializer for all FRR types Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 12/17] ve-config: add openfabric section-config Gabriel Goller
2025-03-31 13:48   ` Christoph Heiss
2025-03-31 15:04     ` Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 13/17] ve-config: add ospf section-config Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 14/17] ve-config: add FRR conversion helpers for openfabric and ospf Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 15/17] ve-config: add validation for section-config Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 16/17] ve-config: add section-config to frr types conversion Gabriel Goller
2025-03-31 13:51   ` Christoph Heiss
2025-03-31 14:31     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-ve-rs 17/17] ve-config: add integrations tests Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-firewall 1/1] firewall: nftables: migrate to proxmox-network-types Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 1/7] perl-rs: sdn: initial fabric infrastructure Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 2/7] perl-rs: sdn: add CRUD helpers for OpenFabric fabric management Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 3/7] perl-rs: sdn: OpenFabric perlmod methods Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 4/7] perl-rs: sdn: implement OSPF interface file configuration generation Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 5/7] perl-rs: sdn: add CRUD helpers for OSPF fabric management Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 6/7] perl-rs: sdn: OSPF perlmod methods Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH proxmox-perl-rs 7/7] perl-rs: sdn: implement OSPF interface file configuration generation Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-cluster 1/1] cluster: add sdn fabrics config files Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 01/17] sdn: fix value returned by pending_config Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 02/17] debian: add dependency to proxmox-perl-rs Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 03/17] fabrics: add fabrics module Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 04/17] refactor: controller: move frr methods into helper Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 05/17] controllers: implement new api for frr config generation Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 06/17] sdn: add frr config generation helper Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 07/17] test: isis: add test for standalone configuration Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 08/17] sdn: frr: add daemon status to frr helper Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-04-02 10:50     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 09/17] sdn: running: apply fabrics config Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-04-02 12:26     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 10/17] fabrics: generate ifupdown configuration Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 11/17] api: add fabrics subfolder Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-04-02 12:20     ` Stefan Hanreich
2025-04-02 12:29       ` Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 12/17] api: fabrics: add common helpers Gabriel Goller
2025-04-02 10:41   ` Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 13/17] fabric: openfabric: add api endpoints Gabriel Goller
2025-04-02 10:37   ` Fabian Grünbichler
2025-03-28 17:13 ` Gabriel Goller [this message]
2025-04-02 10:37   ` [pve-devel] [PATCH pve-network 14/17] fabric: ospf: " Fabian Grünbichler
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 15/17] test: fabrics: add test cases for ospf and openfabric + evpn Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 16/17] frr: bump frr config version to 10.2.1 Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-network 17/17] frr: fix reloading frr configuration Gabriel Goller
2025-04-02 10:37   ` Fabian Grünbichler
2025-04-02 10:42     ` Stefan Hanreich
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 1/7] api: use new generalized frr and etc network config helper functions Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 2/7] fabrics: add common interface panel Gabriel Goller
2025-04-02  9:26   ` Friedrich Weber
2025-04-02 10:04     ` Gabriel Goller
2025-04-02 10:10       ` Friedrich Weber
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 3/7] fabrics: add additional interface fields for openfabric and ospf Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 4/7] fabrics: add FabricEdit components Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 5/7] fabrics: add NodeEdit components Gabriel Goller
2025-04-03  9:16   ` Christoph Heiss
2025-04-04 15:45     ` Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 6/7] fabrics: Add main FabricView Gabriel Goller
2025-04-02  9:26   ` Friedrich Weber
2025-04-02  9:50   ` Christoph Heiss
2025-04-02 10:40     ` Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-manager 7/7] utils: avoid line-break in pending changes message Gabriel Goller
2025-03-28 17:13 ` [pve-devel] [PATCH pve-docs 1/1] fabrics: add initial documentation for sdn fabrics Gabriel Goller
2025-03-31  8:44   ` Shannon Sterz
2025-03-31 12:24     ` Gabriel Goller
2025-04-02  8:43       ` Gabriel Goller
2025-04-02  8:49   ` Christoph Heiss
2025-04-02  9:09     ` Gabriel Goller
2025-04-02  9:16       ` Christoph Heiss
2025-04-03  8:30 ` [pve-devel] [PATCH cluster/docs/manager/network/proxmox{, -ve-rs, -firewall, -perl-rs} 00/52] Add SDN Fabrics Friedrich Weber
2025-04-03 10:21   ` Gabriel Goller
2025-04-03 13:44     ` Friedrich Weber
2025-04-03 14:03       ` Stefan Hanreich
2025-04-03 14:20         ` Friedrich Weber
2025-04-04  7:53           ` Stefan Hanreich
2025-04-04 10:55 ` Hannes Duerr
2025-04-04 12:48   ` Gabriel Goller
2025-04-04 12:53     ` Hannes Duerr
2025-04-04 14:26       ` Gabriel Goller

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=20250328171340.885413-42-g.goller@proxmox.com \
    --to=g.goller@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