]> git.proxmox.com Git - pve-docs.git/blobdiff - pct.1-synopsis.adoc
btrfs: document df weirdness and how to better get usage
[pve-docs.git] / pct.1-synopsis.adoc
index 5630a986684c1676dabaf20b85b8edd51b02495d..fc47231419b61bf16e08edf1dbc8e52104c38aeb 100644 (file)
@@ -104,11 +104,11 @@ Console mode. By default, the console command tries to open a connection to one
 
 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.
 +
@@ -120,11 +120,15 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 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.
+Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
-`--features` `[fuse=<1|0>] [,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.
 
@@ -154,7 +158,7 @@ Amount of RAM for the VM in MB.
 
 `--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>` ::
 
@@ -168,7 +172,7 @@ Specifies network interfaces for the container.
 
 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.
 
@@ -216,10 +220,18 @@ Default Storage.
 
 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
@@ -234,7 +246,7 @@ NOTE: Requires option(s): `restore`
 
 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.
 
@@ -262,9 +274,17 @@ Destroy the container (also delete all uses files).
 
 The (unique) ID of the VM.
 
-`--purge` `<boolean>` ::
+`--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.
 
-Remove vmid from backup cron jobs.
+`--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>`
 
@@ -310,7 +330,7 @@ A volume on which to run the filesystem check
 
 Force checking, even if the filesystem seems clean
 
-*pct fstrim* `<vmid>`
+*pct fstrim* `<vmid>` `[OPTIONS]`
 
 Run fstrim on a chosen CT and its mountpoints.
 
@@ -318,6 +338,10 @@ Run fstrim on a chosen CT and its mountpoints.
 
 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.
@@ -358,10 +382,6 @@ Target node.
 
 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.
-
 `--online` `<boolean>` ::
 
 Use online/live migration.
@@ -476,6 +496,19 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 
 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.
@@ -536,11 +569,11 @@ Console mode. By default, the console command tries to open a connection to one
 
 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.
 +
@@ -552,11 +585,15 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 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.
+Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
-`--features` `[fuse=<1|0>] [,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.
 
@@ -586,7 +623,7 @@ Amount of RAM for the VM in MB.
 
 `--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>` ::
 
@@ -600,7 +637,7 @@ Specifies network interfaces for the container.
 
 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.
 
@@ -644,10 +681,18 @@ Default Storage.
 
 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
@@ -662,7 +707,7 @@ NOTE: Requires option(s): `restore`
 
 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.
 
@@ -706,11 +751,11 @@ Console mode. By default, the console command tries to open a connection to one
 
 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.
 +
@@ -722,19 +767,23 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 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.
 
 `--description` `<string>` ::
 
-Container description. Only used on the configuration web interface.
+Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
 `--digest` `<string>` ::
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 
-`--features` `[fuse=<1|0>] [,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.
 
@@ -756,7 +805,7 @@ Amount of RAM for the VM in MB.
 
 `--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>` ::
 
@@ -770,7 +819,7 @@ Specifies network interfaces for the container.
 
 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.
 
@@ -798,10 +847,18 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
 
 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
@@ -810,7 +867,7 @@ 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.
 
@@ -855,6 +912,10 @@ Start the container.
 
 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.