[pve-devel] [PATCH storage 1/3] move Scan API calls from PVE/API2/Storage/Scan.pm to pvesm.pm

Dominik Csapak d.csapak at proxmox.com
Fri Nov 16 16:17:57 CET 2018


since the calls for the real API are defined now in pve-managers Scan.pm

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 PVE/API2/Storage/Scan.pm | 328 --------------------------------------------
 PVE/CLI/pvesm.pm         | 343 +++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 335 insertions(+), 336 deletions(-)

diff --git a/PVE/API2/Storage/Scan.pm b/PVE/API2/Storage/Scan.pm
index 4ff023e..4ad24a5 100644
--- a/PVE/API2/Storage/Scan.pm
+++ b/PVE/API2/Storage/Scan.pm
@@ -52,334 +52,6 @@ __PACKAGE__->register_method ({
     }});
 
 __PACKAGE__->register_method ({
-    name => 'zfsscan', 
-    path => 'zfs', 
-    method => 'GET',
-    description => "Scan zfs pool list on local node.",
-    protected => 1,
-    proxyto => "node",
-    permissions => { 
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-    	additionalProperties => 0,
-	properties => {
-	    node => get_standard_option('pve-node'),
-	},
-    },
-    returns => {
-	type => 'array',
-	items => {
-	    type => "object",
-	    properties => { 
-		pool => {
-		    description => "ZFS pool name.",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	return PVE::Storage::scan_zfs();
-    }});
-
-__PACKAGE__->register_method ({
-    name => 'nfsscan', 
-    path => 'nfs', 
-    method => 'GET',
-    description => "Scan remote NFS server.",
-    protected => 1,
-    proxyto => "node",
-    permissions => { 
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-    	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 => { 
-		path => {
-		    description => "The exported path.",
-		    type => 'string',
-		},
-		options => {
-		    description => "NFS export options.",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	my $server = $param->{server};
-	my $res = PVE::Storage::scan_nfs($server);
-
-	my $data = [];
-	foreach my $k (keys %$res) {
-	    push @$data, { path => $k, options => $res->{$k} };
-	}
-	return $data;
-    }});
-
-__PACKAGE__->register_method ({
-    name => 'cifsscan',
-    path => 'cifs',
-    method => 'GET',
-    description => "Scan remote CIFS server.",
-    protected => 1,
-    proxyto => "node",
-    permissions => {
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-	additionalProperties => 0,
-	properties => {
-	    node => get_standard_option('pve-node'),
-	    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 => {
-		share => {
-		    description => "The cifs share name.",
-		    type => 'string',
-		},
-		description => {
-		    description => "Descriptive text from server.",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	my $server = $param->{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) {
-	    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. 
-# see http://www.gluster.org/category/volumes/
-
-__PACKAGE__->register_method ({
-    name => 'glusterfsscan', 
-    path => 'glusterfs', 
-    method => 'GET',
-    description => "Scan remote GlusterFS server.",
-    protected => 1,
-    proxyto => "node",
-    permissions => { 
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-    	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 => { 
-		volname => {
-		    description => "The volume name.",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	my $server = $param->{server};
-	my $res = PVE::Storage::scan_nfs($server);
-
-	my $data = [];
-	foreach my $path (keys %$res) {
-	    if ($path =~ m!^/([^\s/]+)$!) {
-		push @$data, { volname => $1 };
-	    }
-	}
-	return $data;
-    }});
-
-__PACKAGE__->register_method ({
-    name => 'iscsiscan', 
-    path => 'iscsi', 
-    method => 'GET',
-    description => "Scan remote iSCSI server.",
-    protected => 1,
-    proxyto => "node",
-    permissions => { 
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-    	additionalProperties => 0,
-	properties => {
-	    node => get_standard_option('pve-node'),
-	    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 => {
-		    description => "The iSCSI target name.",
-		    type => 'string',
-		},
-		portal => {
-		    description => "The iSCSI portal name.",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	my $res = PVE::Storage::scan_iscsi($param->{portal});
-
-	my $data = [];
-	foreach my $k (keys %$res) {
-	    push @$data, { target => $k, portal => join(',', @{$res->{$k}}) };
-	}
-
-	return $data;
-    }});
-
-__PACKAGE__->register_method ({
-    name => 'lvmscan', 
-    path => 'lvm', 
-    method => 'GET',
-    description => "List local LVM volume groups.",
-    protected => 1,
-    proxyto => "node",
-    permissions => { 
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-    	additionalProperties => 0,
-	properties => {
-	    node => get_standard_option('pve-node'),
-	},
-    },
-    returns => {
-	type => 'array',
-	items => {
-	    type => "object",
-	    properties => {
-		vg => {
-		    description => "The LVM logical volume group name.",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	my $res = PVE::Storage::LVMPlugin::lvm_vgs();
-	return PVE::RESTHandler::hash_to_array($res, 'vg');
-    }});
-
-__PACKAGE__->register_method ({
-    name => 'lvmthinscan',
-    path => 'lvmthin',
-    method => 'GET',
-    description => "List local LVM Thin Pools.",
-    protected => 1,
-    proxyto => "node",
-    permissions => {
-	check => ['perm', '/storage', ['Datastore.Allocate']],
-    },
-    parameters => {
-	additionalProperties => 0,
-	properties => {
-	    node => get_standard_option('pve-node'),
-	    vg => {
-		type => 'string',
-		pattern => '[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+', # see lvm(8) manpage
-		maxLength => 100,
-	    },
-	},
-    },
-    returns => {
-	type => 'array',
-	items => {
-	    type => "object",
-	    properties => {
-		lv => {
-		    description => "The LVM Thin Pool name (LVM logical volume).",
-		    type => 'string',
-		},
-	    },
-	},
-    },
-    code => sub {
-	my ($param) = @_;
-
-	return PVE::Storage::LvmThinPlugin::list_thinpools($param->{vg});
-    }});
-
-__PACKAGE__->register_method ({
     name => 'usbscan', 
     path => 'usb', 
     method => 'GET',
diff --git a/PVE/CLI/pvesm.pm b/PVE/CLI/pvesm.pm
index 650288e..5967573 100755
--- a/PVE/CLI/pvesm.pm
+++ b/PVE/CLI/pvesm.pm
@@ -15,7 +15,6 @@ use PVE::Storage;
 use PVE::API2::Storage::Config;
 use PVE::API2::Storage::Content;
 use PVE::API2::Storage::Status;
-use PVE::API2::Storage::Scan;
 use PVE::JSONSchema qw(get_standard_option);
 use PVE::PTY;
 
@@ -321,6 +320,334 @@ __PACKAGE__->register_method ({
     }
 });
 
+__PACKAGE__->register_method ({
+    name => 'nfsscan',
+    path => 'nfs',
+    method => 'GET',
+    description => "Scan remote NFS server.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	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 => {
+		path => {
+		    description => "The exported path.",
+		    type => 'string',
+		},
+		options => {
+		    description => "NFS export options.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	my $server = $param->{server};
+	my $res = PVE::Storage::scan_nfs($server);
+
+	my $data = [];
+	foreach my $k (keys %$res) {
+	    push @$data, { path => $k, options => $res->{$k} };
+	}
+	return $data;
+    }});
+
+__PACKAGE__->register_method ({
+    name => 'cifsscan',
+    path => 'cifs',
+    method => 'GET',
+    description => "Scan remote CIFS server.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    node => get_standard_option('pve-node'),
+	    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 => {
+		share => {
+		    description => "The cifs share name.",
+		    type => 'string',
+		},
+		description => {
+		    description => "Descriptive text from server.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	my $server = $param->{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) {
+	    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.
+# see http://www.gluster.org/category/volumes/
+
+__PACKAGE__->register_method ({
+    name => 'glusterfsscan',
+    path => 'glusterfs',
+    method => 'GET',
+    description => "Scan remote GlusterFS server.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	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 => { 
+		volname => {
+		    description => "The volume name.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	my $server = $param->{server};
+	my $res = PVE::Storage::scan_nfs($server);
+
+	my $data = [];
+	foreach my $path (keys %$res) {
+	    if ($path =~ m!^/([^\s/]+)$!) {
+		push @$data, { volname => $1 };
+	    }
+	}
+	return $data;
+    }});
+
+__PACKAGE__->register_method ({
+    name => 'iscsiscan',
+    path => 'iscsi',
+    method => 'GET',
+    description => "Scan remote iSCSI server.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    node => get_standard_option('pve-node'),
+	    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 => {
+		    description => "The iSCSI target name.",
+		    type => 'string',
+		},
+		portal => {
+		    description => "The iSCSI portal name.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	my $res = PVE::Storage::scan_iscsi($param->{portal});
+
+	my $data = [];
+	foreach my $k (keys %$res) {
+	    push @$data, { target => $k, portal => join(',', @{$res->{$k}}) };
+	}
+
+	return $data;
+    }});
+
+__PACKAGE__->register_method ({
+    name => 'lvmscan',
+    path => 'lvm',
+    method => 'GET',
+    description => "List local LVM volume groups.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    node => get_standard_option('pve-node'),
+	},
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => "object",
+	    properties => {
+		vg => {
+		    description => "The LVM logical volume group name.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	my $res = PVE::Storage::LVMPlugin::lvm_vgs();
+	return PVE::RESTHandler::hash_to_array($res, 'vg');
+    }});
+
+__PACKAGE__->register_method ({
+    name => 'lvmthinscan',
+    path => 'lvmthin',
+    method => 'GET',
+    description => "List local LVM Thin Pools.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    node => get_standard_option('pve-node'),
+	    vg => {
+		type => 'string',
+		pattern => '[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+', # see lvm(8) manpage
+		maxLength => 100,
+	    },
+	},
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => "object",
+	    properties => {
+		lv => {
+		    description => "The LVM Thin Pool name (LVM logical volume).",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return PVE::Storage::LvmThinPlugin::list_thinpools($param->{vg});
+    }});
+
+__PACKAGE__->register_method ({
+    name => 'zfsscan',
+    path => 'zfs',
+    method => 'GET',
+    description => "Scan zfs pool list on local node.",
+    protected => 1,
+    proxyto => "node",
+    permissions => {
+	check => ['perm', '/storage', ['Datastore.Allocate']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    node => get_standard_option('pve-node'),
+	},
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => "object",
+	    properties => {
+		pool => {
+		    description => "ZFS pool name.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return PVE::Storage::scan_zfs();
+    }});
+
 our $cmddef = {
     add => [ "PVE::API2::Storage::Config", 'create', ['type', 'storage'] ],
     set => [ "PVE::API2::Storage::Config", 'update', ['storage'] ],
@@ -336,7 +663,7 @@ our $cmddef = {
 	       }],
     free => [ "PVE::API2::Storage::Content", 'delete', ['volume'],
 	      { node => $nodename } ],
-    nfsscan => [ "PVE::API2::Storage::Scan", 'nfsscan', ['server'],
+    nfsscan => [ __PACKAGE__, 'nfsscan', ['server'],
 		 { node => $nodename }, sub  {
 		     my $res = shift;
 
@@ -349,7 +676,7 @@ our $cmddef = {
 			 printf "%-${maxlen}s %s\n", $rec->{path}, $rec->{options};
 		     }
 		 }],
-    cifsscan => [ "PVE::API2::Storage::Scan", 'cifsscan', ['server'],
+    cifsscan => [ __PACKAGE__, 'cifsscan', ['server'],
 		 { node => $nodename }, sub  {
 		     my $res = shift;
 
@@ -362,7 +689,7 @@ our $cmddef = {
 			 printf "%-${maxlen}s %s\n", $rec->{share}, $rec->{description};
 		     }
 		 }],
-    glusterfsscan => [ "PVE::API2::Storage::Scan", 'glusterfsscan', ['server'],
+    glusterfsscan => [ __PACKAGE__, 'glusterfsscan', ['server'],
 		 { node => $nodename }, sub  {
 		     my $res = shift;
 
@@ -370,7 +697,7 @@ our $cmddef = {
 			 printf "%s\n", $rec->{volname};
 		     }
 		 }],
-    iscsiscan => [ "PVE::API2::Storage::Scan", 'iscsiscan', ['portal'],
+    iscsiscan => [ __PACKAGE__, 'iscsiscan', ['portal'],
 		   { node => $nodename }, sub  {
 		       my $res = shift;
 
@@ -383,21 +710,21 @@ our $cmddef = {
 			   printf "%-${maxlen}s %s\n", $rec->{target}, $rec->{portal};
 		       }
 		   }],
-    lvmscan => [ "PVE::API2::Storage::Scan", 'lvmscan', [],
+    lvmscan => [ __PACKAGE__, 'lvmscan', [],
 		 { node => $nodename }, sub  {
 		     my $res = shift;
 		     foreach my $rec (@$res) {
 			 printf "$rec->{vg}\n";
 		     }
 		 }],
-    lvmthinscan => [ "PVE::API2::Storage::Scan", 'lvmthinscan', ['vg'],
+    lvmthinscan => [ __PACKAGE__, 'lvmthinscan', ['vg'],
 		 { node => $nodename }, sub  {
 		     my $res = shift;
 		     foreach my $rec (@$res) {
 			 printf "$rec->{lv}\n";
 		     }
 		 }],
-    zfsscan => [ "PVE::API2::Storage::Scan", 'zfsscan', [],
+    zfsscan => [ __PACKAGE__, 'zfsscan', [],
 		 { node => $nodename }, sub  {
 		     my $res = shift;
 
-- 
2.11.0





More information about the pve-devel mailing list