NAME

pvectl - vzctl wrapper to manage OpenVZ containers


SYNOPSIS

 pvectl <COMMAND> [ARGS] [OPTIONS]
 pvectl config <vmid>
 
   Get container configuration.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 pvectl create <vmid> <ostemplate> [OPTIONS]
 
   Create or restore a container.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 
   <ostemplate> string
 
             The OS template or backup file.
 
   -cpus      integer (1 - N)   (default=1)
 
             The number of CPUs for this container.
 
   -cpuunits  integer (0 - 500000)   (default=1000)
 
             CPU weight for a VM. Argument is used in the kernel fair
             scheduler. The larger the number is, the more CPU time this VM
             gets. Number is relative to weights of all the other running
             VMs.
             
             NOTE: You can disable fair-scheduler configuration by setting
             this to 0.
 
   -description string
 
             Container description. Only used on the configuration web
             interface.
 
   -disk      number (0 - N)   (default=2)
 
             Amount of disk space for the VM in GB. A zero indicates no
             limits.
 
   -force     boolean
 
             Allow to overwrite existing container.
 
   -hostname  string
 
             Set a host name for the container.
 
   -ip_address string
 
             Specifies the address the container will be assigned.
 
   -memory    integer (16 - N)  (default=512)
 
             Amount of RAM for the VM in MB.
 
   -nameserver string
 
             Sets DNS server IP address for a container. Create will
             automatically use the setting from the host if you neither set
             searchdomain or nameserver.
 
   -netif     string
 
             Specifies network interfaces for the container.
 
   -onboot    boolean   (default=0)
 
             Specifies whether a VM will be started during system bootup.
 
   -password  string
 
             Sets root password inside container.
 
   -pool      string
 
             Add the VM to the specified pool.
 
   -quotatime integer (0 - N)   (default=0)
 
             Set quota grace period (seconds).
 
   -quotaugidlimit integer (0 - N)   (default=0)
 
             Set maximum number of user/group IDs in a container for which
             disk quota inside the container will be accounted. If this
             value is set to 0, user and group quotas inside the container
             will not.
 
   -restore   boolean
 
             Mark this as restore task.
 
   -searchdomain string
 
             Sets DNS search domains for a container. Create will
             automatically use the setting from the host if you neither set
             searchdomain or nameserver.
 
   -storage   string   (default=local)
 
             Target storage.
 
   -swap      integer (0 - N)   (default=512)
 
             Amount of SWAP for the VM in MB.
 pvectl destroy <vmid>
 
   Destroy the container (also delete all uses files).
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 pvectl list 
 
   OpenVZ container index (per node).
 pvectl migrate <vmid> <target> [OPTIONS]
 
   Migrate the container to another node. Creates a new migration task.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 
   <target>   string
 
             Target node.
 
   -online    boolean
 
             Use online/live migration.
 pvectl mount <vmid>
 
   Mounts container private area.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 pvectl set <vmid> [OPTIONS]
 
   Set virtual machine options.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 
   -cpus      integer (1 - N)   (default=1)
 
             The number of CPUs for this container.
 
   -cpuunits  integer (0 - 500000)   (default=1000)
 
             CPU weight for a VM. Argument is used in the kernel fair
             scheduler. The larger the number is, the more CPU time this VM
             gets. Number is relative to weights of all the other running
             VMs.
             
             NOTE: You can disable fair-scheduler configuration by setting
             this to 0.
 
   -description string
 
             Container description. Only used on the configuration web
             interface.
 
   -digest    string
 
             Prevent changes if current configuration file has different
             SHA1 digest. This can be used to prevent concurrent
             modifications.
 
   -disk      number (0 - N)   (default=2)
 
             Amount of disk space for the VM in GB. A zero indicates no
             limits.
 
   -hostname  string
 
             Set a host name for the container.
 
   -ip_address string
 
             Specifies the address the container will be assigned.
 
   -memory    integer (16 - N)  (default=512)
 
             Amount of RAM for the VM in MB.
 
   -nameserver string
 
             Sets DNS server IP address for a container. Create will
             automatically use the setting from the host if you neither set
             searchdomain or nameserver.
 
   -netif     string
 
             Specifies network interfaces for the container.
 
   -onboot    boolean   (default=0)
 
             Specifies whether a VM will be started during system bootup.
 
   -quotatime integer (0 - N)   (default=0)
 
             Set quota grace period (seconds).
 
   -quotaugidlimit integer (0 - N)   (default=0)
 
             Set maximum number of user/group IDs in a container for which
             disk quota inside the container will be accounted. If this
             value is set to 0, user and group quotas inside the container
             will not.
 
   -searchdomain string
 
             Sets DNS search domains for a container. Create will
             automatically use the setting from the host if you neither set
             searchdomain or nameserver.
 
   -swap      integer (0 - N)   (default=512)
 
             Amount of SWAP for the VM in MB.
 pvectl shutdown <vmid> [OPTIONS]
 
   Shutdown the container.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 
   -forceStop boolean   (default=0)
 
             Make sure the Container stops.
 
   -timeout   integer (0 - N)   (default=60)
 
             Wait maximal timeout seconds.
 pvectl start <vmid>
 
   Start the container.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 pvectl stop <vmid>
 
   Stop the container.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 pvectl umount <vmid>
 
   Unmounts container private area.
 
   <vmid>     integer (1 - N)
 
             The (unique) ID of the VM.
 pvectl help [<cmd>] [OPTIONS]
 
   Get help about specified command.
 
   <cmd>      string
 
             Command name
 
   -verbose   boolean
 
             Verbose output format.


DESCRIPTION

This is a small wrapper around vztl.


COPYRIGHT AND DISCLAIMER

Copyright (C) 2007-2011 Proxmox Server Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.