[pve-storage.git] / pvesm

#!/usr/bin/perl -w

use strict;
use Getopt::Long;
use Fcntl ':flock';
use File::Path;

use PVE::SafeSyslog;
use PVE::Cluster;
use PVE::INotify;
use PVE::RPCEnvironment;
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::CLIHandler;

use base qw(PVE::CLIHandler);

$ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';

initlog ('pvesm');

die "please run as root\n" if $> != 0;

PVE::INotify::inotify_init();

my $rpcenv = PVE::RPCEnvironment->init('cli');

$rpcenv->init_request();
$rpcenv->set_language($ENV{LANG});
$rpcenv->set_user('root@pam');

__PACKAGE__->register_method ({
    name => 'path',
    path => 'path',
    method => 'GET',
    description => "Get filesystem path for specified volume",
    parameters => {
    	additionalProperties => 0,
	properties => {
	    volume => {
		description => "Volume identifier",
		type => 'string', format => 'pve-volume-id',
	    },
	},
    },
    returns => { type => 'null' },

    code => sub {
	my ($param) = @_;

	my $cfg = PVE::Storage::config();

	my $path = PVE::Storage::path ($cfg, $param->{volume});

	print "$path\n";

	return undef;

    }});

my $print_content = sub {
    my ($list) = @_;

    my $maxlenname = 0;
    foreach my $info (@$list) {

	my $volid = $info->{volid};
	my $sidlen =  length ($volid);
	$maxlenname = $sidlen if $sidlen > $maxlenname;
    }

    foreach my $info (@$list) {
	next if !$info->{vmid};
	my $volid = $info->{volid};

	printf "%-${maxlenname}s %5s %10d %d\n", $volid,
	$info->{format}, $info->{size}, $info->{vmid};
    }

    foreach my $info (sort { $a->{format} cmp $b->{format} } @$list) {
	next if $info->{vmid};
	my $volid = $info->{volid};

	printf "%-${maxlenname}s %5s %10d\n", $volid,
	$info->{format}, $info->{size};
    }
};

my $print_status = sub {
    my $res = shift;

    my $maxlen = 0;
    foreach my $res (@$res) {
	my $storeid = $res->{storage};
	$maxlen = length ($storeid) if length ($storeid) > $maxlen;
    }
    $maxlen+=1;

    foreach my $res (sort { $a->{storage} cmp $b->{storage} } @$res) {
	my $storeid = $res->{storage};

	my $sum = $res->{used} + $res->{avail};
	my $per = $sum ? (0.5 + ($res->{used}*100)/$sum) : 100;

	printf "%-${maxlen}s %5s %1d %15d %15d %15d %.2f%%\n", $storeid,
	$res->{type}, $res->{active},
	$res->{total}/1024, $res->{used}/1024, $res->{avail}/1024, $per;
    }
};

my $nodename = PVE::INotify::nodename();

my $cmddef = {
    add => [ "PVE::API2::Storage::Config", 'create', ['storage'] ],
    set => [ "PVE::API2::Storage::Config", 'update', ['storage'] ],
    remove => [ "PVE::API2::Storage::Config", 'delete', ['storage'] ],
    status => [ "PVE::API2::Storage::Status", 'index', [],
		{ node => $nodename }, $print_status ],
    list => [ "PVE::API2::Storage::Content", 'index', ['storage'],
	      { node => $nodename }, $print_content ],
    alloc => [ "PVE::API2::Storage::Content", 'create', ['storage', 'vmid', 'filename', 'size'],
	       { node => $nodename }, sub {
		   my $volid = shift;
		   print "sucessfuly created '$volid'\n";
	       }],
    free => [ "PVE::API2::Storage::Content", 'delete', ['volume'],
	      { node => $nodename } ],
    nfsscan => [ "PVE::API2::Storage::Scan", 'nfsscan', ['server'],
		 { node => $nodename }, sub  {
		     my $res = shift;

		     my $maxlen = 0;
		     foreach my $rec (@$res) {
			 my $len = length ($rec->{path});
			 $maxlen = $len if $len > $maxlen;
		     }
		     foreach my $rec (@$res) {
			 printf "%-${maxlen}s %s\n", $rec->{path}, $rec->{options};
		     }
		 }],
    iscsiscan => [ "PVE::API2::Storage::Scan", 'iscsiscan', ['server'],
		   { node => $nodename }, sub  {
		       my $res = shift;

		       my $maxlen = 0;
		       foreach my $rec (@$res) {
			   my $len = length ($rec->{target});
			   $maxlen = $len if $len > $maxlen;
		       }
		       foreach my $rec (@$res) {
			   printf "%-${maxlen}s %s\n", $rec->{target}, $rec->{portal};
		       }
		   }],
    lvmscan => [ "PVE::API2::Storage::Scan", 'lvmscan', [],
		 { node => $nodename }, sub  {
		     my $res = shift;
		     foreach my $rec (@$res) {
			 printf "$rec->{vg}\n";
		     }
		 }],
    path => [ __PACKAGE__, 'path', ['volume']],
};

