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     # test if api path exists
  40     my $info = PVE::APIClient::Helpers::lookup_api_method($path, $method);
  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 if (my $info =  PVE::APIClient::Helpers::extract_path_info()) {
  88     $path_properties = $info->{parameters}->{properties};
  89     $path_returns = $info->{returns};
  90 }
  91
  92 $path_properties->{format} = get_standard_option('pveclient-output-format'),
  93 $path_properties->{remote} = get_standard_option('pveclient-remote-name');
  94 $path_properties->{api_path} = {
  95     description => "API path.",
  96     type => 'string',
  97     completion => sub {
  98         my ($cmd, $pname, $cur, $args) = @_;
  99         return PVE::APIClient::Helpers::complete_api_path($cur);
 100     },
 101 };
 102
 103
 104 my $format_result = sub {
 105     my ($data) = @_;
 106
 107     PVE::APIClient::Helpers::print_result($data, $path_returns);
 108 };
 109
 110 __PACKAGE__->register_method ({
 111     name => 'pveclient_get',
 112     path => 'pveclient_get',
 113     method => 'GET',
 114     description => "call API GET on <path>.",
 115     parameters => {
 116         additionalProperties => 0,
 117         properties => $path_properties,
 118     },
 119     returns => $path_returns,
 120     code => sub {
 121         my ($param) = @_;
 122
 123         return call_api_method('GET', $param);
 124     }});
 125
 126 __PACKAGE__->register_method ({
 127     name => 'pveclient_set',
 128     path => 'pveclient_set',
 129     method => 'PUT',
 130     description => "call API PUT on <path>.",
 131     parameters => {
 132         additionalProperties => 0,
 133         properties => $path_properties,
 134     },
 135     returns => $path_returns,
 136     code => sub {
 137         my ($param) = @_;
 138
 139         return call_api_method('PUT', $param);
 140     }});
 141
 142 __PACKAGE__->register_method ({
 143     name => 'pveclient_create',
 144     path => 'pveclient_create',
 145     method => 'PUSH',
 146     description => "call API PUSH on <path>.",
 147     parameters => {
 148         additionalProperties => 0,
 149         properties => $path_properties,
 150     },
 151     returns => $path_returns,
 152     code => sub {
 153         my ($param) = @_;
 154
 155         return call_api_method('PUSH', $param);
 156     }});
 157
 158 __PACKAGE__->register_method ({
 159     name => 'pveclient_delete',
 160     path => 'pveclient_delete',
 161     method => 'DELETE',
 162     description => "call API DELETE on <path>.",
 163     parameters => {
 164         additionalProperties => 0,
 165         properties => $path_properties,
 166     },
 167     returns => $path_returns,
 168     code => sub {
 169         my ($param) = @_;
 170
 171         return call_api_method('DELETE', $param);
 172     }});
 173
 174
 175 our $cmddef = {
 176     config => $PVE::APIClient::Commands::config::cmddef,
 177     list => $PVE::APIClient::Commands::list::cmddef,
 178     lxc => $PVE::APIClient::Commands::lxc::cmddef,
 179     remote => $PVE::APIClient::Commands::remote::cmddef,
 180
 181     spice => [ 'PVE::APIClient::Commands::GuestStatus', 'spice', ['remote', 'vmid']],
 182     start => [ 'PVE::APIClient::Commands::GuestStatus', 'start', ['remote', 'vmid']],
 183     stop => [ 'PVE::APIClient::Commands::GuestStatus', 'stop', ['remote', 'vmid']],
 184
 185     api => {
 186         get => [ __PACKAGE__, 'pveclient_get', ['remote', 'api_path'], {}, $format_result ],
 187         set => [ __PACKAGE__, 'pveclient_set', ['remote', 'api_path'], {}, $format_result ],
 188         create => [ __PACKAGE__, 'pveclient_create', ['remote', 'api_path'], {}, $format_result ],
 189         delete => [ __PACKAGE__, 'pveclient_delete', ['remote', 'api_path'], {}, $format_result ],
 190     },
 191 };
 192
 193
 194 __PACKAGE__->run_cli_handler();