PVE/API2/Network/Transport.pm

   1 package PVE::API2::Network::Transport;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::SafeSyslog;
   7 use PVE::Tools qw(extract_param);
   8 use PVE::Cluster qw(cfs_read_file cfs_write_file);
   9 use PVE::Network::Transport;
  10 use PVE::Network::Transport::Plugin;
  11 use PVE::Network::Transport::VlanPlugin;
  12 use PVE::Network::Transport::VxlanMulticastPlugin;
  13 use Storable qw(dclone);
  14 use PVE::JSONSchema qw(get_standard_option);
  15 use PVE::RPCEnvironment;
  16
  17 use PVE::RESTHandler;
  18
  19 use base qw(PVE::RESTHandler);
  20
  21 my $transport_type_enum = PVE::Network::Transport::Plugin->lookup_types();
  22
  23 my $api_transport_config = sub {
  24     my ($cfg, $transportid) = @_;
  25
  26     my $scfg = dclone(PVE::Network::Transport::transport_config($cfg, $transportid));
  27     $scfg->{transport} = $transportid;
  28     $scfg->{digest} = $cfg->{digest};
  29
  30     return $scfg;
  31 };
  32
  33 __PACKAGE__->register_method ({
  34     name => 'index',
  35     path => '',
  36     method => 'GET',
  37     description => "Transport index.",
  38     permissions => {
  39         description => "Only list entries where you have 'NetworkTransport.Audit' or 'NetworkTransport.Allocate' permissions on '/cluster/network/transport/<transport>'",
  40         user => 'all',
  41     },
  42     parameters => {
  43         additionalProperties => 0,
  44         properties => {
  45             type => {
  46                 description => "Only list transport of specific type",
  47                 type => 'string',
  48                 enum => $transport_type_enum,
  49                 optional => 1,
  50             },
  51         },
  52     },
  53     returns => {
  54         type => 'array',
  55         items => {
  56             type => "object",
  57             properties => { transport => { type => 'string'} },
  58         },
  59         links => [ { rel => 'child', href => "{transport}" } ],
  60     },
  61     code => sub {
  62         my ($param) = @_;
  63
  64         my $rpcenv = PVE::RPCEnvironment::get();
  65         my $authuser = $rpcenv->get_user();
  66
  67
  68         my $cfg = PVE::Network::Transport::config();
  69
  70         my @sids = PVE::Network::Transport::transports_ids($cfg);
  71         my $res = [];
  72         foreach my $transportid (@sids) {
  73 #           my $privs = [ 'NetworkTransport.Audit', 'NetworkTransport.Allocate' ];
  74 #           next if !$rpcenv->check_any($authuser, "/cluster/network/transport/$transportid", $privs, 1);
  75
  76             my $scfg = &$api_transport_config($cfg, $transportid);
  77             next if $param->{type} && $param->{type} ne $scfg->{type};
  78             push @$res, $scfg;
  79         }
  80
  81         return $res;
  82     }});
  83
  84 __PACKAGE__->register_method ({
  85     name => 'read',
  86     path => '{transport}',
  87     method => 'GET',
  88     description => "Read transport configuration.",
  89 #    permissions => {
  90 #       check => ['perm', '/cluster/network/transport/{transport}', ['NetworkTransport.Allocate']],
  91 #   },
  92
  93     parameters => {
  94         additionalProperties => 0,
  95         properties => {
  96             transport => get_standard_option('pve-transport-id'),
  97         },
  98     },
  99     returns => { type => 'object' },
 100     code => sub {
 101         my ($param) = @_;
 102
 103         my $cfg = PVE::Network::Transport::config();
 104
 105         return &$api_transport_config($cfg, $param->{transport});
 106     }});
 107
 108 __PACKAGE__->register_method ({
 109     name => 'create',
 110     protected => 1,
 111     path => '',
 112     method => 'POST',
 113     description => "Create a new network transport.",
 114 #    permissions => {
 115 #       check => ['perm', '/cluster/network/transport', ['NetworkTransport.Allocate']],
 116 #    },
 117     parameters => PVE::Network::Transport::Plugin->createSchema(),
 118     returns => { type => 'null' },
 119     code => sub {
 120         my ($param) = @_;
 121
 122         my $type = extract_param($param, 'type');
 123         my $transportid = extract_param($param, 'transport');
 124
 125         my $plugin = PVE::Network::Transport::Plugin->lookup($type);
 126         my $opts = $plugin->check_config($transportid, $param, 1, 1);
 127
 128         PVE::Network::Transport::lock_transport_config(
 129             sub {
 130
 131                 my $cfg = PVE::Network::Transport::config();
 132
 133                 if (my $scfg = PVE::Network::Transport::transport_config($cfg, $transportid, 1)) {
 134                     die "network transport ID '$transportid' already defined\n";
 135                 }
 136
 137                 $cfg->{ids}->{$transportid} = $opts;
 138
 139                 #improveme:
 140                 #check local configuration of all nodes for conflict
 141
 142                 PVE::Network::Transport::write_config($cfg);
 143
 144             }, "create network transport failed");
 145
 146         return undef;
 147     }});
 148
 149 __PACKAGE__->register_method ({
 150     name => 'update',
 151     protected => 1,
 152     path => '{transport}',
 153     method => 'PUT',
 154     description => "Update network transport configuration.",
 155 #    permissions => {
 156 #       check => ['perm', '/cluster/network/transport', ['NetworkTransport.Allocate']],
 157 #    },
 158     parameters => PVE::Network::Transport::Plugin->updateSchema(),
 159     returns => { type => 'null' },
 160     code => sub {
 161         my ($param) = @_;
 162
 163         my $transportid = extract_param($param, 'transport');
 164         my $digest = extract_param($param, 'digest');
 165
 166         PVE::Network::Transport::lock_transport_config(
 167          sub {
 168
 169             my $cfg = PVE::Network::Transport::config();
 170
 171             PVE::SectionConfig::assert_if_modified($cfg, $digest);
 172
 173             my $scfg = PVE::Network::Transport::transport_config($cfg, $transportid);
 174
 175             my $plugin = PVE::Network::Transport::Plugin->lookup($scfg->{type});
 176             my $opts = $plugin->check_config($transportid, $param, 0, 1);
 177
 178             foreach my $k (%$opts) {
 179                 $scfg->{$k} = $opts->{$k};
 180             }
 181             #improveme:
 182             #add vlan/vxlan check on existingvnets
 183             #check local configuration of all nodes for conflict
 184             PVE::Network::Transport::write_config($cfg);
 185
 186             }, "update network transport failed");
 187
 188         return undef;
 189     }});
 190
 191 __PACKAGE__->register_method ({
 192     name => 'delete',
 193     protected => 1,
 194     path => '{transport}', # /cluster/network/transport/{transport}
 195     method => 'DELETE',
 196     description => "Delete network transport configuration.",
 197 #    permissions => {
 198 #       check => ['perm', '/cluster/network/transport', ['NetworkTransport.Allocate']],
 199 #    },
 200     parameters => {
 201         additionalProperties => 0,
 202         properties => {
 203             transport => get_standard_option('pve-transport-id', {
 204                 completion => \&PVE::Network::Transport::complete_transport,
 205             }),
 206         },
 207     },
 208     returns => { type => 'null' },
 209     code => sub {
 210         my ($param) = @_;
 211
 212         my $transportid = extract_param($param, 'transport');
 213
 214         PVE::Network::Transport::lock_transport_config(
 215             sub {
 216
 217                 my $cfg = PVE::Network::Transport::config();
 218
 219                 my $scfg = PVE::Network::Transport::transport_config($cfg, $transportid);
 220
 221 #               my $plugin = PVE::Network::Transport::Plugin->lookup($scfg->{type});
 222 #               $plugin->on_delete_hook($transportid, $scfg);
 223
 224                 delete $cfg->{ids}->{$transportid};
 225                 #improveme:
 226                 #check that vnet don't use this transport
 227                 PVE::Network::Transport::write_config($cfg);
 228
 229             }, "delete network transport failed");
 230
 231
 232         return undef;
 233     }});
 234
 235 1;