From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [45.144.208.40]) by lore.proxmox.com (Postfix) with ESMTPS id 87A501FF0AF for ; Fri, 06 Nov 2026 16:47:19 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id A76D9216E9; Fri, 06 Nov 2026 16:46:50 +0100 (CET) From: "Max R. Carrara" To: pve-devel@lists.proxmox.com Subject: [PATCH pve-storage v4 09/17] all plugins, api: mark certain properties as hidden in plugindata() Date: Fri, 6 Nov 2026 16:45:45 +0100 Message-ID: <20261106154554.2182986-10-m.carrara@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261106154554.2182986-1-m.carrara@proxmox.com> References: <20261106154554.2182986-1-m.carrara@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1793979973757 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.328 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: BWBP4J6CZTQ3DMMJ24U27ETZJRIIUGBE X-Message-ID-Hash: BWBP4J6CZTQ3DMMJ24U27ETZJRIIUGBE X-MailFrom: m.carrara@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Alfonso Kuen , Thomas Ellmenreich , Jakob Klocker X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: As done with 'advanced-properties', add a new 'hidden-properties' hash in `plugindata()` of all plugins. For each plugin, mark the properties that are *not* visible / used anywhere in the create / edit panel in the UI in that hash. This results in the following properties being marked as hidden if they do appear in a given plugin's `properties()` or `options()`: - bwlimit - create-base-path - create-subdirs - content-dirs - format Properties that the UI of a built-in plugin simply does not offer yet are not marked. Additionally, expose whether a property is hidden or not through a new 'x-hidden' key that is added to each plugin property schema that is returned by the `plugins/storage/plugin` endpoint. The key is always set to either 0 or 1, also for plugins without the hash. Signed-off-by: Max R. Carrara --- src/PVE/API2/Plugins/Storage/Plugin.pm | 2 ++ src/PVE/Storage/BTRFSPlugin.pm | 5 +++++ src/PVE/Storage/CIFSPlugin.pm | 7 +++++++ src/PVE/Storage/CephFSPlugin.pm | 7 +++++++ src/PVE/Storage/DirPlugin.pm | 7 +++++++ src/PVE/Storage/ESXiPlugin.pm | 1 + src/PVE/Storage/ISCSIDirectPlugin.pm | 3 +++ src/PVE/Storage/ISCSIPlugin.pm | 3 +++ src/PVE/Storage/LVMPlugin.pm | 3 +++ src/PVE/Storage/LvmThinPlugin.pm | 3 +++ src/PVE/Storage/NFSPlugin.pm | 7 +++++++ src/PVE/Storage/PBSPlugin.pm | 1 + src/PVE/Storage/RBDPlugin.pm | 3 +++ src/PVE/Storage/ZFSPlugin.pm | 3 +++ src/PVE/Storage/ZFSPoolPlugin.pm | 3 +++ 15 files changed, 58 insertions(+) diff --git a/src/PVE/API2/Plugins/Storage/Plugin.pm b/src/PVE/API2/Plugins/Storage/Plugin.pm index 33efc138..72b176ff 100644 --- a/src/PVE/API2/Plugins/Storage/Plugin.pm +++ b/src/PVE/API2/Plugins/Storage/Plugin.pm @@ -64,21 +64,23 @@ my sub get_schema_for_plugin : prototype($) ($plugin) { my $options = $plugin->options(); # also covers the fallback for plugins without 'sensitive-properties' in their plugindata() my $sensitive = { map { $_ => 1 } PVE::Storage::Plugin::sensitive_properties($type)->@* }; my $advanced = $plugin->plugindata()->{'advanced-properties'} // {}; + my $hidden = $plugin->plugindata()->{'hidden-properties'} // {}; my $schema = {}; $PLUGIN_SCHEMAS->{$type} = $schema; for my $option (keys $options->%*) { my $prop_schema = PVE::RESTHandler::api_dump_remove_refs( PVE::Storage::Plugin->get_property_schema($type, $option)); # shallow copy my $property = { $prop_schema->%* }; $property->{'x-advanced'} = $advanced->{$option} ? 1 : 0; + $property->{'x-hidden'} = $hidden->{$option} ? 1 : 0; $property->{'x-sensitive'} = $sensitive->{$option} ? 1 : 0; $schema->{$option} = $property; for my $opt_key (keys $options->{$option}->%*) { diff --git a/src/PVE/Storage/BTRFSPlugin.pm b/src/PVE/Storage/BTRFSPlugin.pm index 0108e03d..bb3b29bb 100644 --- a/src/PVE/Storage/BTRFSPlugin.pm +++ b/src/PVE/Storage/BTRFSPlugin.pm @@ -46,10 +46,15 @@ sub plugindata { ], format => [{ raw => 1, subvol => 1 }, 'raw'], 'advanced-properties' => { preallocation => 1, }, + 'hidden-properties' => { + 'create-base-path' => 1, + 'create-subdirs' => 1, + format => 1, + }, 'sensitive-properties' => {}, }; } sub properties { diff --git a/src/PVE/Storage/CIFSPlugin.pm b/src/PVE/Storage/CIFSPlugin.pm index 5a04154a..6a428248 100644 --- a/src/PVE/Storage/CIFSPlugin.pm +++ b/src/PVE/Storage/CIFSPlugin.pm @@ -127,10 +127,17 @@ sub plugindata { format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'], 'advanced-properties' => { preallocation => 1, 'snapshot-as-volume-chain' => 1, }, + 'hidden-properties' => { + bwlimit => 1, + 'create-base-path' => 1, + 'create-subdirs' => 1, + 'content-dirs' => 1, + format => 1, + }, 'sensitive-properties' => { password => 1 }, }; } sub properties { diff --git a/src/PVE/Storage/CephFSPlugin.pm b/src/PVE/Storage/CephFSPlugin.pm index 59cb57c3..01a73732 100644 --- a/src/PVE/Storage/CephFSPlugin.pm +++ b/src/PVE/Storage/CephFSPlugin.pm @@ -117,10 +117,17 @@ sub type { sub plugindata { return { content => [{ vztmpl => 1, iso => 1, backup => 1, snippets => 1, import => 1 }, { backup => 1 }], 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + 'create-base-path' => 1, + 'create-subdirs' => 1, + 'content-dirs' => 1, + format => 1, + }, 'sensitive-properties' => { keyring => 1 }, }; } sub properties { diff --git a/src/PVE/Storage/DirPlugin.pm b/src/PVE/Storage/DirPlugin.pm index 8e923077..a9240398 100644 --- a/src/PVE/Storage/DirPlugin.pm +++ b/src/PVE/Storage/DirPlugin.pm @@ -40,10 +40,17 @@ sub plugindata { format => [{ raw => 1, qcow2 => 1, vmdk => 1, subvol => 1 }, 'raw'], 'advanced-properties' => { preallocation => 1, 'snapshot-as-volume-chain' => 1, }, + 'hidden-properties' => { + bwlimit => 1, + 'create-base-path' => 1, + 'create-subdirs' => 1, + 'content-dirs' => 1, + format => 1, + }, 'sensitive-properties' => {}, }; } sub properties { diff --git a/src/PVE/Storage/ESXiPlugin.pm b/src/PVE/Storage/ESXiPlugin.pm index 82f64650..d418fbd2 100644 --- a/src/PVE/Storage/ESXiPlugin.pm +++ b/src/PVE/Storage/ESXiPlugin.pm @@ -31,10 +31,11 @@ sub type { sub plugindata { return { content => [{ import => 1 }, { import => 1 }], format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'], 'advanced-properties' => {}, + 'hidden-properties' => {}, 'sensitive-properties' => { password => 1 }, }; } sub properties { diff --git a/src/PVE/Storage/ISCSIDirectPlugin.pm b/src/PVE/Storage/ISCSIDirectPlugin.pm index 72bad793..65ae0ab8 100644 --- a/src/PVE/Storage/ISCSIDirectPlugin.pm +++ b/src/PVE/Storage/ISCSIDirectPlugin.pm @@ -65,10 +65,13 @@ sub type { sub plugindata { return { content => [{ images => 1, none => 1 }, { images => 1 }], select_existing => 1, 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => {}, }; } sub options { diff --git a/src/PVE/Storage/ISCSIPlugin.pm b/src/PVE/Storage/ISCSIPlugin.pm index 2f148935..4a632e09 100644 --- a/src/PVE/Storage/ISCSIPlugin.pm +++ b/src/PVE/Storage/ISCSIPlugin.pm @@ -349,10 +349,13 @@ sub type { sub plugindata { return { content => [{ images => 1, none => 1 }, { images => 1 }], select_existing => 1, 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => {}, }; } sub properties { diff --git a/src/PVE/Storage/LVMPlugin.pm b/src/PVE/Storage/LVMPlugin.pm index 2619a7b9..e0204217 100644 --- a/src/PVE/Storage/LVMPlugin.pm +++ b/src/PVE/Storage/LVMPlugin.pm @@ -716,10 +716,13 @@ sub plugindata { content => [{ images => 1, rootdir => 1 }, { images => 1 }], format => [{ raw => 1, qcow2 => 1 }, 'raw'], 'advanced-properties' => { 'snapshot-as-volume-chain' => 1, }, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => {}, }; } my $on_volume_remove_format = { diff --git a/src/PVE/Storage/LvmThinPlugin.pm b/src/PVE/Storage/LvmThinPlugin.pm index 7fed8af8..cc11dea8 100644 --- a/src/PVE/Storage/LvmThinPlugin.pm +++ b/src/PVE/Storage/LvmThinPlugin.pm @@ -35,10 +35,13 @@ sub type { sub plugindata { return { content => [{ images => 1, rootdir => 1 }, { images => 1, rootdir => 1 }], 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => {}, }; } sub properties { diff --git a/src/PVE/Storage/NFSPlugin.pm b/src/PVE/Storage/NFSPlugin.pm index 85497df6..d4b086da 100644 --- a/src/PVE/Storage/NFSPlugin.pm +++ b/src/PVE/Storage/NFSPlugin.pm @@ -68,10 +68,17 @@ sub plugindata { format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'], 'advanced-properties' => { preallocation => 1, 'snapshot-as-volume-chain' => 1, }, + 'hidden-properties' => { + bwlimit => 1, + 'create-base-path' => 1, + 'create-subdirs' => 1, + 'content-dirs' => 1, + format => 1, + }, 'sensitive-properties' => {}, }; } sub properties { diff --git a/src/PVE/Storage/PBSPlugin.pm b/src/PVE/Storage/PBSPlugin.pm index 83b6f89b..66372e54 100644 --- a/src/PVE/Storage/PBSPlugin.pm +++ b/src/PVE/Storage/PBSPlugin.pm @@ -30,10 +30,11 @@ sub type { sub plugindata { return { content => [{ backup => 1, none => 1 }, { backup => 1 }], 'advanced-properties' => {}, + 'hidden-properties' => {}, 'sensitive-properties' => { 'encryption-key' => 1, 'master-pubkey' => 1, password => 1, }, diff --git a/src/PVE/Storage/RBDPlugin.pm b/src/PVE/Storage/RBDPlugin.pm index 970358ca..c7aab835 100644 --- a/src/PVE/Storage/RBDPlugin.pm +++ b/src/PVE/Storage/RBDPlugin.pm @@ -415,10 +415,13 @@ sub type { sub plugindata { return { content => [{ images => 1, rootdir => 1 }, { images => 1 }], 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => { keyring => 1 }, }; } sub properties { diff --git a/src/PVE/Storage/ZFSPlugin.pm b/src/PVE/Storage/ZFSPlugin.pm index 81923494..85137c39 100644 --- a/src/PVE/Storage/ZFSPlugin.pm +++ b/src/PVE/Storage/ZFSPlugin.pm @@ -193,10 +193,13 @@ sub type { sub plugindata { return { content => [{ images => 1 }, { images => 1 }], 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => {}, }; } sub properties { diff --git a/src/PVE/Storage/ZFSPoolPlugin.pm b/src/PVE/Storage/ZFSPoolPlugin.pm index 522fee8b..7a7903bf 100644 --- a/src/PVE/Storage/ZFSPoolPlugin.pm +++ b/src/PVE/Storage/ZFSPoolPlugin.pm @@ -63,10 +63,13 @@ sub type { sub plugindata { return { content => [{ images => 1, rootdir => 1 }, { images => 1, rootdir => 1 }], format => [{ raw => 1, subvol => 1 }, 'raw'], 'advanced-properties' => {}, + 'hidden-properties' => { + bwlimit => 1, + }, 'sensitive-properties' => {}, }; } sub properties { -- 2.47.3