this is a cluster wide api call that returns the list of mappings
in a manner that is easy to consume by the ui (as a tree)
it also automatically includes the validity of mappings on the node
where it is called.
for a consumer of this api call to get a complete picture, it is
necessary to do an api call for each node
Signed-off-by: Dominik Csapak <d.csa...@proxmox.com>
---
PVE/API2/Cluster.pm | 8 +++
PVE/API2/Cluster/Hardware.pm | 117 +++++++++++++++++++++++++++++++++++
PVE/API2/Cluster/Makefile | 1 +
3 files changed, 126 insertions(+)
create mode 100644 PVE/API2/Cluster/Hardware.pm
diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm
index 525a95a1..8954d040 100644
--- a/PVE/API2/Cluster.pm
+++ b/PVE/API2/Cluster.pm
@@ -25,6 +25,7 @@ use PVE::API2::ACMEPlugin;
use PVE::API2::Backup;
use PVE::API2::Cluster::BackupInfo;
use PVE::API2::Cluster::Ceph;
+use PVE::API2::Cluster::Hardware;
use PVE::API2::Cluster::Jobs;
use PVE::API2::Cluster::MetricServer;
use PVE::API2::ClusterConfig;
@@ -89,6 +90,12 @@ __PACKAGE__->register_method ({
subclass => "PVE::API2::Cluster::Jobs",
path => 'jobs',
});
+
+__PACKAGE__->register_method ({
+ subclass => "PVE::API2::Cluster::Hardware",
+ path => 'hardware',
+});
+
if ($have_sdn) {
__PACKAGE__->register_method ({
subclass => "PVE::API2::Network::SDN",
@@ -138,6 +145,7 @@ __PACKAGE__->register_method ({
{ name => 'firewall' },
{ name => 'ha' },
{ name => 'jobs' },
+ { name => 'hardware' },
{ name => 'log' },
{ name => 'metrics' },
{ name => 'nextid' },
diff --git a/PVE/API2/Cluster/Hardware.pm b/PVE/API2/Cluster/Hardware.pm
new file mode 100644
index 00000000..19a9ba27
--- /dev/null
+++ b/PVE/API2/Cluster/Hardware.pm
@@ -0,0 +1,117 @@
+package PVE::API2::Cluster::Hardware;
+
+use strict;
+use warnings;
+
+use PVE::HardwareMap;
+use PVE::RESTHandler;
+
+use base qw(PVE::RESTHandler);
+
+__PACKAGE__->register_method ({
+ name => 'index',
+ path => '',
+ method => 'GET',
+ description => "Hardware index.",
+ permissions => { user => 'all' },
+ parameters => {
+ additionalProperties => 0,
+ properties => {},
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => "object",
+ properties => {},
+ },
+ links => [ { rel => 'child', href => "{name}" } ],
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $result = [
+ { name => 'mapping' },
+ ];
+
+ return $result;
+ }
+});
+
+__PACKAGE__->register_method ({
+ name => 'mapping_index',
+ path => 'mapping',
+ method => 'GET',
+ description => "List mapped hardware.",
+ permissions => {
+ description => "Only lists entries where you have 'Hardware.Audit',
'Hardware.Use', 'Hardware.Configure' permissions on '/hardware/<name>'.",
+ user => 'all',
+ },
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ node => {
+ type => 'string',
+ format => 'pve-node',
+ description => "Only show hardware mapped on this node.",
+ optional => 1,
+ }
+ },
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => "object",
+ },
+ },
+ code => sub {
+ my ($param) = @_;
+
+ my $res = [];
+ my $cfg = PVE::HardwareMap::config();
+ my $nodename = PVE::INotify::nodename();
+ my $rpcenv = PVE::RPCEnvironment::get();
+ my $authuser = $rpcenv->get_user();
+ my $privs = ['Hardware.Audit', 'Hardware.Use', 'Hardware.Configure'];
+
+ for my $type (keys %$cfg) {
+ next if $type eq 'digest';
+ for my $id (keys $cfg->{$type}->%*) {
+ next if !$rpcenv->check_hw_perm($authuser, $id, $privs, 1, 1);
+ my $id_entry = {
+ text => $id,
+ ntype => 'entry',
+ type => $type,
+ children => [],
+ };
+ for my $node (keys $cfg->{$type}->{$id}->%*) {
+ my $entry = {
+ text => $node,
+ node => $node,
+ entry => $id,
+ type => $type,
+ ntype => 'mapping',
+ };
+ for my $p (keys $cfg->{$type}->{$id}->{$node}->%*) {
+ $entry->{$p} = $cfg->{$type}->{$id}->{$node}->{$p};
+ }
+ if ($nodename eq $node) {
+ eval {
+ PVE::HardwareMap::assert_device_valid($type,
$entry);
+ };
+ if (my $err = $@) {
+ $entry->{valid} = 0;
+ $entry->{errmsg} = "$err";
+ } else {
+ $entry->{valid} = 1;
+ }
+ }
+ push $id_entry->{children}->@*, $entry;
+ }
+ push @$res, $id_entry;
+ }
+ }
+
+ return $res;
+ }});
+
+1;
diff --git a/PVE/API2/Cluster/Makefile b/PVE/API2/Cluster/Makefile
index 8d306507..2d9e2dde 100644
--- a/PVE/API2/Cluster/Makefile
+++ b/PVE/API2/Cluster/Makefile
@@ -5,6 +5,7 @@ include ../../../defines.mk
PERLSOURCE= \
BackupInfo.pm \
MetricServer.pm \
+ Hardware.pm \
Jobs.pm \
Ceph.pm
--
2.30.2
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
