fix #5429: network: override device names: include Type=ether

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

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index add622aef01c045505f4bd0d62c1df2777ec4e5a..47e830480f3cf79c9c17eaa6e026dda6cf0e5fb0 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -36,7 +36,7 @@ Add the new CT to the specified pool.
 
 The name of the snapshot.
 
-`--storage` `<string>` ::
+`--storage` `<storage ID>` ::
 
 Target storage for full clone.
 
@@ -126,6 +126,10 @@ Try to be more verbose. For now this only enables debug log-level on start.
 
 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
+`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
+
+Device to pass through to the container
+
 `--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.
@@ -210,7 +214,7 @@ Start the CT after its creation finished successfully.
 
 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.
 
-`--storage` `<string>` ('default =' `local`)::
+`--storage` `<storage ID>` ('default =' `local`)::
 
 Default Storage.
 
@@ -292,7 +296,7 @@ Get the container's current disk usage.
 
 The (unique) ID of the VM.
 
-*pct enter* `<vmid>`
+*pct enter* `<vmid>` `[OPTIONS]`
 
 Launch a shell for the specified container.
 
@@ -300,7 +304,11 @@ Launch a shell for the specified container.
 
 The (unique) ID of the VM.
 
-*pct exec* `<vmid> [<extra-args>]`
+`--keep-env` `<boolean>` ('default =' `1`)::
+
+Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof.
+
+*pct exec* `<vmid> [<extra-args>]` `[OPTIONS]`
 
 Launch a command inside the specified container.
 
@@ -312,6 +320,10 @@ The (unique) ID of the VM.
 
 Extra arguments as array
 
+`--keep-env` `<boolean>` ('default =' `1`)::
+
+Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof.
+
 *pct fsck* `<vmid>` `[OPTIONS]`
 
 Run a filesystem check (fsck) on a container volume.
@@ -420,7 +432,7 @@ The (unique) ID of the VM.
 
 Volume which will be moved.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 Target Storage.
 
@@ -545,7 +557,7 @@ The (unique) ID of the VM.
 
 The (unique) ID of the VM.
 
-`<target-endpoint>`: `apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]` ::
+`<target-endpoint>`: `apitoken=<PVEAPIToken=user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
 
 Remote target endpoint
 
@@ -659,6 +671,10 @@ Try to be more verbose. For now this only enables debug log-level on start.
 
 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
+`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
+
+Device to pass through to the container
+
 `--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.
@@ -739,7 +755,7 @@ Start the CT after its creation finished successfully.
 
 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.
 
-`--storage` `<string>` ('default =' `local`)::
+`--storage` `<storage ID>` ('default =' `local`)::
 
 Default Storage.
 
@@ -847,6 +863,10 @@ A list of settings you want to delete.
 
 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
 
+`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
+
+Device to pass through to the container
+
 `--digest` `<string>` ::
 
 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
@@ -1009,6 +1029,10 @@ container.
 
 The (unique) ID of the VM.
 
+`--overrule-shutdown` `<boolean>` ('default =' `0`)::
+
+Try to abort active 'vzshutdown' tasks before stopping.
+
 `--skiplock` `<boolean>` ::
 
 Ignore locks - only root is allowed to use this option.