]> git.proxmox.com Git - pve-container.git/blobdiff - src/PVE/CLI/pct.pm
close #1940: pct console: added ability to specify escape sequence
[pve-container.git] / src / PVE / CLI / pct.pm
index 1c04329ff732499375878933d2590a111f6a23cb..9d3a2301ff3b6a6da61bde3064188d6609cd68e5 100755 (executable)
@@ -6,10 +6,10 @@ use warnings;
 use POSIX;
 use Fcntl;
 use File::Copy 'copy';
-use Term::ReadLine;
 
 use PVE::SafeSyslog;
 use PVE::Tools qw(extract_param);
+use PVE::CpuSet;
 use PVE::Cluster;
 use PVE::INotify;
 use PVE::RPCEnvironment;
@@ -32,24 +32,60 @@ my $upid_exit = sub {
     exit($status eq 'OK' ? 0 : -1);
 };
 
-sub read_password {
-    my $term = new Term::ReadLine ('pct');
-    my $attribs = $term->Attribs;
-    $attribs->{redisplay_function} = $attribs->{shadow_redisplay};
-    my $input = $term->readline('Enter password: ');
-    my $conf = $term->readline('Retype password: ');
-    die "Passwords do not match.\n" if ($input ne $conf);
-    return $input;
+sub setup_environment {
+    PVE::RPCEnvironment->setup_default_cli_env();
 }
 
-sub string_param_file_mapping {
+__PACKAGE__->register_method ({
+    name => 'status',
+    path => 'status',
+    method => 'GET',
+    description => "Show CT status.",
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
+           verbose => {
+               description => "Verbose output format",
+               type => 'boolean',
+               optional => 1,
+           }
+       },
+    },
+    returns => { type => 'null'},
+    code => sub {
+       my ($param) = @_;
+
+       # test if CT exists
+       my $conf = PVE::LXC::Config->load_config ($param->{vmid});
+
+       my $vmstatus = PVE::LXC::vmstatus($param->{vmid});
+       my $stat = $vmstatus->{$param->{vmid}};
+       if ($param->{verbose}) {
+           foreach my $k (sort (keys %$stat)) {
+               my $v = $stat->{$k};
+               next if !defined($v);
+               print "$k: $v\n";
+           }
+       } else {
+           my $status = $stat->{status} || 'unknown';
+           print "status: $status\n";
+       }
+
+       return undef;
+    }});
+
+sub param_mapping {
     my ($name) = @_;
 
     my $mapping = {
-       'create_vm' => ['ssh-public-keys'],
+       'create_vm' => [
+           PVE::CLIHandler::get_standard_mapping('pve-password'),
+           'ssh-public-keys',
+       ],
     };
 
-    return defined($mapping->{$name}) ? $mapping->{$name} : [];
+    return $mapping->{$name};
 }
 
 __PACKAGE__->register_method ({
@@ -83,6 +119,13 @@ __PACKAGE__->register_method ({
        additionalProperties => 0,
        properties => {
            vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid_running }),
+           escape => {
+               description => "Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.",
+               default =>  '^a',
+               type => 'string',
+               pattern => '\^?[a-z]',
+               optional => 1,
+           },
        },
     },
     returns => { type => 'null' },
@@ -93,7 +136,7 @@ __PACKAGE__->register_method ({
        # test if container exists on this node
        my $conf = PVE::LXC::Config->load_config($param->{vmid});
 
-       my $cmd = PVE::LXC::get_console_command($param->{vmid}, $conf);
+       my $cmd = PVE::LXC::get_console_command($param->{vmid}, $conf, $param->{escape});
        exec(@$cmd);
     }});
 
