*pct* `<COMMAND> [ARGS] [OPTIONS]`
-*pct clone* `<vmid> <newid> --experimental <boolean>` `[OPTIONS]`
+*pct clone* `<vmid> <newid>` `[OPTIONS]`
Create a container clone/copy
VMID for the clone.
-`--description` `<string>` ::
+`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
-Description for the new CT.
+Override I/O bandwidth limit (in KiB/s).
-`--experimental` `<boolean>` ('default =' `0`)::
+`--description` `<string>` ::
-The clone feature is experimental, set this flag if you know what you are doing.
+Description for the new CT.
-`--full` `<boolean>` ('default =' `0`)::
+`--full` `<boolean>` ::
-Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.
+Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.
`--hostname` `<string>` ::
`--storage` `<string>` ::
Target storage for full clone.
-+
-NOTE: Requires option(s): `full`
+`--target` `<string>` ::
+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.
+`--snapshot` `<string>` ::
+Fetch config values from given snapshot.
-
-*pct console* `<vmid>`
+*pct console* `<vmid>` `[OPTIONS]`
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.
-
-
-
*pct create* `<vmid> <ostemplate>` `[OPTIONS]`
Create or restore a container.
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)` ('default =' `restore limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--cmode` `<console | shell | tty>` ('default =' `tty`)::
Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
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.
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.
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.
-`--password` ::
+`--password` `<password>` ::
Sets root password inside container.
Setup public SSH keys (one key per line, OpenSSH format).
+`--start` `<boolean>` ('default =' `0`)::
+
+Start the CT after its creation finished successfully.
+
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
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.)
Reference to unused volumes. This is used internally, and should not be modified manually.
-
-
-
*pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
Delete a LXC snapshot.
For removal from config file, even if removing disk snapshots fails.
-
-
-
*pct destroy* `<vmid>`
Destroy the container (also delete all uses files).
The (unique) ID of the VM.
-
-
-
*pct df* `<vmid>`
Get the container's current disk usage.
The (unique) ID of the VM.
-
-
*pct enter* `<vmid>`
Launch a shell for the specified container.
The (unique) ID of the VM.
-
-
*pct exec* `<vmid> [<extra-args>]`
Launch a command inside the specified container.
Extra arguments as array
-
-
*pct fsck* `<vmid>` `[OPTIONS]`
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
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* `[<cmd>]` `[OPTIONS]`
+*pct help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pct list*
LXC container index (per node).
-
-
-
*pct listsnapshot* `<vmid>`
List all snapshots.
The (unique) ID of the VM.
-
-
-
*pct migrate* `<vmid> <target>` `[OPTIONS]`
Migrate the container to another node. Creates a new migration task.
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.
Timeout in seconds for shutdown for restart migration
-
-
-
*pct mount* `<vmid>`
Mount the container's filesystem on the host. This will hold a lock on the
The (unique) ID of the VM.
+*pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
+
+Move a rootfs-/mp-volume to a different storage
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<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.
+
+`<storage>`: `<string>` ::
+
+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.
+
+`--digest` `<string>` ::
+
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
Owner user name or id.
-
-
*pct push* `<vmid> <file> <destination>` `[OPTIONS]`
Copy a local file to the container.
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]`
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.
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-
-
*pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
Create or restore a container.
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)` ('default =' `restore limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
`--cmode` `<console | shell | tty>` ('default =' `tty`)::
Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
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.
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.
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.
-`--password` ::
+`--password` `<password>` ::
Sets root password inside container.
Setup public SSH keys (one key per line, OpenSSH format).
+`--start` `<boolean>` ('default =' `0`)::
+
+Start the CT after its creation finished successfully.
+
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
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.)
Reference to unused volumes. This is used internally, and should not be modified manually.
-
-
-
*pct resume* `<vmid>`
Resume the container.
The (unique) ID of the VM.
-
-
-
*pct rollback* `<vmid> <snapname>`
Rollback LXC state to specified snapshot.
The name of the snapshot.
-
-
-
*pct set* `<vmid>` `[OPTIONS]`
Set container options.
The (unique) ID of the VM.
-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
OS architecture type.
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.
Reference to unused volumes. This is used internally, and should not be modified manually.
-
-
-
*pct shutdown* `<vmid>` `[OPTIONS]`
Shutdown the container. This will trigger a clean shutdown of the
Wait maximal timeout seconds.
-
-
-
*pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
Snapshot a container.
A textual description or comment.
-
-
-
*pct start* `<vmid>` `[OPTIONS]`
Start the container.
Ignore locks - only root is allowed to use this option.
-
-
-
*pct status* `<vmid>` `[OPTIONS]`
Show CT status.
Verbose output format
-
-
-
*pct stop* `<vmid>` `[OPTIONS]`
Stop the container. This will abruptly stop all processes running in the
Ignore locks - only root is allowed to use this option.
-
-
*pct suspend* `<vmid>`
Suspend the container.
The (unique) ID of the VM.
-
-
-
-*pct template* `<vmid> --experimental <boolean>` `[OPTIONS]`
+*pct template* `<vmid>`
Create a Template.
The (unique) ID of the VM.
-`--experimental` `<boolean>` ('default =' `0`)::
-
-The template feature is experimental, set this flag if you know what you are doing.
-
-
-
-
*pct unlock* `<vmid>`
Unlock the VM.
The (unique) ID of the VM.
-
-
*pct unmount* `<vmid>`
Unmount the container's filesystem.
The (unique) ID of the VM.
-
-
projects / pve-docs.git / blobdiff