run make update

[pve-docs.git] / pct.1-synopsis.adoc

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index 433a1c1ae73bf70e6ff179d7f1d4dfb6888df0b5..e4ebec4891e6e61c2456a1468a38f13e6dd8dd32 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -12,6 +12,10 @@ The (unique) ID of the VM.
 
 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.
@@ -40,7 +44,7 @@ Target storage for full clone.
 
 Target node. Only allowed if the original VM is on shared storage.
 
-*pct config* `<vmid>`
+*pct config* `<vmid>` `[OPTIONS]`
 
 Get container configuration.
 
@@ -48,6 +52,10 @@ Get container configuration.
 
 The (unique) ID of the VM.
 
+`--snapshot` `<string>` ::
+
+Fetch config values from given snapshot.
+
 *pct console* `<vmid>` `[OPTIONS]`
 
 Launch a console for the specified container.
@@ -80,9 +88,9 @@ The OS template or backup file.
 
 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`)::
 
@@ -120,6 +128,10 @@ 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.
@@ -128,7 +140,7 @@ 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 | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -136,7 +148,7 @@ 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.
 
@@ -172,7 +184,7 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk
 
 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.
 
@@ -208,6 +220,12 @@ Enable/disable Template.
 
 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.)
@@ -284,6 +302,14 @@ A volume on which to run the filesystem check
 
 Force checking, even if the filesystem seems clean
 
+*pct fstrim* `<vmid>`
+
+Run fstrim on a chosen CT and its mountpoints.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
 *pct help* `[OPTIONS]`
 
 Get help about specified command.
@@ -320,6 +346,10 @@ The (unique) ID of the VM.
 
 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.
@@ -362,6 +392,10 @@ Volume which will be moved.
 
 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.
@@ -474,9 +508,9 @@ The OS template or backup file.
 
 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`)::
 
@@ -514,6 +548,10 @@ 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.
@@ -522,7 +560,7 @@ 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 | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -530,7 +568,7 @@ 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.
 
@@ -562,7 +600,7 @@ Add the VM to the specified pool.
 
 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.
 
@@ -598,6 +636,12 @@ Enable/disable Template.
 
 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.)
@@ -678,11 +722,15 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
 
 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 | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -690,7 +738,7 @@ 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.
 
@@ -714,7 +762,7 @@ OS type. This is used to setup configuration inside the container, and correspon
 
 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.