X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pct.1-synopsis.adoc;h=b756e1532f70be6efe2d4865fd86d96565dd2a1e;hb=12804f688fe4a0a4d6affb94174b0242259588f8;hp=014a655a533fd2dbcdbc03896987b3cc1992c259;hpb=04d22a9f9411585e28337525caf166b454f56add;p=pve-docs.git diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 014a655..b756e15 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -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` ` (1 - 128)` :: +`--cores` ` (1 - 8192)` :: The number of cores assigned to the container. A container can use all available cores by default. -`--cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 8192)` ('default =' `0`):: Limit of CPU usage. + @@ -120,9 +120,13 @@ 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` `` ('default =' `0`):: + +Try to be more verbose. For now this only enables debug log-level on start. + `--description` `` :: -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` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=] [,nesting=<1|0>]` :: @@ -154,7 +158,7 @@ Amount of RAM for the VM in MB. `--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -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` `` :: @@ -168,7 +172,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -270,6 +274,10 @@ Destroy the container (also delete all uses files). The (unique) ID of the VM. +`--destroy-unreferenced-disks` `` :: + +If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. + `--force` `` ('default =' `0`):: Force destroy, even if running. @@ -322,7 +330,7 @@ A volume on which to run the filesystem check Force checking, even if the filesystem seems clean -*pct fstrim* `` +*pct fstrim* `` `[OPTIONS]` Run fstrim on a chosen CT and its mountpoints. @@ -330,6 +338,10 @@ Run fstrim on a chosen CT and its mountpoints. The (unique) ID of the VM. +`--ignore-mountpoints` `` :: + +Skip all mountpoints, only do fstrim on the container root. + *pct help* `[OPTIONS]` Get help about specified command. @@ -370,10 +382,6 @@ Target node. Override I/O bandwidth limit (in KiB/s). -`--force` `` :: - -Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead. - `--online` `` :: Use online/live migration. @@ -382,6 +390,10 @@ Use online/live migration. Use restart migration +`--target-storage` `` :: + +Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. + `--timeout` `` ('default =' `180`):: Timeout in seconds for shutdown for restart migration @@ -396,15 +408,16 @@ further operations on the container other than start and stop. The (unique) ID of the VM. -*pct move_volume* ` ` `[OPTIONS]` +*pct move-volume* ` [] [] []` `[OPTIONS]` -Move a rootfs-/mp-volume to a different storage +Move a rootfs-/mp-volume to a different storage or to a different +container. ``: ` (1 - N)` :: The (unique) ID of the VM. -``: `` :: +``: `` :: Volume which will be moved. @@ -412,6 +425,14 @@ Volume which will be moved. Target Storage. +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +The config key the volume will be moved to. Default is the source volume key. + `--bwlimit` ` (0 - N)` ('default =' `clone limit from datacenter or storage config`):: Override I/O bandwidth limit (in KiB/s). @@ -422,7 +443,18 @@ Delete the original volume after successful copy. By default the original is kep `--digest` `` :: -Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +Prevent changes if current configuration file has different SHA1 " . + "digest. This can be used to prevent concurrent modifications. + +`--target-digest` `` :: + +Prevent changes if current configuration file of the target " . + "container has a different SHA1 digest. This can be used to prevent " . + "concurrent modifications. + +*pct move_volume* + +An alias for 'pct move-volume'. *pct pending* `` @@ -561,11 +593,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` ` (1 - 128)` :: +`--cores` ` (1 - 8192)` :: The number of cores assigned to the container. A container can use all available cores by default. -`--cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 8192)` ('default =' `0`):: Limit of CPU usage. + @@ -577,9 +609,13 @@ 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` `` ('default =' `0`):: + +Try to be more verbose. For now this only enables debug log-level on start. + `--description` `` :: -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` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=] [,nesting=<1|0>]` :: @@ -611,7 +647,7 @@ Amount of RAM for the VM in MB. `--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -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` `` :: @@ -625,7 +661,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -739,11 +775,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` ` (1 - 128)` :: +`--cores` ` (1 - 8192)` :: The number of cores assigned to the container. A container can use all available cores by default. -`--cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 8192)` ('default =' `0`):: Limit of CPU usage. + @@ -755,13 +791,17 @@ 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` `` ('default =' `0`):: + +Try to be more verbose. For now this only enables debug log-level on start. + `--delete` `` :: A list of settings you want to delete. `--description` `` :: -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` `` :: @@ -789,7 +829,7 @@ Amount of RAM for the VM in MB. `--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: -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` `` :: @@ -803,7 +843,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -896,6 +936,10 @@ Start the container. The (unique) ID of the VM. +`--debug` `` ('default =' `0`):: + +If set, enables very verbose debug log-level on start. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -927,7 +971,7 @@ Ignore locks - only root is allowed to use this option. *pct suspend* `` -Suspend the container. +Suspend the container. This is experimental. ``: ` (1 - N)` ::