@@ -188,7 +231,7 @@ __PACKAGE__->register_method ({
            my $conf = PVE::LXC::Config->load_config($vmid);
            my $storage_cfg = PVE::Storage::config();
 
-           defined($conf->{$device}) || die "cannot run command on unexisting mountpoint $device\n";
+           defined($conf->{$device}) || die "cannot run command on non-existing mount point $device\n";
 
            my $mount_point = $device eq 'rootfs' ? PVE::LXC::Config->parse_ct_rootfs($conf->{$device}) :
                PVE::LXC::Config->parse_ct_mountpoint($conf->{$device});
@@ -253,6 +296,8 @@ __PACKAGE__->register_method({
            my $conf = PVE::LXC::Config->set_lock($vmid, 'mounted');
            PVE::LXC::mount_all($vmid, $storecfg, $conf);
        });
+
+       print "mounted CT $vmid in '/var/lib/lxc/$vmid/rootfs'\n";
        return undef;
     }});
 
@@ -283,6 +328,89 @@ __PACKAGE__->register_method({
        return undef;
     }});
 
+__PACKAGE__->register_method({
+    name => 'df',
+    path => 'df',
+    method => 'GET',
+    description => "Get the container's current disk usage.",
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
+       },
+    },
+    returns => { type => 'null' },
+    code => sub {
+       my ($param) = @_;
+
+       my $rpcenv = PVE::RPCEnvironment::get();
+
+       # JSONSchema's format_size is exact, this uses floating point numbers
+       my $format = sub {
+           my ($size) = @_;
+           return $size if $size < 1024.;
+           $size /= 1024.;
+           return sprintf('%.1fK', ${size}) if $size < 1024.;
+           $size /= 1024.;
+           return sprintf('%.1fM', ${size}) if $size < 1024.;
+           $size /= 1024.;
+           return sprintf('%.1fG', ${size}) if $size < 1024.;
+           $size /= 1024.;
+           return sprintf('%.1fT', ${size}) if $size < 1024.;
+       };
+
+       my $vmid = extract_param($param, 'vmid');
+       PVE::LXC::Config->lock_config($vmid, sub {
+           my $pid = eval { PVE::LXC::find_lxc_pid($vmid) };
+           my ($conf, $rootdir, $storecfg, $mounted);
+           if ($@ || !$pid) {
+               $conf = PVE::LXC::Config->set_lock($vmid, 'mounted');
+               $rootdir = "/var/lib/lxc/$vmid/rootfs";
+               $storecfg = PVE::Storage::config();
+               PVE::LXC::mount_all($vmid, $storecfg, $conf);
+               $mounted = 1;
+           } else {
+               $conf = PVE::LXC::Config->load_config($vmid);
+               $rootdir = "/proc/$pid/root";
+           }
+
+           my @list = [qw(MP Volume Size Used Avail Use% Path)];
+           my @len = map { length($_) } @{$list[0]};
+
+           eval {
+               PVE::LXC::Config->foreach_mountpoint($conf, sub {
+                   my ($name, $mp) = @_;
+                   my $path = $mp->{mp};
+
+                   my $df = PVE::Tools::df("$rootdir/$path", 3);
+                   my $total = $format->($df->{total});
+                   my $used = $format->($df->{used});
+                   my $avail = $format->($df->{avail});
+
+                   my $pc = sprintf('%.1f', $df->{used}/$df->{total});
+
+                   my $entry = [ $name, $mp->{volume}, $total, $used, $avail, $pc, $path ];
+                   push @list, $entry;
+
+                   foreach my $i (0..5) {
+                       $len[$i] = length($entry->[$i])
+                           if $len[$i] < length($entry->[$i]);
+                   }
+               });
+
+               my $format = "%-$len[0]s %-$len[1]s %$len[2]s %$len[3]s %$len[4]s %$len[5]s %s\n";
+               printf($format, @$_) foreach @list;
+           };
+           warn $@ if $@;
+
+           if ($mounted) {
+               PVE::LXC::umount_all($vmid, $storecfg, $conf, 0);
+               PVE::LXC::Config->remove_lock($vmid, 'mounted');
+           }
+       });
+       return undef;
+    }});
+
 # File creation with specified ownership and permissions.
 # User and group can be names or decimal numbers.
 # Permissions are explicit (not affected by umask) and can be numeric with the
