X-Git-Url: https://git.proxmox.com/?p=pve-client.git;a=blobdiff_plain;f=pveclient;h=cbcc113778ed75611be6baf7248df2cbaa257575;hp=d13b7eb685001153d305999f4f1d65b408b6c4a3;hb=fabf76a653193b007f2c4ecda29ff1067b6e971a;hpb=2767c2b92faad106cc412c16741ed5b5ca00b61f diff --git a/pveclient b/pveclient index d13b7eb..cbcc113 100755 --- a/pveclient +++ b/pveclient @@ -8,6 +8,8 @@ use Cwd 'abs_path'; use Data::Dumper; use PVE::APIClient::JSONSchema qw(register_standard_option get_standard_option); +use PVE::APIClient::RESTHandler; +use PVE::APIClient::CLIFormatter; use PVE::APIClient::CLIHandler; use PVE::APIClient::PTY; @@ -28,12 +30,12 @@ sub call_api_method { my $path = PVE::APIClient::Tools::extract_param($param, 'api_path'); die "missing API path\n" if !defined($path); + my $stdopts = PVE::APIClient::RESTHandler::extract_standard_output_properties($param); + PVE::APIClient::CLIFormatter::query_terminal_options($stdopts); + my $remote = PVE::APIClient::Tools::extract_param($param, 'remote'); die "missing remote\n" if !defined($remote); - my $format = PVE::APIClient::Tools::extract_param($param, 'format'); - PVE::APIClient::Helpers::set_output_format($format); - my $config = PVE::APIClient::Config->load(); my $uri_param = {}; @@ -45,13 +47,15 @@ sub call_api_method { die "undefined result" if !defined($res); die "undefined result data" if !exists($res->{data}); - return $res->{data}; + my $data = $res->{data}; + + PVE::APIClient::CLIFormatter::print_api_result($data, $info->{returns}, undef, $stdopts); } use base qw(PVE::APIClient::CLIHandler); sub read_password { - return PVE::APIClient::PTY::read_password("Remote password: ") + return PVE::APIClient::PTY::read_password("Remote password: ") } @@ -80,7 +84,15 @@ if ($cmd && $cmd eq 'packagedepends') { } my $path_properties = {}; -my $path_returns = { type => 'null' }; + +my $api_path_property = { + description => "API path.", + type => 'string', + completion => sub { + my ($cmd, $pname, $cur, $args) = @_; + return PVE::APIClient::Helpers::complete_api_path($cur); + }, +}; # dynamically update schema definition for direct API call # like: pveclient api @@ -90,91 +102,150 @@ if (my $info = PVE::APIClient::Helpers::extract_path_info($uri_param)) { next if defined($uri_param->{$key}); $path_properties->{$key} = $info->{parameters}->{properties}->{$key}; } - $path_returns = $info->{returns}; } -$path_properties->{format} = get_standard_option('pveclient-output-format'), $path_properties->{remote} = get_standard_option('pveclient-remote-name'); -$path_properties->{api_path} = { - description => "API path.", - type => 'string', - completion => sub { - my ($cmd, $pname, $cur, $args) = @_; - return PVE::APIClient::Helpers::complete_api_path($cur); - }, -}; - - -my $format_result = sub { - my ($data) = @_; - - PVE::APIClient::Helpers::print_result($data, $path_returns); -}; +$path_properties->{api_path} = $api_path_property; __PACKAGE__->register_method ({ name => 'pveclient_get', path => 'pveclient_get', method => 'GET', - description => "call API GET on .", + description => "Call API GET on .", parameters => { additionalProperties => 0, - properties => $path_properties, + properties => PVE::APIClient::RESTHandler::add_standard_output_properties($path_properties), }, - returns => $path_returns, + returns => { type => 'null' }, code => sub { my ($param) = @_; - return call_api_method('GET', $param); + call_api_method('GET', $param); + + return undef; }}); __PACKAGE__->register_method ({ name => 'pveclient_set', path => 'pveclient_set', method => 'PUT', - description => "call API PUT on .", + description => "Call API PUT on .", parameters => { additionalProperties => 0, - properties => $path_properties, + properties => PVE::APIClient::RESTHandler::add_standard_output_properties($path_properties), }, - returns => $path_returns, + returns => { type => 'null' }, code => sub { my ($param) = @_; - return call_api_method('PUT', $param); + call_api_method('PUT', $param); + + return undef; }}); __PACKAGE__->register_method ({ name => 'pveclient_create', path => 'pveclient_create', - method => 'PUSH', - description => "call API PUSH on .", + method => 'POST', + description => "Call API POST on .", parameters => { additionalProperties => 0, - properties => $path_properties, + properties => PVE::APIClient::RESTHandler::add_standard_output_properties($path_properties), }, - returns => $path_returns, + returns => { type => 'null' }, code => sub { my ($param) = @_; - return call_api_method('PUSH', $param); + call_api_method('PUSH', $param); + + return undef; }}); __PACKAGE__->register_method ({ name => 'pveclient_delete', path => 'pveclient_delete', method => 'DELETE', - description => "call API DELETE on .", + description => "Call API DELETE on .", parameters => { additionalProperties => 0, - properties => $path_properties, + properties => PVE::APIClient::RESTHandler::add_standard_output_properties($path_properties), }, - returns => $path_returns, + returns => { type => 'null' }, code => sub { my ($param) = @_; - return call_api_method('DELETE', $param); + call_api_method('DELETE', $param); + + return undef; }}); +__PACKAGE__->register_method ({ + name => 'pveclient_usage', + path => 'pveclient_usage', + method => 'GET', + description => "print API usage information for .", + parameters => { + additionalProperties => 0, + properties => { + api_path => $api_path_property, + verbose => { + description => "Verbose output format.", + type => 'boolean', + optional => 1, + }, + returns => { + description => "Including schema for returned data.", + type => 'boolean', + optional => 1, + }, + command => { + description => "API command.", + type => 'string', + enum => [ keys %$PVE::APIClient::Helpers::method_map ], + optional => 1, + }, + }, + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + my $path = $param->{api_path}; + + my $found = 0; + foreach my $cmd (qw(get set create delete)) { + next if $param->{command} && $cmd ne $param->{command}; + my $method = $PVE::APIClient::Helpers::method_map->{$cmd}; + my $uri_param = {}; + my $info = PVE::APIClient::Helpers::find_method_info($path, $method, $uri_param, 1); + next if !$info; + $found = 1; + + my $prefix = "pveclient api $cmd $path"; + if ($param->{verbose}) { + print PVE::APIClient::RESTHandler::getopt_usage( + $info, $prefix, undef, $uri_param, 'full'); + + } else { + print "USAGE: " . PVE::APIClient::RESTHandler::getopt_usage( + $info, $prefix, undef, $uri_param, 'short'); + } + if ($param-> {returns}) { + my $schema = to_json($info->{returns}, {utf8 => 1, canonical => 1, pretty => 1 }); + print "RETURNS: $schema\n"; + } + } + + if (!$found) { + if ($param->{command}) { + die "no '$param->{command}' handler for '$path'\n"; + } else { + die "no such resource '$path'\n" + } + } + + return undef; + }}); our $cmddef = { config => $PVE::APIClient::Commands::config::cmddef, @@ -190,10 +261,11 @@ our $cmddef = { suspend => [ 'PVE::APIClient::Commands::GuestStatus', 'suspend', ['remote', 'vmid']], api => { - get => [ __PACKAGE__, 'pveclient_get', ['remote', 'api_path'], {}, $format_result ], - set => [ __PACKAGE__, 'pveclient_set', ['remote', 'api_path'], {}, $format_result ], - create => [ __PACKAGE__, 'pveclient_create', ['remote', 'api_path'], {}, $format_result ], - delete => [ __PACKAGE__, 'pveclient_delete', ['remote', 'api_path'], {}, $format_result ], + usage => [ __PACKAGE__, 'pveclient_usage', ['api_path']], + get => [ __PACKAGE__, 'pveclient_get', ['remote', 'api_path']], + set => [ __PACKAGE__, 'pveclient_set', ['remote', 'api_path']], + create => [ __PACKAGE__, 'pveclient_create', ['remote', 'api_path']], + delete => [ __PACKAGE__, 'pveclient_delete', ['remote', 'api_path']], }, };