pveclient

   1 #!/usr/bin/perl
   2
   3 package PVE::CLI::pveclient;
   4
   5 use strict;
   6 use warnings;
   7 use Cwd 'abs_path';
   8 use Data::Dumper;
   9
  10 use PVE::APIClient::JSONSchema qw(register_standard_option get_standard_option);
  11 use PVE::APIClient::CLIHandler;
  12 use PVE::APIClient::PTY;
  13
  14 use PVE::APIClient::LWP;
  15 use PVE::APIClient::Helpers;
  16 use PVE::APIClient::Config;
  17 use PVE::APIClient::Commands::config;
  18 use PVE::APIClient::Commands::remote;
  19 use PVE::APIClient::Commands::list;
  20 use PVE::APIClient::Commands::lxc;
  21 use PVE::APIClient::Commands::GuestStatus;
  22
  23 use JSON;
  24
  25 sub call_api_method {
  26     my ($method, $param) = @_;
  27
  28     my $path = PVE::APIClient::Tools::extract_param($param, 'api_path');
  29     die "missing API path\n" if !defined($path);
  30
  31     my $remote = PVE::APIClient::Tools::extract_param($param, 'remote');
  32     die "missing remote\n" if !defined($remote);
  33
  34     my $format = PVE::APIClient::Tools::extract_param($param, 'format');
  35     PVE::APIClient::Helpers::set_output_format($format);
  36
  37     my $config = PVE::APIClient::Config->load();
  38
  39     my $uri_param = {};
  40     my $info = PVE::APIClient::Helpers::find_method_info($path, $method, $uri_param);
  41
  42     my $conn = PVE::APIClient::Config->remote_conn($config, $remote);
  43
  44     my $res = $conn->call($method, "api2/json/$path", $param);
  45     die "undefined result" if !defined($res);
  46     die "undefined result data" if !exists($res->{data});
  47
  48     return $res->{data};
  49 }
  50
  51 use base qw(PVE::APIClient::CLIHandler);
  52
  53 sub read_password {
  54     return PVE::APIClient::PTY::read_password("Remote password: ")
  55 }
  56
  57
  58 my $cmd = $ARGV[0];
  59
  60 if ($cmd && $cmd eq 'packagedepends') {
  61     # experimental code to print required perl packages
  62     my $packages = {};
  63     my $dir = Cwd::getcwd;
  64
  65     foreach my $k (keys %INC) {
  66         my $file = abs_path($INC{$k});
  67         next if $file =~ m/^\Q$dir\E/;
  68         my $res = `dpkg -S '$file'`;
  69         if ($res && $res =~ m/^(\S+): $file$/) {
  70             my $debian_package = $1;
  71             $debian_package =~ s/:amd64$//;
  72             $packages->{$debian_package} = 1;
  73         } else {
  74             die "unable to find package for '$file'\n";
  75         }
  76     }
  77     print join("\n", sort(keys %$packages)) . "\n";
  78
  79     exit(0);
  80 }
  81
  82 my $path_properties = {};
  83 my $path_returns = { type => 'null' };
  84
  85 # dynamically update schema definition for direct API call
  86 # like: pveclient api <get|set|create|delete|help> <remote> <path>
  87 my $uri_param = {};
  88 if (my $info = PVE::APIClient::Helpers::extract_path_info($uri_param)) {
  89     foreach my $key (keys %{$info->{parameters}->{properties}}) {
  90         next if defined($uri_param->{$key});
  91         $path_properties->{$key} = $info->{parameters}->{properties}->{$key};
  92     }
  93     $path_returns = $info->{returns};
  94 }
  95
  96 $path_properties->{format} = get_standard_option('pveclient-output-format'),
  97 $path_properties->{remote} = get_standard_option('pveclient-remote-name');
  98 $path_properties->{api_path} = {
  99     description => "API path.",
 100     type => 'string',
 101     completion => sub {
 102         my ($cmd, $pname, $cur, $args) = @_;
 103         return PVE::APIClient::Helpers::complete_api_path($cur);
 104     },
 105 };
 106
 107
 108 my $format_result = sub {
 109     my ($data) = @_;
 110
 111     PVE::APIClient::Helpers::print_result($data, $path_returns);
 112 };
 113
 114 __PACKAGE__->register_method ({
 115     name => 'pveclient_get',
 116     path => 'pveclient_get',
 117     method => 'GET',
 118     description => "Call API GET on <api_path>.",
 119     parameters => {
 120         additionalProperties => 0,
 121         properties => $path_properties,
 122     },
 123     returns => $path_returns,
 124     code => sub {
 125         my ($param) = @_;
 126
 127         return call_api_method('GET', $param);
 128     }});
 129
 130 __PACKAGE__->register_method ({
 131     name => 'pveclient_set',
 132     path => 'pveclient_set',
 133     method => 'PUT',
 134     description => "Call API PUT on <api_path>.",
 135     parameters => {
 136         additionalProperties => 0,
 137         properties => $path_properties,
 138     },
 139     returns => $path_returns,
 140     code => sub {
 141         my ($param) = @_;
 142
 143         return call_api_method('PUT', $param);
 144     }});
 145
 146 __PACKAGE__->register_method ({
 147     name => 'pveclient_create',
 148     path => 'pveclient_create',
 149     method => 'PUSH',
 150     description => "Call API PUSH on <api_path>.",
 151     parameters => {
 152         additionalProperties => 0,
 153         properties => $path_properties,
 154     },
 155     returns => $path_returns,
 156     code => sub {
 157         my ($param) = @_;
 158
 159         return call_api_method('PUSH', $param);
 160     }});
 161
 162 __PACKAGE__->register_method ({
 163     name => 'pveclient_delete',
 164     path => 'pveclient_delete',
 165     method => 'DELETE',
 166     description => "Call API DELETE on <api_path>.",
 167     parameters => {
 168         additionalProperties => 0,
 169         properties => $path_properties,
 170     },
 171     returns => $path_returns,
 172     code => sub {
 173         my ($param) = @_;
 174
 175         return call_api_method('DELETE', $param);
 176     }});
 177
 178
 179 our $cmddef = {
 180     config => $PVE::APIClient::Commands::config::cmddef,
 181     list => $PVE::APIClient::Commands::list::cmddef,
 182     lxc => $PVE::APIClient::Commands::lxc::cmddef,
 183     remote => $PVE::APIClient::Commands::remote::cmddef,
 184
 185     resume => [ 'PVE::APIClient::Commands::GuestStatus', 'resume', ['remote', 'vmid']],
 186     shutdown => [ 'PVE::APIClient::Commands::GuestStatus', 'shutdown', ['remote', 'vmid']],
 187     spice => [ 'PVE::APIClient::Commands::GuestStatus', 'spice', ['remote', 'vmid']],
 188     start => [ 'PVE::APIClient::Commands::GuestStatus', 'start', ['remote', 'vmid']],
 189     stop => [ 'PVE::APIClient::Commands::GuestStatus', 'stop', ['remote', 'vmid']],
 190     suspend => [ 'PVE::APIClient::Commands::GuestStatus', 'suspend', ['remote', 'vmid']],
 191
 192     api => {
 193         get => [ __PACKAGE__, 'pveclient_get', ['remote', 'api_path'], {}, $format_result ],
 194         set => [ __PACKAGE__, 'pveclient_set', ['remote', 'api_path'], {}, $format_result ],
 195         create => [ __PACKAGE__, 'pveclient_create', ['remote', 'api_path'], {}, $format_result ],
 196         delete => [ __PACKAGE__, 'pveclient_delete', ['remote', 'api_path'], {}, $format_result ],
 197     },
 198 };
 199
 200
 201 if ($cmd && $cmd eq 'printsynopsis') {
 202
 203     print __PACKAGE__->generate_asciidoc_synopsis();
 204
 205     exit(0);
 206 }
 207
 208 __PACKAGE__->run_cli_handler();