@@ -369,7 +497,7 @@ __PACKAGE__->register_method({
            },
            perms => {
                type => 'string',
-               description => 'File permissions to use.',
+               description => "File permissions to use (octal by default, prefix with '0x' for hexadecimal).",
                optional => 1,
            },
        },
@@ -388,6 +516,8 @@ __PACKAGE__->register_method({
        my $dest = extract_param($param, 'destination');
 
        my $perms = extract_param($param, 'perms');
+       # assume octal as default
+       $perms = "0$perms" if defined($perms) && $perms !~m/^0/;
        my $user = extract_param($param, 'user');
        my $group = extract_param($param, 'group');
 
@@ -450,7 +580,7 @@ __PACKAGE__->register_method({
            },
            perms => {
                type => 'string',
-               description => 'File permissions to use.',
+               description => "File permissions to use (octal by default, prefix with '0x' for hexadecimal).",
                optional => 1,
            },
        },
@@ -469,12 +599,14 @@ __PACKAGE__->register_method({
        my $dest = extract_param($param, 'destination');
 
        my $perms = extract_param($param, 'perms');
+       # assume octal as default
+       $perms = "0$perms" if defined($perms) && $perms !~m/^0/;
        my $user = extract_param($param, 'user');
        my $group = extract_param($param, 'group');
 
        my $code = sub {
            my $running = PVE::LXC::check_running($vmid);
-           die "can only push files to a running VM" if !$running;
+           die "can only push files to a running CT\n" if !$running;
 
            my $conf = PVE::LXC::Config->load_config($vmid);
            my $unprivileged = $conf->{unprivileged};
@@ -523,6 +655,73 @@ __PACKAGE__->register_method({
        return PVE::LXC::Config->lock_config($vmid, $code);
     }});
 
+__PACKAGE__->register_method ({
+    name => 'cpusets',
+    path => 'cpusets',
+    method => 'GET',
+    description => "Print the list of assigned CPU sets.",
+    parameters => {
+       additionalProperties => 0,
+       properties => {},
+    },
+    returns => { type => 'null'},
+    code => sub {
+       my ($param) = @_;
+
+       my $cgv1 = PVE::LXC::get_cgroup_subsystems();
+       if (!$cgv1->{cpuset}) {
+           print "cpuset cgroup not available\n";
+           return undef;
+       }
+
+       my $ctlist = PVE::LXC::config_list();
+
+       my $len = 0;
+       my $id_len = 0;
+       my $res = {};
+
+       foreach my $vmid (sort keys %$ctlist) {
+           next if ! -d "/sys/fs/cgroup/cpuset/lxc/$vmid";
+
+           my $cpuset = eval { PVE::CpuSet->new_from_cgroup("lxc/$vmid"); };
+           if (my $err = $@) {
+               warn $err;
+               next;
+           }
+           my @cpuset_members = $cpuset->members();
+
+           my $line = ': ';
+
+           my $last = $cpuset_members[-1];
+
+           for (my $id = 0; $id <= $last; $id++) {
+               my $empty = ' ' x length("$id");
+               $line .= ' ' . ($cpuset->has($id) ? $id : $empty);
+           }
+           $len = length($line) if length($line) > $len;
+           $id_len = length($vmid) if length($vmid) > $id_len;
+
+           $res->{$vmid} = $line;
+       }
+
+       my @vmlist = sort keys %$res;
+
+       if (scalar(@vmlist)) {
+           my $header = '-' x ($len + $id_len) . "\n";
+
+           print $header;
+           foreach my $vmid (@vmlist) {
+               print sprintf("%${id_len}i%s\n", $vmid, $res->{$vmid});
+           }
+           print $header;
+
+       } else {
+           print "no running containers\n";
+       }
+
+       return undef;
+    }});
+
 our $cmddef = {
     list=> [ 'PVE::API2::LXC', 'vmlist', [], { node => $nodename }, sub {
        my $res = shift;
@@ -538,12 +737,19 @@ our $cmddef = {
                    my $config = shift;
                    foreach my $k (sort (keys %$config)) {
                        next if $k eq 'digest';
+                       next if $k eq 'lxc';
                        my $v = $config->{$k};
                        if ($k eq 'description') {
                            $v = PVE::Tools::encode_text($v);
                        }
                        print "$k: $v\n";
                    }
+                   if (defined($config->{'lxc'})) {
+                       my $lxc_list = $config->{'lxc'};
+                       foreach my $lxc_opt (@$lxc_list) {
+                           print "$lxc_opt->[0]: $lxc_opt->[1]\n"
+                       }
+                   }
                }],
     set => [ 'PVE::API2::LXC::Config', 'update_vm', ['vmid'], { node => $nodename }],
 
@@ -560,7 +766,9 @@ our $cmddef = {
     
     clone => [ "PVE::API2::LXC", 'clone_vm', ['vmid', 'newid'], { node => $nodename }, $upid_exit ],
     migrate => [ "PVE::API2::LXC", 'migrate_vm', ['vmid', 'target'], { node => $nodename }, $upid_exit],
+    move_volume => [ "PVE::API2::LXC", 'move_volume', ['vmid', 'volume', 'storage'], { node => $nodename }, $upid_exit ],
     
+    status => [ __PACKAGE__, 'status', ['vmid']],
     console => [ __PACKAGE__, 'console', ['vmid']],
     enter => [ __PACKAGE__, 'enter', ['vmid']],
     unlock => [ __PACKAGE__, 'unlock', ['vmid']],
@@ -571,7 +779,9 @@ our $cmddef = {
     unmount => [ __PACKAGE__, 'unmount', ['vmid']],
     push => [ __PACKAGE__, 'push', ['vmid', 'file', 'destination']],
     pull => [ __PACKAGE__, 'pull', ['vmid', 'path', 'destination']],
-    
+
+    df => [ __PACKAGE__, 'df', ['vmid']],
+
     destroy => [ 'PVE::API2::LXC', 'destroy_vm', ['vmid'], 
                 { node => $nodename }, $upid_exit ],
 
@@ -594,69 +804,10 @@ our $cmddef = {
     rollback => [ "PVE::API2::LXC::Snapshot", 'rollback', ['vmid', 'snapname'], { node => $nodename } , $upid_exit ],
 
     template => [ "PVE::API2::LXC", 'template', ['vmid'], { node => $nodename }],
-};
-
-
-1;
-
-__END__
-
-=head1 NAME
-
-pct - Tool to manage Linux Containers (LXC) on Proxmox VE
-
-=head1 SYNOPSIS
-
-=include synopsis
-
-=head1 DESCRIPTION
-
-pct is a tool to manages Linux Containers (LXC). You can create
-and destroy containers, and control execution
-(start/stop/suspend/resume). Besides that, you can use pct to set
-parameters in the associated config file, like network configuration or
-memory.
-
-=head1 EXAMPLES
-
-Create a container based on a Debian template
-(provided you downloaded the template via the webgui before)
-
-pct create 100 /var/lib/vz/template/cache/debian-8.0-standard_8.0-1_amd64.tar.gz
 
-Start a container
+    cpusets => [ __PACKAGE__, 'cpusets', []],
 
-pct start 100
-
-Start a login session via getty
-
-pct console 100
-
-Enter the lxc namespace and run a shell as root user
-
-pct enter 100
-
-Display the configuration
-
-pct config 100
-
-Add a network interface called eth0, bridged to the host bridge vmbr0,
-set the address and gateway, while it's running
-
-pct set 100 -net0 name=eth0,bridge=vmbr0,ip=192.168.15.147/24,gw=192.168.15.1
-
-Reduce the memory of the container to 512MB
-
-pct set -memory 512 100
-
-=head1 FILES
-
-/etc/pve/lxc/<vmid>.conf
-
-Configuration file for the container <vmid>
-
-=head1 SEE ALSO
+};
 
-L<B<qm(1)>>, L<B<pvesh(1)>>
 
-=include pve_copyright
+1;