From: Wolfgang Bumiller <w.bumiller@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH manager] api: factor out shell command schema
Date: Tue, 2 Sep 2025 14:55:13 +0200 [thread overview]
Message-ID: <20250902125516.346145-1-w.bumiller@proxmox.com> (raw)
So we only sort the enum keys once and the documentation and API dumps
don't keep reordering them, and to deduplicate the cmd and cmd-opts
schema.
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
---
PVE/API2/Nodes.pm | 68 ++++++++++++++---------------------------------
1 file changed, 20 insertions(+), 48 deletions(-)
diff --git a/PVE/API2/Nodes.pm b/PVE/API2/Nodes.pm
index ce7eecaf1..636789277 100644
--- a/PVE/API2/Nodes.pm
+++ b/PVE/API2/Nodes.pm
@@ -1103,6 +1103,23 @@ my $shell_cmd_map = {
},
};
+my @shell_cmd_params = (
+ cmd => {
+ type => 'string',
+ description => "Run specific command or default to login (requires 'root\@pam')",
+ enum => [sort keys %$shell_cmd_map],
+ optional => 1,
+ default => 'login',
+ },
+ 'cmd-opts' => {
+ type => 'string',
+ description => "Add parameters to a command. Encoded as null terminated strings.",
+ requires => 'cmd',
+ optional => 1,
+ default => '',
+ },
+);
+
sub get_shell_command {
my ($user, $shellcmd, $args) = @_;
@@ -1156,22 +1173,7 @@ __PACKAGE__->register_method({
additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
- cmd => {
- type => 'string',
- description =>
- "Run specific command or default to login (requires 'root\@pam')",
- enum => [keys %$shell_cmd_map],
- optional => 1,
- default => 'login',
- },
- 'cmd-opts' => {
- type => 'string',
- description =>
- "Add parameters to a command. Encoded as null terminated strings.",
- requires => 'cmd',
- optional => 1,
- default => '',
- },
+ @shell_cmd_params,
websocket => {
optional => 1,
type => 'boolean',
@@ -1307,22 +1309,7 @@ __PACKAGE__->register_method({
additionalProperties => 0,
properties => {
node => get_standard_option('pve-node'),
- cmd => {
- type => 'string',
- description =>
- "Run specific command or default to login (requires 'root\@pam')",
- enum => [keys %$shell_cmd_map],
- optional => 1,
- default => 'login',
- },
- 'cmd-opts' => {
- type => 'string',
- description =>
- "Add parameters to a command. Encoded as null terminated strings.",
- requires => 'cmd',
- optional => 1,
- default => '',
- },
+ @shell_cmd_params,
},
},
returns => {
@@ -1437,22 +1424,7 @@ __PACKAGE__->register_method({
properties => {
node => get_standard_option('pve-node'),
proxy => get_standard_option('spice-proxy', { optional => 1 }),
- cmd => {
- type => 'string',
- description =>
- "Run specific command or default to login (requires 'root\@pam')",
- enum => [keys %$shell_cmd_map],
- optional => 1,
- default => 'login',
- },
- 'cmd-opts' => {
- type => 'string',
- description =>
- "Add parameters to a command. Encoded as null terminated strings.",
- requires => 'cmd',
- optional => 1,
- default => '',
- },
+ @shell_cmd_params,
},
},
returns => get_standard_option('remote-viewer-config'),
--
2.47.2
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next reply other threads:[~2025-09-02 12:55 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-02 12:55 Wolfgang Bumiller [this message]
2025-09-03 16:01 ` Thomas Lamprecht
2025-09-04 12:27 ` Wolfgang Bumiller
2025-09-04 16:53 ` [pve-devel] applied: " Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250902125516.346145-1-w.bumiller@proxmox.com \
--to=w.bumiller@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.