PVE/APIClient/Commands/remote.pm

   1 package PVE::APIClient::Commands::remote;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::JSONSchema qw(get_standard_option);
   7 use PVE::Tools qw(extract_param);
   8 use PVE::APIClient::Config;
   9
  10 use PVE::CLIHandler;
  11
  12 use PVE::APIClient::LWP;
  13 use PVE::PTY ();
  14
  15 use base qw(PVE::CLIHandler);
  16
  17 sub read_password {
  18    return PVE::PTY::read_password("Remote password: ")
  19 }
  20
  21 __PACKAGE__->register_method ({
  22     name => 'list',
  23     path => 'list',
  24     method => 'GET',
  25     description => "List remotes from your config file.",
  26     parameters => {
  27         additionalProperties => 0,
  28     },
  29     returns => { type => 'null' },
  30     code => sub {
  31         my $config = PVE::APIClient::Config->load();
  32
  33         printf("%10s %10s %10s %10s %100s\n", "Name", "Host", "Port", "Username", "Fingerprint");
  34         for my $name (keys %{$config->{ids}}) {
  35             my $remote = $config->{ids}->{$name};
  36             printf("%10s %10s %10s %10s %100s\n", $name, $remote->{'host'},
  37                    $remote->{'port'} // '-', $remote->{'username'}, $remote->{'fingerprint'} // '-');
  38         }
  39
  40         return undef;
  41     }});
  42
  43 __PACKAGE__->register_method ({
  44     name => 'add',
  45     path => 'add',
  46     method => 'POST',
  47     description => "Add a remote to your config file.",
  48     parameters => PVE::APIClient::Config->createSchema(1),
  49     returns => { type => 'null'},
  50     code => sub {
  51         my ($param) = @_;
  52
  53         # fixme: lock config file
  54
  55         my $remote = $param->{name};
  56
  57         my $config = PVE::APIClient::Config->load();
  58
  59         die "Remote '$remote' already exists\n"
  60             if $config->{ids}->{$remote};
  61
  62         my $last_fp = 0;
  63
  64         my $setup = {
  65             username                => $param->{username},
  66             password                => $param->{password},
  67             host                    => $param->{host},
  68             port                    => $param->{port} // 8006,
  69         };
  70
  71         if ($param->{fingerprint}) {
  72             $setup->{cached_fingerprints} = {
  73                 $param->{fingerprint} => 1,
  74             };
  75         } else {
  76             $setup->{manual_verification} = 1;
  77             $setup->{register_fingerprint_cb} = sub {
  78                 my $fp = shift @_;
  79                 $last_fp = $fp;
  80             };
  81         }
  82
  83         my $api = PVE::APIClient::LWP->new(
  84             manual_verification     => 1,
  85             register_fingerprint_cb => sub {
  86                 my $fp = shift @_;
  87                 $last_fp = $fp;
  88             },
  89         );
  90         $api->login();
  91
  92         $param->{fingerprint} = $last_fp if !defined($param->{fingerprint});
  93         my $plugin = PVE::APIClient::Config->lookup('remote');
  94         my $opts = $plugin->check_config($remote, $param, 1, 1);
  95         $config->{ids}->{$remote} = $opts;
  96
  97         PVE::APIClient::Config->save($config);
  98
  99         return undef;
 100     }});
 101
 102 __PACKAGE__->register_method ({
 103     name => 'update',
 104     path => 'update',
 105     method => 'PUT',
 106     description => "Update a remote configuration.",
 107     parameters => PVE::APIClient::Config->updateSchema(1),
 108     returns => { type => 'null'},
 109     code => sub {
 110         my ($param) = @_;
 111
 112         # fixme: lock config file
 113
 114         my $name = extract_param($param, 'name');
 115         my $digest = extract_param($param, 'digest');
 116         my $delete = extract_param($param, 'delete');
 117
 118         my $config = PVE::APIClient::Config->load();
 119         my $remote = PVE::APIClient::Config->lookup_remote($config, $name);
 120
 121         my $plugin = PVE::APIClient::Config->lookup('remote');
 122         my $opts = $plugin->check_config($name, $param, 0, 1);
 123
 124         foreach my $k (%$opts) {
 125             $remote->{$k} = $opts->{$k};
 126         }
 127
 128         if ($delete) {
 129             my $options = $plugin->private()->{options}->{'remote'};
 130             foreach my $k (PVE::Tools::split_list($delete)) {
 131                 my $d = $options->{$k} ||
 132                     die "no such option '$k'\n";
 133                 die "unable to delete required option '$k'\n"
 134                     if !$d->{optional};
 135                 die "unable to delete fixed option '$k'\n"
 136                     if $d->{fixed};
 137                 delete $remote->{$k};
 138             }
 139         }
 140
 141         PVE::APIClient::Config->save($config);
 142
 143         return undef;
 144     }});
 145
 146 __PACKAGE__->register_method ({
 147     name => 'remove',
 148     path => 'remove',
 149     method => 'DELETE',
 150     description => "Removes a remote from your config file.",
 151     parameters => {
 152         additionalProperties => 0,
 153         properties => {
 154             name => get_standard_option('pveclient-remote-name'),
 155         },
 156     },
 157     returns => { type => 'null'},
 158     code => sub {
 159         my ($param) = @_;
 160
 161         # fixme: lock config
 162
 163         my $config = PVE::APIClient::Config->load();
 164         delete $config->{ids}->{$param->{name}};
 165         PVE::APIClient::Config->save($config);
 166
 167         return undef;
 168     }});
 169
 170 our $cmddef = {
 171     add => [ __PACKAGE__, 'add', ['name', 'host', 'username']],
 172     update => [ __PACKAGE__, 'update', ['name']],
 173     remove => [ __PACKAGE__, 'remove', ['name']],
 174     list => [__PACKAGE__, 'list'],
 175 };
 176
 177 1;