my $cmd = shift;

PVE::CLIHandler::handle_cmd($cmddef, "pvesm", $cmd, \@ARGV, undef, $0);

exit 0;

__END__

=head1 NAME

pvesm - PVE Storage Manager

=head1 SYNOPSIS

=include synopsis

=head1 DESCRIPTION

=head2 Storage pools

Each storage pool is uniquely identified by its <STORAGE_ID>.

=head3 Storage content

A storage can support several content types, for example virtual disk
images, cdrom iso images, openvz templates or openvz root directories
(C<images>, C<iso>, C<vztmpl>, C<rootdir>).

=head2 Volumes

A volume is identified by the <STORAGE_ID>, followed by a storage type
dependent volume name, separated by colon. A valid <VOLUME_ID> looks like:

 local:230/example-image.raw

 local:iso/debian-501-amd64-netinst.iso

 local:vztmpl/debian-5.0-joomla_1.5.9-1_i386.tar.gz

 iscsi-storage:0.0.2.scsi-14f504e46494c4500494b5042546d2d646744372d31616d61

To get the filesystem path for a <VOLUME_ID> use:

 pvesm path <VOLUME_ID>


=head1 EXAMPLES

 # scan iscsi host for available targets
 pvesm scan iscsi <HOST[:PORT]>

 # scan nfs server for available exports
 pvesm scan nfs <HOST>

 # add storage pools
 pvesm add <STORAGE_ID> <TYPE> <OPTIONS>
 pvesm add <STORAGE_ID> dir --path <PATH>
 pvesm add <STORAGE_ID> nfs --path <PATH> --server <SERVER> --export <EXPORT>
 pvesm add <STORAGE_ID> lvm --vgname <VGNAME>
 pvesm add <STORAGE_ID> iscsi --portal <HOST[:PORT]> --target <TARGET>

 # disable storage pools
 pvesm set <STORAGE_ID> --disable 1

 # enable storage pools
 pvesm set <STORAGE_ID> --disable 0

 # change/set storage options
 pvesm set <STORAGE_ID> <OPTIONS>
 pvesm set <STORAGE_ID> --shared 1
 pvesm set local --format qcow2
 pvesm set <STORAGE_ID> --content iso

 # remove storage pools - does not delete any data
 pvesm remove <STORAGE_ID>

 # alloc volumes
 pvesm alloc <STORAGE_ID> <VMID> <name> <size> [--format <raw|qcow2>]

 # alloc 4G volume in local storage - use auto generated name
 pvesm alloc local <VMID> '' 4G

 # free volumes (warning: destroy/deletes all volume data)
 pvesm free <VOLUME_ID>

 # list storage status
 pvesm status

 # list storage contents
 pvesm list <STORAGE_ID> [--vmid <VMID>]

 # list volumes allocated by VMID
 pvesm list <STORAGE_ID> --vmid <VMID>

 # list iso images
 pvesm list <STORAGE_ID> --iso

 # list openvz templates
 pvesm list <STORAGE_ID> --vztmpl

 # show filesystem path for a volume
 pvesm path <VOLUME_ID>

