pbs: fix password and encryption key file location

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

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index 5630a986684c1676dabaf20b85b8edd51b02495d..c3862db3b96c560b32a151bf285ff1327b87a387 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -120,11 +120,15 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
 `--description` `<string>` ::
 
 Container description. Only used on the configuration web interface.
 
-`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 
 Allow containers access to advanced features.
 
@@ -216,10 +220,18 @@ Default Storage.
 
 Amount of SWAP for the VM in MB.
 
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
 `--template` `<boolean>` ('default =' `0`)::
 
 Enable/disable Template.
 
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
@@ -234,7 +246,7 @@ NOTE: Requires option(s): `restore`
 
 Makes the container run as unprivileged user. (Should not be modified manually.)
 
-`--unused[n]` `<string>` ::
+`--unused[n]` `[volume=]<volume>` ::
 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 
@@ -262,9 +274,13 @@ Destroy the container (also delete all uses files).
 
 The (unique) ID of the VM.
 
-`--purge` `<boolean>` ::
+`--force` `<boolean>` ('default =' `0`)::
+
+Force destroy, even if running.
 
-Remove vmid from backup cron jobs.
+`--purge` `<boolean>` ('default =' `0`)::
+
+Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.
 
 *pct df* `<vmid>`
 
@@ -476,6 +492,19 @@ 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 reboot* `<vmid>` `[OPTIONS]`
+
+Reboot the container by shutting it down, and starting it again. Applies
+pending changes.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`--timeout` `<integer> (0 - N)` ::
+
+Wait maximal timeout seconds for the shutdown.
+
 *pct rescan* `[OPTIONS]`
 
 Rescan all storages and update disk sizes and unused disk images.
@@ -552,11 +581,15 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
 `--description` `<string>` ::
 
 Container description. Only used on the configuration web interface.
 
-`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
+`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 
 Allow containers access to advanced features.
 
@@ -644,10 +677,18 @@ Default Storage.
 
 Amount of SWAP for the VM in MB.
 
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
 `--template` `<boolean>` ('default =' `0`)::
 
 Enable/disable Template.
 
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
@@ -662,7 +703,7 @@ NOTE: Requires option(s): `restore`
 
 Makes the container run as unprivileged user. (Should not be modified manually.)
 
-`--unused[n]` `<string>` ::
+`--unused[n]` `[volume=]<volume>` ::
 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 
@@ -722,6 +763,10 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
 +
 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
+
 `--delete` `<string>` ::
 
 A list of settings you want to delete.
@@ -734,7 +779,7 @@ 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>]` ::
+`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 
 Allow containers access to advanced features.
 
@@ -798,10 +843,18 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
 
 Amount of SWAP for the VM in MB.
 
+`--tags` `<string>` ::
+
+Tags of the Container. This is only meta information.
+
 `--template` `<boolean>` ('default =' `0`)::
 
 Enable/disable Template.
 
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
@@ -810,7 +863,7 @@ Specify the number of tty available to the container
 
 Makes the container run as unprivileged user. (Should not be modified manually.)
 
-`--unused[n]` `<string>` ::
+`--unused[n]` `[volume=]<volume>` ::
 
 Reference to unused volumes. This is used internally, and should not be modified manually.
 
@@ -855,6 +908,10 @@ Start the container.
 
 The (unique) ID of the VM.
 
+`--debug` `<boolean>` ('default =' `0`)::
+
+If set, enables very verbose debug log-level on start.
+
 `--skiplock` `<boolean>` ::
 
 Ignore locks - only root is allowed to use this option.