Precise certificate generation

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

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index 967760c3c0b7e802a60fd63add71f0f4e9e4a382..433a1c1ae73bf70e6ff179d7f1d4dfb6888df0b5 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -48,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.
 


@@ -56,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.


@@ -72,7 +76,7 @@ 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.
 


@@ -108,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` `[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.
 `--force` `<boolean>` ::
 
 Allow to overwrite existing container.


@@ -120,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.
 


@@ -148,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.
 


@@ -176,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.


@@ -264,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
 


@@ -342,7 +354,7 @@ Move a rootfs-/mp-volume to a different storage
 
 The (unique) ID of the VM.
 
 
 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.
 
 
 Volume which will be moved.
 


@@ -414,6 +426,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.
 
 
 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.
 *pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
 
 Resize a container mount point.


@@ -422,7 +446,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.
 


@@ -446,7 +470,7 @@ 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.
 


@@ -482,6 +506,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` `[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.
 `--force` `<boolean>` ::
 
 Allow to overwrite existing container.


@@ -494,7 +522,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.
 


@@ -522,7 +550,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.
 


@@ -546,6 +574,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.


@@ -602,7 +634,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.
 


@@ -642,11 +674,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` `[fuse=<1|0>] [,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.