api: add usb list in hardware endpoint

As envisioned in[0][1], better late than never.

[0]: commit 523d5f486b
[1]: https://lists.proxmox.com/pipermail/pve-devel/2018-November/034694.html

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2020-12-02 11:26:57 +01:00
parent d6441a5d87
commit 1c182fc59f
3 changed files with 63 additions and 2 deletions

View File

@ -7,6 +7,7 @@ use PVE::JSONSchema qw(get_standard_option);
use PVE::RESTHandler; use PVE::RESTHandler;
use PVE::API2::Hardware::PCI; use PVE::API2::Hardware::PCI;
use PVE::API2::Hardware::USB;
use base qw(PVE::RESTHandler); use base qw(PVE::RESTHandler);
@ -15,6 +16,12 @@ __PACKAGE__->register_method ({
path => 'pci', path => 'pci',
}); });
__PACKAGE__->register_method ({
subclass => "PVE::API2::Hardware::USB",
path => 'usb',
});
__PACKAGE__->register_method ({ __PACKAGE__->register_method ({
name => 'index', name => 'index',
path => '', path => '',
@ -42,7 +49,7 @@ __PACKAGE__->register_method ({
my $res = [ my $res = [
{ type => 'pci' }, { type => 'pci' },
# TODO: move usb scan here (6.0 api change) { type => 'usb' },
]; ];
return $res; return $res;

View File

@ -1,7 +1,8 @@
include ../../../defines.mk include ../../../defines.mk
PERLSOURCE= \ PERLSOURCE= \
PCI.pm PCI.pm \
USB.pm \
all: all:

53
PVE/API2/Hardware/USB.pm Normal file
View File

@ -0,0 +1,53 @@
package PVE::API2::Hardware::USB;
use strict;
use warnings;
use PVE::JSONSchema qw(get_standard_option);
use PVE::SysFSTools;
use base qw(PVE::RESTHandler);
__PACKAGE__->register_method({
name => 'usbscan',
path => '',
method => 'GET',
description => "List local USB devices.",
protected => 1,
proxyto => "node",
permissions => {
check => ['perm', '/', ['Sys.Modify']],
},
parameters => {
additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
},
},
returns => {
type => 'array',
items => {
type => "object",
properties => {
busnum => { type => 'integer'},
class => { type => 'integer'},
devnum => { type => 'integer'},
level => { type => 'integer'},
manufacturer => { type => 'string', optional => 1 },
port => { type => 'integer'},
prodid => { type => 'string'},
product => { type => 'string', optional => 1 },
serial => { type => 'string', optional => 1 },
speed => { type => 'string'},
usbpath => { type => 'string', optional => 1},
vendid => { type => 'string'},
},
},
},
code => sub {
my ($param) = @_;
return PVE::SysFSTools::scan_usb();
}
});