]> git.proxmox.com Git - pve-docs.git/blobdiff - pct.1-synopsis.adoc
make dinstall: skip mediawiki deb for now
[pve-docs.git] / pct.1-synopsis.adoc
index 24d1f3d69ec7dc0b4dd355b48b784310f81e4308..336ee6ea8836d7444ef6c7ca11ad5b4f64eb2b12 100644 (file)
@@ -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,7 +52,11 @@ Get container configuration.
 
 The (unique) ID of the VM.
 
-*pct console* `<vmid>`
+`--snapshot` `<string>` ::
+
+Fetch config values from given snapshot.
+
+*pct console* `<vmid>` `[OPTIONS]`
 
 Launch a console for the specified container.
 
@@ -56,6 +64,10 @@ Launch a console for the specified container.
 
 The (unique) ID of the VM.
 
+`--escape` `\^?[a-z]` ('default =' `^a`)::
+
+Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
+
 *pct cpusets*
 
 Print the list of assigned CPU sets.
@@ -72,13 +84,13 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 
 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`)::
 
@@ -108,10 +120,18 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
 Container description. Only used on the configuration web interface.
 
+`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+
+Allow containers access to advanced features.
+
 `--force` `<boolean>` ::
 
 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.
@@ -120,7 +140,7 @@ Set a host name for the container.
 
 Ignore errors when extracting the template.
 
-`--lock` `<backup | migrate | rollback | snapshot>` ::
+`--lock` `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -200,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.)
@@ -268,7 +294,7 @@ Run a filesystem check (fsck) on a container volume.
 
 The (unique) ID of the VM.
 
-`--device` `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
+`--device` `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 
 A volume on which to run the filesystem check
 
@@ -276,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.
@@ -312,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.
@@ -346,7 +384,7 @@ Move a rootfs-/mp-volume to a different storage
 
 The (unique) ID of the VM.
 
-`<volume>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
+`<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 
 Volume which will be moved.
 
@@ -354,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.
@@ -418,6 +460,18 @@ 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 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.
@@ -426,7 +480,7 @@ Resize a container mount point.
 
 The (unique) ID of the VM.
 
-`<disk>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
+`<disk>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
 
 The disk you want to resize.
 
@@ -450,13 +504,13 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 
 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`)::
 
@@ -486,10 +540,18 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
 Container description. Only used on the configuration web interface.
 
+`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+
+Allow containers access to advanced features.
+
 `--force` `<boolean>` ::
 
 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.
@@ -498,7 +560,7 @@ Set a host name for the container.
 
 Ignore errors when extracting the template.
 
-`--lock` `<backup | migrate | rollback | snapshot>` ::
+`--lock` `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.
 
@@ -574,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.)
@@ -610,7 +678,7 @@ Set container options.
 
 The (unique) ID of the VM.
 
-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -650,11 +718,19 @@ Container description. Only used on the configuration web interface.
 
 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>]` ::
+
+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 | migrate | rollback | snapshot>` ::
+`--lock` `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
 Lock/unlock the VM.