schema: add bwlimit standard option and format

[pve-common.git] / src / PVE / CLIHandler.pm

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 9609181816a58632898795765aa4e9d9e1f4ca81..45c0427b2faec2aed843db7c54ba40e665564e85 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -10,6 +10,29 @@ use PVE::INotify;
 
 use base qw(PVE::RESTHandler);
 
+# $cmddef defines which (sub)commands are available in a specific CLI class.
+# A real command is always an array consisting of its class, name, array of
+# position fixed (required) parameters and hash of predefined parameters when
+# mapping a CLI command t o an API call. Optionally an output method can be
+# passed at the end, e.g., for formatting or transformation purpose.
+#
+# [class, name, fixed_params, API_pre-set params, output_sub ]
+#
+# In case of so called 'simple commands', the $cmddef can be also just an
+# array.
+#
+# Examples:
+# $cmddef = {
+#     command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
+#     do => {
+#         this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
+#             my ($res) = @_;
+#             print "$res\n";
+#         }],
+#         that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
+#     },
+#     dothat => { alias => 'do that' },
+# }
 my $cmddef;
 my $exename;
 my $cli_handler_class;
@@ -158,12 +181,10 @@ __PACKAGE__->register_method ({
     parameters => {
        additionalProperties => 0,
        properties => {
-           cmd => {
-               description => "Command name",
-               type => 'string',
-               optional => 1,
+           'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', {
+               description => 'Shows help for a specific command',
                completion => $complete_command_names,
-           },
+           }),
            verbose => {
                description => "Verbose output format.",
                type => 'boolean',
@@ -178,9 +199,9 @@ __PACKAGE__->register_method ({
 
        $assert_initialized->();
 
-       my $cmd = $param->{cmd};
+       my $cmd = $param->{'extra-args'};
 
-       my $verbose = defined($cmd) && $cmd; 
+       my $verbose = defined($cmd) && $cmd;
        $verbose = $param->{verbose} if defined($param->{verbose});
 
        if (!$cmd) {
@@ -438,7 +459,7 @@ sub setup_environment {
 my $handle_cmd  = sub {
     my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
 
-    $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+    $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
     my $cmd_str = join(' ', @$args);
     my ($cmd, $def, $cmd_args) = resolve_cmd($args);
@@ -464,7 +485,7 @@ my $handle_cmd  = sub {
 
     &$preparefunc() if $preparefunc;
 
-    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
+    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
     $abort->("unknown command '$cmd_str'") if !$class;
 
     my $prefix = "$exename $cmd_str";