]>
git.proxmox.com Git - pve-storage.git/blob - PVE/API2/Storage/Config.pm
1 package PVE
::API2
::Storage
::Config
;
7 use PVE
::Tools
qw(extract_param);
8 use PVE
::Cluster
qw(cfs_read_file cfs_write_file);
10 use PVE
::Storage
::Plugin
;
11 use PVE
::Storage
::LVMPlugin
;
12 use PVE
::Storage
::CIFSPlugin
;
13 use HTTP
::Status
qw(:constants);
14 use Storable
qw(dclone);
15 use PVE
::JSONSchema
qw(get_standard_option);
16 use PVE
::RPCEnvironment
;
20 use base
qw(PVE::RESTHandler);
22 my @ctypes = qw(images vztmpl iso backup);
24 my $storage_type_enum = PVE
::Storage
::Plugin-
>lookup_types();
26 my $api_storage_config = sub {
27 my ($cfg, $storeid) = @_;
29 my $scfg = dclone
(PVE
::Storage
::storage_config
($cfg, $storeid));
30 $scfg->{storage
} = $storeid;
31 $scfg->{digest
} = $cfg->{digest
};
32 $scfg->{content
} = PVE
::Storage
::Plugin-
>encode_value($scfg->{type
}, 'content', $scfg->{content
});
35 $scfg->{nodes
} = PVE
::Storage
::Plugin-
>encode_value($scfg->{type
}, 'nodes', $scfg->{nodes
});
41 __PACKAGE__-
>register_method ({
45 description
=> "Storage index.",
47 description
=> "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/<storage>'",
51 additionalProperties
=> 0,
54 description
=> "Only list storage of specific type",
56 enum
=> $storage_type_enum,
65 properties
=> { storage
=> { type
=> 'string'} },
67 links
=> [ { rel
=> 'child', href
=> "{storage}" } ],
72 my $rpcenv = PVE
::RPCEnvironment
::get
();
73 my $authuser = $rpcenv->get_user();
75 my $cfg = PVE
::Storage
::config
();
77 my @sids = PVE
::Storage
::storage_ids
($cfg);
80 foreach my $storeid (@sids) {
81 my $privs = [ 'Datastore.Audit', 'Datastore.AllocateSpace' ];
82 next if !$rpcenv->check_any($authuser, "/storage/$storeid", $privs, 1);
84 my $scfg = &$api_storage_config($cfg, $storeid);
85 next if $param->{type
} && $param->{type
} ne $scfg->{type
};
92 __PACKAGE__-
>register_method ({
96 description
=> "Read storage configuration.",
98 check
=> ['perm', '/storage/{storage}', ['Datastore.Allocate']],
101 additionalProperties
=> 0,
103 storage
=> get_standard_option
('pve-storage-id'),
106 returns
=> { type
=> 'object' },
110 my $cfg = PVE
::Storage
::config
();
112 return &$api_storage_config($cfg, $param->{storage
});
115 my sub extract_sensitive_params
:prototype($$) {
116 my ($param, $delete_list) = @_;
120 my %delete = map { $_ => 1 } ($delete_list || [])->@*;
122 # always extract pw and keys, so they don't get written to the www-data readable scfg
123 for my $opt (qw(password encryption-key)) {
124 # First handle deletions as explicitly setting `undef`, afterwards new values may override
126 if (exists($delete{$opt})) {
127 $sensitive->{$opt} = undef;
130 if (defined(my $value = extract_param
($param, $opt))) {
131 $sensitive->{$opt} = $value;
138 __PACKAGE__-
>register_method ({
143 description
=> "Create a new storage.",
145 check
=> ['perm', '/storage', ['Datastore.Allocate']],
147 parameters
=> PVE
::Storage
::Plugin-
>createSchema(),
148 returns
=> { type
=> 'null' },
152 my $type = extract_param
($param, 'type');
153 my $storeid = extract_param
($param, 'storage');
155 # revent an empty nodelist.
156 # fix me in section config create never need an empty entity.
157 delete $param->{nodes
} if !$param->{nodes
};
159 my $sensitive = extract_sensitive_params
($param, []);
161 my $plugin = PVE
::Storage
::Plugin-
>lookup($type);
162 my $opts = $plugin->check_config($storeid, $param, 1, 1);
164 PVE
::Storage
::lock_storage_config
(sub {
165 my $cfg = PVE
::Storage
::config
();
167 if (my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid, 1)) {
168 die "storage ID '$storeid' already defined\n";
171 $cfg->{ids
}->{$storeid} = $opts;
173 $plugin->on_add_hook($storeid, $opts, %$sensitive);
176 # try to activate if enabled on local node,
177 # we only do this to detect errors/problems sooner
178 if (PVE
::Storage
::storage_check_enabled
($cfg, $storeid, undef, 1)) {
179 PVE
::Storage
::activate_storage
($cfg, $storeid);
183 eval { $plugin->on_delete_hook($storeid, $opts) };
188 PVE
::Storage
::write_config
($cfg);
190 }, "create storage failed");
195 __PACKAGE__-
>register_method ({
200 description
=> "Update storage configuration.",
202 check
=> ['perm', '/storage', ['Datastore.Allocate']],
204 parameters
=> PVE
::Storage
::Plugin-
>updateSchema(),
205 returns
=> { type
=> 'null' },
209 my $storeid = extract_param
($param, 'storage');
210 my $digest = extract_param
($param, 'digest');
211 my $delete = extract_param
($param, 'delete');
214 $delete = [ PVE
::Tools
::split_list
($delete) ];
217 PVE
::Storage
::lock_storage_config
(sub {
218 my $cfg = PVE
::Storage
::config
();
220 PVE
::SectionConfig
::assert_if_modified
($cfg, $digest);
222 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
223 my $type = $scfg->{type
};
225 my $sensitive = extract_sensitive_params
($param, $delete);
227 my $plugin = PVE
::Storage
::Plugin-
>lookup($type);
228 my $opts = $plugin->check_config($storeid, $param, 0, 1);
231 my $options = $plugin->private()->{options
}->{$type};
232 foreach my $k (@$delete) {
233 my $d = $options->{$k} || die "no such option '$k'\n";
234 die "unable to delete required option '$k'\n" if !$d->{optional
};
235 die "unable to delete fixed option '$k'\n" if $d->{fixed
};
236 die "cannot set and delete property '$k' at the same time!\n"
237 if defined($opts->{$k});
243 $plugin->on_update_hook($storeid, $opts, %$sensitive);
245 for my $k (keys %$opts) {
246 $scfg->{$k} = $opts->{$k};
249 PVE
::Storage
::write_config
($cfg);
251 }, "update storage failed");
256 __PACKAGE__-
>register_method ({
259 path
=> '{storage}', # /storage/config/{storage}
261 description
=> "Delete storage configuration.",
263 check
=> ['perm', '/storage', ['Datastore.Allocate']],
266 additionalProperties
=> 0,
268 storage
=> get_standard_option
('pve-storage-id', {
269 completion
=> \
&PVE
::Storage
::complete_storage
,
273 returns
=> { type
=> 'null' },
277 my $storeid = extract_param
($param, 'storage');
279 PVE
::Storage
::lock_storage_config
(sub {
280 my $cfg = PVE
::Storage
::config
();
282 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
284 die "can't remove storage - storage is used as base of another storage\n"
285 if PVE
::Storage
::storage_is_used
($cfg, $storeid);
287 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
289 $plugin->on_delete_hook($storeid, $scfg);
291 delete $cfg->{ids
}->{$storeid};
293 PVE
::Storage
::write_config
($cfg);
295 }, "delete storage failed");
297 PVE
::AccessControl
::remove_storage_access
($storeid);