VMID for the clone.
+`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--description` `<string>` ::
Description for the new CT.
Target node. Only allowed if the original VM is on shared storage.
-*pct config* `<vmid>`
+*pct config* `<vmid>` `[OPTIONS]`
Get container configuration.
The (unique) ID of the VM.
+`--current` `<boolean>` ('default =' `0`)::
+
+Get current values (instead of pending values).
+
+`--snapshot` `<string>` ::
+
+Fetch config values from given snapshot.
+
*pct console* `<vmid>` `[OPTIONS]`
Launch a console for the specified container.
OS architecture type.
-`--bwlimit` `<number> (0 - N)` ::
+`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
-Override i/o bandwidth limit (in KiB/s).
+Override I/O bandwidth limit (in KiB/s).
`--cmode` `<console | shell | tty>` ('default =' `tty`)::
Attach a console device (/dev/console) to the container.
-`--cores` `<integer> (1 - 128)` ::
+`--cores` `<integer> (1 - 8192)` ::
The number of cores assigned to the container. A container can use all available cores by default.
-`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
+`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
Limit of CPU usage.
+
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
`--description` `<string>` ::
Container description. Only used on the configuration web interface.
-`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
Allow to overwrite existing container.
+`--hookscript` `<string>` ::
+
+Script that will be exectued during various steps in the containers lifetime.
+
`--hostname` `<string>` ::
Set a host name for the container.
Ignore errors when extracting the template.
-`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
Lock/unlock the VM.
Amount of RAM for the VM in MB.
-`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
`--nameserver` `<string>` ::
Specifies whether a VM will be started during system bootup.
-`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
Mark this as restore task.
-`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
Amount of SWAP for the VM in MB.
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
`--template` `<boolean>` ('default =' `0`)::
Enable/disable Template.
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
`--tty` `<integer> (0 - 6)` ('default =' `2`)::
Specify the number of tty available to the container
+`--unique` `<boolean>` ::
+
+Assign a unique random ethernet address.
++
+NOTE: Requires option(s): `restore`
+
`--unprivileged` `<boolean>` ('default =' `0`)::
Makes the container run as unprivileged user. (Should not be modified manually.)
-`--unused[n]` `<string>` ::
+`--unused[n]` `[volume=]<volume>` ::
Reference to unused volumes. This is used internally, and should not be modified manually.
For removal from config file, even if removing disk snapshots fails.
-*pct destroy* `<vmid>`
+*pct destroy* `<vmid>` `[OPTIONS]`
Destroy the container (also delete all uses files).
The (unique) ID of the VM.
+`--destroy-unreferenced-disks` `<boolean>` ::
+
+If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
+
+`--force` `<boolean>` ('default =' `0`)::
+
+Force destroy, even if running.
+
+`--purge` `<boolean>` ('default =' `0`)::
+
+Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
+
*pct df* `<vmid>`
Get the container's current disk usage.
Force checking, even if the filesystem seems clean
+*pct fstrim* `<vmid>` `[OPTIONS]`
+
+Run fstrim on a chosen CT and its mountpoints.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`--ignore-mountpoints` `<boolean>` ::
+
+Skip all mountpoints, only do fstrim on the container root.
+
*pct help* `[OPTIONS]`
Get help about specified command.
Target node.
+`--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--force` `<boolean>` ::
Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
Target Storage.
+`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--delete` `<boolean>` ('default =' `0`)::
Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+*pct pending* `<vmid>`
+
+Get container configuration, including pending changes.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
Copy a file from the container to the local system.
Owner user name or id. When using a name it must exist inside the container.
+*pct reboot* `<vmid>` `[OPTIONS]`
+
+Reboot the container by shutting it down, and starting it again. Applies
+pending changes.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`--timeout` `<integer> (0 - N)` ::
+
+Wait maximal timeout seconds for the shutdown.
+
+*pct rescan* `[OPTIONS]`
+
+Rescan all storages and update disk sizes and unused disk images.
+
+`--dryrun` `<boolean>` ('default =' `0`)::
+
+Do not actually write changes out to conifg.
+
+`--vmid` `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
Resize a container mount point.
OS architecture type.
-`--bwlimit` `<number> (0 - N)` ::
+`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
-Override i/o bandwidth limit (in KiB/s).
+Override I/O bandwidth limit (in KiB/s).
`--cmode` `<console | shell | tty>` ('default =' `tty`)::
Attach a console device (/dev/console) to the container.
-`--cores` `<integer> (1 - 128)` ::
+`--cores` `<integer> (1 - 8192)` ::
The number of cores assigned to the container. A container can use all available cores by default.
-`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
+`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
Limit of CPU usage.
+
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
`--description` `<string>` ::
Container description. Only used on the configuration web interface.
-`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
Allow to overwrite existing container.
+`--hookscript` `<string>` ::
+
+Script that will be exectued during various steps in the containers lifetime.
+
`--hostname` `<string>` ::
Set a host name for the container.
Ignore errors when extracting the template.
-`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
Lock/unlock the VM.
Amount of RAM for the VM in MB.
-`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
`--nameserver` `<string>` ::
Specifies whether a VM will be started during system bootup.
-`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
-`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
Amount of SWAP for the VM in MB.
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
`--template` `<boolean>` ('default =' `0`)::
Enable/disable Template.
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
`--tty` `<integer> (0 - 6)` ('default =' `2`)::
Specify the number of tty available to the container
+`--unique` `<boolean>` ::
+
+Assign a unique random ethernet address.
++
+NOTE: Requires option(s): `restore`
+
`--unprivileged` `<boolean>` ('default =' `0`)::
Makes the container run as unprivileged user. (Should not be modified manually.)
-`--unused[n]` `<string>` ::
+`--unused[n]` `[volume=]<volume>` ::
Reference to unused volumes. This is used internally, and should not be modified manually.
Attach a console device (/dev/console) to the container.
-`--cores` `<integer> (1 - 128)` ::
+`--cores` `<integer> (1 - 8192)` ::
The number of cores assigned to the container. A container can use all available cores by default.
-`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
+`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
Limit of CPU usage.
+
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
`--delete` `<string>` ::
A list of settings you want to delete.
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
+`--hookscript` `<string>` ::
+
+Script that will be exectued during various steps in the containers lifetime.
+
`--hostname` `<string>` ::
Set a host name for the container.
-`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
+`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
Lock/unlock the VM.
Amount of RAM for the VM in MB.
-`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
`--nameserver` `<string>` ::
Specifies whether a VM will be started during system bootup.
-`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
-`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
+`--revert` `<string>` ::
+
+Revert a pending change.
+
+`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
Amount of SWAP for the VM in MB.
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
`--template` `<boolean>` ('default =' `0`)::
Enable/disable Template.
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
`--tty` `<integer> (0 - 6)` ('default =' `2`)::
Specify the number of tty available to the container
Makes the container run as unprivileged user. (Should not be modified manually.)
-`--unused[n]` `<string>` ::
+`--unused[n]` `[volume=]<volume>` ::
Reference to unused volumes. This is used internally, and should not be modified manually.
The (unique) ID of the VM.
+`--debug` `<boolean>` ('default =' `0`)::
+
+If set, enables very verbose debug log-level on start.
+
`--skiplock` `<boolean>` ::
Ignore locks - only root is allowed to use this option.