[pve-devel] [PATCH pve-network 14/17] fabric: ospf: add api endpoints

Gabriel Goller g.goller at proxmox.com
Fri Mar 28 18:13:29 CET 2025


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

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

Signed-off-by: Stefan Hanreich <s.hanreich at proxmox.com>
Co-authored-by: Gabriel Goller <g.goller at proxmox.com>
Signed-off-by: Gabriel Goller <g.goller at 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





More information about the pve-devel mailing list