use strict;
use warnings;
-use PVE::SafeSyslog;
-use PVE::Storage;
-use PVE::Storage::LVMPlugin;
-use HTTP::Status qw(:constants);
-use PVE::JSONSchema qw(get_standard_option);
+# NOTE: This API endpoints are mounted by pve-manager's API2::Node module and pvesm CLI
+use PVE::JSONSchema qw(get_standard_option);
use PVE::RESTHandler;
+use PVE::SafeSyslog;
+use PVE::Storage::LVMPlugin;
+use PVE::Storage;
+use PVE::SysFSTools;
use base qw(PVE::RESTHandler);
-__PACKAGE__->register_method ({
- name => 'index',
- path => '',
+__PACKAGE__->register_method({
+ name => 'nfsscan',
+ path => 'nfs',
method => 'GET',
- description => "Index of available scan methods",
- permissions => {
- user => 'all',
- },
- parameters => {
- additionalProperties => 0,
- properties => {
- node => get_standard_option('pve-node'),
- },
- },
- returns => {
- type => 'array',
- items => {
- type => "object",
- properties => { method => { type => 'string'} },
- },
- links => [ { rel => 'child', href => "{method}" } ],
- },
- code => sub {
- my ($param) = @_;
-
- my $res = [
- { method => 'lvm' },
- { method => 'iscsi' },
- { method => 'nfs' },
- { method => 'glusterfs' },
- { method => 'usb' },
- { method => 'zfs' },
- ];
-
- return $res;
- }});
-
-__PACKAGE__->register_method ({
- name => 'zfsscan',
- path => 'zfs',
- method => 'GET',
- description => "Scan zfs pool list on local node.",
+ description => "Scan remote NFS server.",
protected => 1,
proxyto => "node",
- permissions => {
+ permissions => {
check => ['perm', '/storage', ['Datastore.Allocate']],
},
parameters => {
- additionalProperties => 0,
+ additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
+ server => {
+ description => "The server address (name or IP).",
+ type => 'string', format => 'pve-storage-server',
+ },
},
},
returns => {
type => 'array',
items => {
type => "object",
- properties => {
- pool => { type => 'string'},
+ properties => {
+ path => {
+ description => "The exported path.",
+ type => 'string',
+ },
+ options => {
+ description => "NFS export options.",
+ type => 'string',
+ },
},
},
},
code => sub {
my ($param) = @_;
- return PVE::Storage::scan_zfs();
+ my $server = $param->{server};
+ my $res = PVE::Storage::scan_nfs($server);
+
+ my $data = [];
+ foreach my $k (sort keys %$res) {
+ push @$data, { path => $k, options => $res->{$k} };
+ }
+ return $data;
}});
-__PACKAGE__->register_method ({
- name => 'nfsscan',
- path => 'nfs',
+__PACKAGE__->register_method({
+ name => 'cifsscan',
+ path => 'cifs',
method => 'GET',
- description => "Scan remote NFS server.",
+ description => "Scan remote CIFS server.",
protected => 1,
proxyto => "node",
- permissions => {
+ permissions => {
check => ['perm', '/storage', ['Datastore.Allocate']],
},
parameters => {
- additionalProperties => 0,
+ additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
- server => { type => 'string', format => 'pve-storage-server' },
+ server => {
+ description => "The server address (name or IP).",
+ type => 'string', format => 'pve-storage-server',
+ },
+ username => {
+ description => "User name.",
+ type => 'string',
+ optional => 1,
+ },
+ password => {
+ description => "User password.",
+ type => 'string',
+ optional => 1,
+ },
+ domain => {
+ description => "SMB domain (Workgroup).",
+ type => 'string',
+ optional => 1,
+ },
},
},
returns => {
type => 'array',
items => {
type => "object",
- properties => {
- path => { type => 'string'},
- options => { type => 'string'},
+ properties => {
+ share => {
+ description => "The cifs share name.",
+ type => 'string',
+ },
+ description => {
+ description => "Descriptive text from server.",
+ type => 'string',
+ },
},
},
},
my ($param) = @_;
my $server = $param->{server};
- my $res = PVE::Storage::scan_nfs($server);
+
+ my $username = $param->{username};
+ my $password = $param->{password};
+ my $domain = $param->{domain};
+
+ my $res = PVE::Storage::scan_cifs($server, $username, $password, $domain);
my $data = [];
- foreach my $k (keys %$res) {
- push @$data, { path => $k, options => $res->{$k} };
+ foreach my $k (sort keys %$res) {
+ next if $k =~ m/NT_STATUS_/;
+ push @$data, { share => $k, description => $res->{$k} };
}
+
return $data;
}});
# Note: GlusterFS currently does not have an equivalent of showmount.
-# As workaround, we simply use nfs showmount.
+# As workaround, we simply use nfs showmount.
# see http://www.gluster.org/category/volumes/
-
-__PACKAGE__->register_method ({
- name => 'glusterfsscan',
- path => 'glusterfs',
+__PACKAGE__->register_method({
+ name => 'glusterfsscan',
+ path => 'glusterfs',
method => 'GET',
description => "Scan remote GlusterFS server.",
protected => 1,
proxyto => "node",
- permissions => {
+ permissions => {
check => ['perm', '/storage', ['Datastore.Allocate']],
},
parameters => {
- additionalProperties => 0,
+ additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
- server => { type => 'string', format => 'pve-storage-server' },
+ server => {
+ description => "The server address (name or IP).",
+ type => 'string', format => 'pve-storage-server',
+ },
},
},
returns => {
type => 'array',
items => {
type => "object",
- properties => {
- volname => { type => 'string'},
+ properties => {
+ volname => {
+ description => "The volume name.",
+ type => 'string',
+ },
},
},
},
my $res = PVE::Storage::scan_nfs($server);
my $data = [];
- foreach my $path (keys %$res) {
+ foreach my $path (sort keys %$res) {
if ($path =~ m!^/([^\s/]+)$!) {
push @$data, { volname => $1 };
}
return $data;
}});
-__PACKAGE__->register_method ({
- name => 'iscsiscan',
- path => 'iscsi',
+__PACKAGE__->register_method({
+ name => 'iscsiscan',
+ path => 'iscsi',
method => 'GET',
description => "Scan remote iSCSI server.",
protected => 1,
proxyto => "node",
- permissions => {
+ permissions => {
check => ['perm', '/storage', ['Datastore.Allocate']],
},
parameters => {
- additionalProperties => 0,
+ additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
- portal => { type => 'string', format => 'pve-storage-portal-dns' },
+ portal => {
+ description => "The iSCSI portal (IP or DNS name with optional port).",
+ type => 'string', format => 'pve-storage-portal-dns',
+ },
},
},
returns => {
type => 'array',
items => {
type => "object",
- properties => {
- target => { type => 'string'},
- portal => { type => 'string'},
+ properties => {
+ target => {
+ description => "The iSCSI target name.",
+ type => 'string',
+ },
+ portal => {
+ description => "The iSCSI portal name.",
+ type => 'string',
+ },
},
},
},
my $res = PVE::Storage::scan_iscsi($param->{portal});
my $data = [];
- foreach my $k (keys %$res) {
+ foreach my $k (sort keys %$res) {
push @$data, { target => $k, portal => join(',', @{$res->{$k}}) };
}
return $data;
}});
-__PACKAGE__->register_method ({
- name => 'lvmscan',
- path => 'lvm',
+__PACKAGE__->register_method({
+ name => 'lvmscan',
+ path => 'lvm',
method => 'GET',
description => "List local LVM volume groups.",
protected => 1,
proxyto => "node",
- permissions => {
+ permissions => {
check => ['perm', '/storage', ['Datastore.Allocate']],
},
parameters => {
- additionalProperties => 0,
+ additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
},
type => 'array',
items => {
type => "object",
- properties => {
- vg => { type => 'string'},
+ properties => {
+ vg => {
+ description => "The LVM logical volume group name.",
+ type => 'string',
+ },
},
},
},
return PVE::RESTHandler::hash_to_array($res, 'vg');
}});
-__PACKAGE__->register_method ({
+__PACKAGE__->register_method({
name => 'lvmthinscan',
path => 'lvmthin',
method => 'GET',
items => {
type => "object",
properties => {
- lv => { type => 'string'},
+ lv => {
+ description => "The LVM Thin Pool name (LVM logical volume).",
+ type => 'string',
+ },
},
},
},
return PVE::Storage::LvmThinPlugin::list_thinpools($param->{vg});
}});
-__PACKAGE__->register_method ({
- name => 'usbscan',
- path => 'usb',
+__PACKAGE__->register_method({
+ name => 'zfsscan',
+ path => 'zfs',
method => 'GET',
- description => "List local USB devices.",
+ description => "Scan zfs pool list on local node.",
protected => 1,
proxyto => "node",
- permissions => {
- check => ['perm', '/', ['Sys.Modify']],
+ permissions => {
+ check => ['perm', '/storage', ['Datastore.Allocate']],
},
parameters => {
- additionalProperties => 0,
+ additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
},
type => 'array',
items => {
type => "object",
- properties => {
- busnum => { type => 'integer'},
- devnum => { type => 'integer'},
- port => { type => 'integer'},
- usbpath => { type => 'string', optional => 1},
- level => { type => 'integer'},
- class => { type => 'integer'},
- vendid => { type => 'string'},
- prodid => { type => 'string'},
- speed => { type => 'string'},
-
- product => { type => 'string', optional => 1 },
- serial => { type => 'string', optional => 1 },
- manufacturer => { type => 'string', optional => 1 },
+ properties => {
+ pool => {
+ description => "ZFS pool name.",
+ type => 'string',
+ },
},
},
},
code => sub {
my ($param) = @_;
- return PVE::Storage::scan_usb();
+ return PVE::Storage::scan_zfs();
}});
-
-1;
projects / pve-storage.git / blobdiff