README: document list continuations

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

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index 3ecb377f878c53425ab7540660a66ce380680bb8..bf60d9539e532cfe5c6379ac3a20918e3b469966 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -1,6 +1,6 @@
 *pct* `<COMMAND> [ARGS] [OPTIONS]`
 
 *pct* `<COMMAND> [ARGS] [OPTIONS]`
 

-*pct clone* `<vmid> <newid> --experimental <boolean>` `[OPTIONS]`
+*pct clone* `<vmid> <newid>` `[OPTIONS]`

 
 Create a container clone/copy
 
 
 Create a container clone/copy
 


@@ -16,13 +16,9 @@ VMID for the clone.
 
 Description for the new CT.
 
 
 Description for the new CT.
 

-`--experimental` `<boolean>` ('default =' `0`)::
+`--full` `<boolean>` ::

 
 

-The clone feature is experimental, set this flag if you know what you are doing.
-
-`--full` `<boolean>` ('default =' `0`)::
-
-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>` ::
 
 
 `--hostname` `<string>` ::
 


@@ -39,8 +35,10 @@ The name of the snapshot.
 `--storage` `<string>` ::
 
 Target storage for full clone.
 `--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>`
 


@@ -50,7 +48,7 @@ Get container configuration.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-*pct console* `<vmid>`
+*pct console* `<vmid>` `[OPTIONS]`

 
 Launch a console for the specified container.
 
 
 Launch a console for the specified container.
 


@@ -58,6 +56,10 @@ Launch a console for the specified container.
 
 The (unique) ID of the VM.
 
 
 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 cpusets*
 
 Print the list of assigned CPU sets.


@@ -74,10 +76,14 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
 
 The OS template or backup file.
 

-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::

 
 OS architecture type.
 
 
 OS architecture type.
 

+`--bwlimit` `<number> (0 - N)` ::
+
+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).
 `--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).


@@ -106,6 +112,10 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
 Container description. Only used on the configuration web interface.
 
 
 Container description. Only used on the configuration web interface.
 

+`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+
+Allow containers access to advanced features.
+

 `--force` `<boolean>` ::
 
 Allow to overwrite existing container.
 `--force` `<boolean>` ::
 
 Allow to overwrite existing container.


@@ -118,7 +128,7 @@ Set a host name for the container.
 
 Ignore errors when extracting the template.
 
 
 Ignore errors when extracting the template.
 

-`--lock` `<backup | migrate | rollback | snapshot>` ::
+`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::

 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 


@@ -146,7 +156,7 @@ Specifies whether a VM will be started during system bootup.
 
 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.
 
 
 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.
 
 
 Sets root password inside container.
 


@@ -174,6 +184,10 @@ Sets DNS search domains for a container. Create will automatically use the setti
 
 Setup public SSH keys (one key per line, OpenSSH format).
 
 
 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.
 `--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.


@@ -262,7 +276,7 @@ Run a filesystem check (fsck) on a container volume.
 
 The (unique) ID of the VM.
 
 
 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
 
 
 A volume on which to run the filesystem check
 


@@ -332,6 +346,30 @@ further operations on the container other than start and stop.
 
 The (unique) ID of the VM.
 
 
 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.
+
+`--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]`
 
 Copy a file from the container to the local system.
 *pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
 
 Copy a file from the container to the local system.


@@ -396,7 +434,7 @@ Resize a container mount point.
 
 The (unique) ID of the VM.
 
 
 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.
 
 
 The disk you want to resize.
 


@@ -420,10 +458,14 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
 
 The OS template or backup file.
 

-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::

 
 OS architecture type.
 
 
 OS architecture type.
 

+`--bwlimit` `<number> (0 - N)` ::
+
+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).
 `--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).


@@ -452,6 +494,10 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
 Container description. Only used on the configuration web interface.
 
 
 Container description. Only used on the configuration web interface.
 

+`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+
+Allow containers access to advanced features.
+

 `--force` `<boolean>` ::
 
 Allow to overwrite existing container.
 `--force` `<boolean>` ::
 
 Allow to overwrite existing container.


@@ -464,7 +510,7 @@ Set a host name for the container.
 
 Ignore errors when extracting the template.
 
 
 Ignore errors when extracting the template.
 

-`--lock` `<backup | migrate | rollback | snapshot>` ::
+`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::

 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 


@@ -492,7 +538,7 @@ Specifies whether a VM will be started during system bootup.
 
 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.
 
 
 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.
 
 
 Sets root password inside container.
 


@@ -516,6 +562,10 @@ Sets DNS search domains for a container. Create will automatically use the setti
 
 Setup public SSH keys (one key per line, OpenSSH format).
 
 
 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.
 `--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.


@@ -572,7 +622,7 @@ Set container options.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-`--arch` `<amd64 | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::

 
 OS architecture type.
 
 
 OS architecture type.
 


@@ -612,11 +662,15 @@ 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.
 
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 

+`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+
+Allow containers access to advanced features.
+

 `--hostname` `<string>` ::
 
 Set a host name for the container.
 
 `--hostname` `<string>` ::
 
 Set a host name for the container.
 

-`--lock` `<backup | migrate | rollback | snapshot>` ::
+`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::

 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 


@@ -758,7 +812,7 @@ Suspend the container.
 
 The (unique) ID of the VM.
 
 
 The (unique) ID of the VM.
 

-*pct template* `<vmid> --experimental <boolean>` `[OPTIONS]`
+*pct template* `<vmid>`

 
 Create a Template.
 
 
 Create a Template.
 


@@ -766,10 +820,6 @@ Create a Template.
 
 The (unique) ID of the VM.
 
 
 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.
 *pct unlock* `<vmid>`
 
 Unlock the VM.