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 6ed21a6c66de3f8382cac0c7a74e5ec2d39c2fba..47e830480f3cf79c9c17eaa6e026dda6cf0e5fb0 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -4,11 +4,11 @@
 
 Create a container clone/copy
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-`<newid>`: `<integer> (1 - N)` ::
+`<newid>`: `<integer> (100 - 999999999)` ::
 
 VMID for the clone.
 
@@ -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.
 
@@ -48,7 +48,7 @@ Target node. Only allowed if the original VM is on shared storage.
 
 Get container configuration.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -64,7 +64,7 @@ Fetch config values from given snapshot.
 
 Launch a console for the specified container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -80,7 +80,7 @@ Print the list of assigned CPU sets.
 
 Create or restore a container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -88,7 +88,7 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
-`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -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.
@@ -162,7 +166,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
 
 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 
-`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
+`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 
 Specifies network interfaces for the container.
 
@@ -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.
 
@@ -252,7 +256,7 @@ Reference to unused volumes. This is used internally, and should not be modified
 
 Delete a LXC snapshot.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -268,7 +272,7 @@ For removal from config file, even if removing disk snapshots fails.
 
 Destroy the container (also delete all uses files).
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -288,23 +292,27 @@ Remove container from all related configurations. For example, backup jobs, repl
 
 Get the container's current disk usage.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-*pct enter* `<vmid>`
+*pct enter* `<vmid>` `[OPTIONS]`
 
 Launch a shell for the specified container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 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.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -312,11 +320,15 @@ 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.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -330,9 +342,10 @@ Force checking, even if the filesystem seems clean
 
 *pct fstrim* `<vmid>` `[OPTIONS]`
 
-Run fstrim on a chosen CT and its mountpoints.
+Run fstrim on a chosen CT and its mountpoints, except bind or read-only
+mountpoints.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -360,7 +373,7 @@ LXC container index (per node).
 
 List all snapshots.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -368,7 +381,7 @@ The (unique) ID of the VM.
 
 Migrate the container to another node. Creates a new migration task.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -402,7 +415,7 @@ Mount the container's filesystem on the host. This will hold a lock on the
 container and is meant for emergency maintenance only as it will prevent
 further operations on the container other than start and stop.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -411,7 +424,7 @@ The (unique) ID of the VM.
 Move a rootfs-/mp-volume to a different storage or to a different
 container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -419,11 +432,11 @@ The (unique) ID of the VM.
 
 Volume which will be moved.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 Target Storage.
 
-`<target-vmid>`: `<integer> (1 - N)` ::
+`<target-vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -458,7 +471,7 @@ An alias for 'pct move-volume'.
 
 Get container configuration, including pending changes.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -466,7 +479,7 @@ The (unique) ID of the VM.
 
 Copy a file from the container to the local system.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -494,7 +507,7 @@ Owner user name or id.
 
 Copy a local file to the container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -523,7 +536,7 @@ Owner user name or id. When using a name it must exist inside the container.
 Reboot the container by shutting it down, and starting it again. Applies
 pending changes.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -536,15 +549,15 @@ Wait maximal timeout seconds for the shutdown.
 Migrate container to a remote cluster. Creates a new migration task.
 EXPERIMENTAL feature!
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-`<target-vmid>`: `<integer> (1 - N)` ::
+`<target-vmid>`: `<integer> (100 - 999999999)` ::
 
 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
 
@@ -584,7 +597,7 @@ Rescan all storages and update disk sizes and unused disk images.
 
 Do not actually write changes out to conifg.
 
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -592,7 +605,7 @@ The (unique) ID of the VM.
 
 Resize a container mount point.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -612,7 +625,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
 
 Create or restore a container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -620,7 +633,7 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
-`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -658,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.
@@ -694,7 +711,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
 
 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 
-`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
+`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 
 Specifies network interfaces for the container.
 
@@ -738,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.
 
@@ -780,7 +797,7 @@ Reference to unused volumes. This is used internally, and should not be modified
 
 Resume the container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -788,7 +805,7 @@ The (unique) ID of the VM.
 
 Rollback LXC state to specified snapshot.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -804,11 +821,11 @@ Whether the container should get started after rolling back successfully
 
 Set container options.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -846,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.
@@ -878,7 +899,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
 
 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 
-`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
+`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 
 Specifies network interfaces for the container.
 
@@ -943,7 +964,7 @@ Reference to unused volumes. This is used internally, and should not be modified
 Shutdown the container. This will trigger a clean shutdown of the
 container, see lxc-stop(1) for details.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -959,7 +980,7 @@ Wait maximal timeout seconds.
 
 Snapshot a container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -975,7 +996,7 @@ A textual description or comment.
 
 Start the container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -991,7 +1012,7 @@ Ignore locks - only root is allowed to use this option.
 
 Show CT status.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -1004,10 +1025,14 @@ Verbose output format
 Stop the container. This will abruptly stop all processes running in the
 container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 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.
@@ -1016,7 +1041,7 @@ Ignore locks - only root is allowed to use this option.
 
 Suspend the container. This is experimental.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -1024,7 +1049,7 @@ The (unique) ID of the VM.
 
 Create a Template.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -1032,7 +1057,7 @@ The (unique) ID of the VM.
 
 Unlock the VM.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -1040,7 +1065,7 @@ The (unique) ID of the VM.
 
 Unmount the container's filesystem.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.