=include pve_copyright
Commit	Line	Data
	1	#!/usr/bin/perl -w
	2
	3	use strict;
	4	use Getopt::Long;
	5	use Fcntl ':flock';
	6	use File::Path;
	7
	8	use PVE::SafeSyslog;
	9	use PVE::Cluster;
	10	use PVE::INotify;
	11	use PVE::RPCEnvironment;
	12	use PVE::Storage;
	13	use PVE::API2::Storage::Config;
	14	use PVE::API2::Storage::Content;
	15	use PVE::API2::Storage::Status;
	16	use PVE::API2::Storage::Scan;
	17	use PVE::JSONSchema qw(get_standard_option);
	18
	19	use PVE::CLIHandler;
	20
	21	use base qw(PVE::CLIHandler);
	22
	23	$ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
	24
	25	initlog ('pvesm');
	26
	27	die "please run as root\n" if $> != 0;
	28
	29	PVE::INotify::inotify_init();
	30
	31	my $rpcenv = PVE::RPCEnvironment->init('cli');
	32
	33	$rpcenv->init_request();
	34	$rpcenv->set_language($ENV{LANG});
	35	$rpcenv->set_user('root@pam');
	36
	37	__PACKAGE__->register_method ({
	38	name => 'path',
	39	path => 'path',
	40	method => 'GET',
	41	description => "Get filesystem path for specified volume",
	42	parameters => {
	43	additionalProperties => 0,
	44	properties => {
	45	volume => {
	46	description => "Volume identifier",
	47	type => 'string', format => 'pve-volume-id',
	48	},
	49	},
	50	},
	51	returns => { type => 'null' },
	52
	53	code => sub {
	54	my ($param) = @_;
	55
	56	my $cfg = PVE::Storage::config();
	57
	58	my $path = PVE::Storage::path ($cfg, $param->{volume});
	59
	60	print "$path\n";
	61
	62	return undef;
	63
	64	}});
	65
	66	my $print_content = sub {
	67	my ($list) = @_;
	68
	69	my $maxlenname = 0;
	70	foreach my $info (@$list) {
	71
	72	my $volid = $info->{volid};
	73	my $sidlen = length ($volid);
	74	$maxlenname = $sidlen if $sidlen > $maxlenname;
	75	}
	76
	77	foreach my $info (@$list) {
	78	next if !$info->{vmid};
	79	my $volid = $info->{volid};
	80
	81	printf "%-${maxlenname}s %5s %10d %d\n", $volid,
	82	$info->{format}, $info->{size}, $info->{vmid};
	83	}
	84
	85	foreach my $info (sort { $a->{format} cmp $b->{format} } @$list) {
	86	next if $info->{vmid};
	87	my $volid = $info->{volid};
	88
	89	printf "%-${maxlenname}s %5s %10d\n", $volid,
	90	$info->{format}, $info->{size};
	91	}
	92	};
	93
	94	my $print_status = sub {
	95	my $res = shift;
	96
	97	my $maxlen = 0;
	98	foreach my $res (@$res) {
	99	my $storeid = $res->{storage};
	100	$maxlen = length ($storeid) if length ($storeid) > $maxlen;
	101	}
	102	$maxlen+=1;
	103
	104	foreach my $res (sort { $a->{storage} cmp $b->{storage} } @$res) {
	105	my $storeid = $res->{storage};
	106
	107	my $sum = $res->{used} + $res->{avail};
	108	my $per = $sum ? (0.5 + ($res->{used}*100)/$sum) : 100;
	109
	110	printf "%-${maxlen}s %5s %1d %15d %15d %15d %.2f%%\n", $storeid,
	111	$res->{type}, $res->{active},
	112	$res->{total}/1024, $res->{used}/1024, $res->{avail}/1024, $per;
	113	}
	114	};
	115
	116	my $nodename = PVE::INotify::nodename();
	117
	118	my $cmddef = {
	119	add => [ "PVE::API2::Storage::Config", 'create', ['storage'] ],
	120	set => [ "PVE::API2::Storage::Config", 'update', ['storage'] ],
	121	remove => [ "PVE::API2::Storage::Config", 'delete', ['storage'] ],
	122	status => [ "PVE::API2::Storage::Status", 'index', [],
	123	{ node => $nodename }, $print_status ],
	124	list => [ "PVE::API2::Storage::Content", 'index', ['storage'],
	125	{ node => $nodename }, $print_content ],
	126	alloc => [ "PVE::API2::Storage::Content", 'create', ['storage', 'vmid', 'filename', 'size'],
	127	{ node => $nodename }, sub {
	128	my $volid = shift;
	129	print "sucessfuly created '$volid'\n";
	130	}],
	131	free => [ "PVE::API2::Storage::Content", 'delete', ['volume'],
	132	{ node => $nodename } ],
	133	nfsscan => [ "PVE::API2::Storage::Scan", 'nfsscan', ['server'],
	134	{ node => $nodename }, sub {
	135	my $res = shift;
	136
	137	my $maxlen = 0;
	138	foreach my $rec (@$res) {
	139	my $len = length ($rec->{path});
	140	$maxlen = $len if $len > $maxlen;
	141	}
	142	foreach my $rec (@$res) {
	143	printf "%-${maxlen}s %s\n", $rec->{path}, $rec->{options};
	144	}
	145	}],
	146	iscsiscan => [ "PVE::API2::Storage::Scan", 'iscsiscan', ['server'],
	147	{ node => $nodename }, sub {
	148	my $res = shift;
	149
	150	my $maxlen = 0;
	151	foreach my $rec (@$res) {
	152	my $len = length ($rec->{target});
	153	$maxlen = $len if $len > $maxlen;
	154	}
	155	foreach my $rec (@$res) {
	156	printf "%-${maxlen}s %s\n", $rec->{target}, $rec->{portal};
	157	}
	158	}],
	159	lvmscan => [ "PVE::API2::Storage::Scan", 'lvmscan', [],
	160	{ node => $nodename }, sub {
	161	my $res = shift;
	162	foreach my $rec (@$res) {
	163	printf "$rec->{vg}\n";
	164	}
	165	}],
	166	path => [ __PACKAGE__, 'path', ['volume']],
	167	};
	168
	169	my $cmd = shift;
	170
	171	PVE::CLIHandler::handle_cmd($cmddef, "pvesm", $cmd, \@ARGV, undef, $0);
	172
	173	exit 0;
	174
	175	__END__
	176
	177	=head1 NAME
	178
	179	pvesm - PVE Storage Manager
	180
	181	=head1 SYNOPSIS
	182
	183	=include synopsis
	184
	185	=head1 DESCRIPTION
	186
	187	=head2 Storage pools
	188
	189	Each storage pool is uniquely identified by its <STORAGE_ID>.
	190
	191	=head3 Storage content
	192
	193	A storage can support several content types, for example virtual disk
	194	images, cdrom iso images, openvz templates or openvz root directories
	195	(C<images>, C<iso>, C<vztmpl>, C<rootdir>).
	196
	197	=head2 Volumes
	198
	199	A volume is identified by the <STORAGE_ID>, followed by a storage type
	200	dependent volume name, separated by colon. A valid <VOLUME_ID> looks like:
	201
	202	local:230/example-image.raw
	203
	204	local:iso/debian-501-amd64-netinst.iso
	205
	206	local:vztmpl/debian-5.0-joomla_1.5.9-1_i386.tar.gz
	207
	208	iscsi-storage:0.0.2.scsi-14f504e46494c4500494b5042546d2d646744372d31616d61
	209
	210	To get the filesystem path for a <VOLUME_ID> use:
	211
	212	pvesm path <VOLUME_ID>
	213
	214
	215	=head1 EXAMPLES
	216
	217	# scan iscsi host for available targets
	218	pvesm scan iscsi <HOST[:PORT]>
	219
	220	# scan nfs server for available exports
	221	pvesm scan nfs <HOST>
	222
	223	# add storage pools
	224	pvesm add <STORAGE_ID> <TYPE> <OPTIONS>
	225	pvesm add <STORAGE_ID> dir --path <PATH>
	226	pvesm add <STORAGE_ID> nfs --path <PATH> --server <SERVER> --export <EXPORT>
	227	pvesm add <STORAGE_ID> lvm --vgname <VGNAME>
	228	pvesm add <STORAGE_ID> iscsi --portal <HOST[:PORT]> --target <TARGET>
	229
	230	# disable storage pools
	231	pvesm set <STORAGE_ID> --disable 1
	232
	233	# enable storage pools
	234	pvesm set <STORAGE_ID> --disable 0
	235
	236	# change/set storage options
	237	pvesm set <STORAGE_ID> <OPTIONS>
	238	pvesm set <STORAGE_ID> --shared 1
	239	pvesm set local --format qcow2
	240	pvesm set <STORAGE_ID> --content iso
	241
	242	# remove storage pools - does not delete any data
	243	pvesm remove <STORAGE_ID>
	244
	245	# alloc volumes
	246	pvesm alloc <STORAGE_ID> <VMID> <name> <size> [--format <raw\|qcow2>]
	247
	248	# alloc 4G volume in local storage - use auto generated name
	249	pvesm alloc local <VMID> '' 4G
	250
	251	# free volumes (warning: destroy/deletes all volume data)
	252	pvesm free <VOLUME_ID>
	253
	254	# list storage status
	255	pvesm status
	256
	257	# list storage contents
	258	pvesm list <STORAGE_ID> [--vmid <VMID>]
	259
	260	# list volumes allocated by VMID
	261	pvesm list <STORAGE_ID> --vmid <VMID>
	262
	263	# list iso images
	264	pvesm list <STORAGE_ID> --iso
	265
	266	# list openvz templates
	267	pvesm list <STORAGE_ID> --vztmpl
	268
	269	# show filesystem path for a volume
	270	pvesm path <VOLUME_ID>
	271
	272	=include pve_copyright