mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-01-03 01:17:49 +03:00
update static and schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
3093e62d27
commit
d26563851c
File diff suppressed because it is too large
Load Diff
@ -4,7 +4,7 @@ Use volume as container root. See below for a detailed description of all option
|
||||
|
||||
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point.
|
||||
Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`acl`=`<boolean>` ;;
|
||||
|
||||
|
||||
@ -158,7 +158,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point.
|
||||
Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--nameserver` `<string>` ::
|
||||
|
||||
@ -172,7 +172,7 @@ Specifies network interfaces for the container.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
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.
|
||||
|
||||
@ -274,6 +274,10 @@ Destroy the container (also delete all uses files).
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--destroy-unreferenced-disks` `<boolean>` ::
|
||||
|
||||
If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.
|
||||
|
||||
`--force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Force destroy, even if running.
|
||||
@ -623,7 +627,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point.
|
||||
Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--nameserver` `<string>` ::
|
||||
|
||||
@ -637,7 +641,7 @@ Specifies network interfaces for the container.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
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.
|
||||
|
||||
@ -805,7 +809,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point.
|
||||
Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--nameserver` `<string>` ::
|
||||
|
||||
@ -819,7 +823,7 @@ Specifies network interfaces for the container.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -80,7 +80,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point.
|
||||
Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`acl`=`<boolean>` ;;
|
||||
|
||||
@ -190,7 +190,7 @@ Network interface type.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`ostype`: `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
`ostype`: `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -242,14 +242,26 @@ Minimum number of replicas per object
|
||||
|
||||
The automatic PG scaling mode of the pool.
|
||||
|
||||
`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
|
||||
`--pg_num` `<integer> (1 - 32768)` ('default =' `128`)::
|
||||
|
||||
Number of placement groups.
|
||||
|
||||
`--pg_num_min` `<integer> (-N - 32768)` ::
|
||||
|
||||
Minimal number of placement groups.
|
||||
|
||||
`--size` `<integer> (1 - 7)` ('default =' `3`)::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
|
||||
|
||||
The estimated target size of the pool for the PG autoscaler.
|
||||
|
||||
`--target_size_ratio` `<number>` ::
|
||||
|
||||
The estimated target ratio of the pool for the PG autoscaler.
|
||||
|
||||
*pveceph pool destroy* `<name>` `[OPTIONS]`
|
||||
|
||||
Destroy pool
|
||||
@ -266,6 +278,18 @@ If true, destroys pool even if in use
|
||||
|
||||
Remove all pveceph-managed storages configured for this pool
|
||||
|
||||
*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
List pool settings.
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`--verbose` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If enabled, will display additional data(eg. statistics).
|
||||
|
||||
*pveceph pool ls* `[FORMAT_OPTIONS]`
|
||||
|
||||
List all pools.
|
||||
@ -294,14 +318,26 @@ Minimum number of replicas per object
|
||||
|
||||
The automatic PG scaling mode of the pool.
|
||||
|
||||
`--pg_num` `<integer> (8 - 32768)` ::
|
||||
`--pg_num` `<integer> (1 - 32768)` ::
|
||||
|
||||
Number of placement groups.
|
||||
|
||||
`--pg_num_min` `<integer> (-N - 32768)` ::
|
||||
|
||||
Minimal number of placement groups.
|
||||
|
||||
`--size` `<integer> (1 - 7)` ::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
`--target_size` `^(\d+(\.\d+)?)([KMGT])?$` ::
|
||||
|
||||
The estimated target size of the pool for the PG autoscaler.
|
||||
|
||||
`--target_size_ratio` `<number>` ::
|
||||
|
||||
The estimated target ratio of the pool for the PG autoscaler.
|
||||
|
||||
*pveceph purge* `[OPTIONS]`
|
||||
|
||||
Destroy ceph related data and configuration files.
|
||||
@ -324,7 +360,7 @@ Ceph service name.
|
||||
|
||||
*pveceph status*
|
||||
|
||||
Get ceph status.
|
||||
Get Ceph Status.
|
||||
|
||||
*pveceph stop* `[OPTIONS]`
|
||||
|
||||
|
||||
@ -179,7 +179,7 @@ Update node certificates (and generate all needed files/directories).
|
||||
|
||||
`--force` `<boolean>` ::
|
||||
|
||||
Force generation of new SSL certifate.
|
||||
Force generation of new SSL certificate.
|
||||
|
||||
`--silent` `<boolean>` ::
|
||||
|
||||
|
||||
@ -81,7 +81,7 @@ ACME challenge type.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
@ -133,7 +133,7 @@ Update ACME plugin configuration.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
|
||||
@ -90,6 +90,10 @@ Always access rbd through krbd kernel module.
|
||||
|
||||
target portal group for Linux LIO targets
|
||||
|
||||
`--master-pubkey` `a file containing a PEM-formatted master public key` ::
|
||||
|
||||
Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.
|
||||
|
||||
`--maxfiles` `<integer> (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
@ -106,6 +110,10 @@ IP addresses of monitors (for external clusters).
|
||||
|
||||
mount point
|
||||
|
||||
`--namespace` `<string>` ::
|
||||
|
||||
RBD Namespace.
|
||||
|
||||
`--nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
@ -262,11 +270,11 @@ Export stream format
|
||||
|
||||
Destination file name
|
||||
|
||||
`--base` `(?^:[a-z0-9_\-]{1,40})` ::
|
||||
`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
|
||||
|
||||
Snapshot to start an incremental stream from
|
||||
|
||||
`--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
|
||||
`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
|
||||
|
||||
Snapshot to export
|
||||
|
||||
@ -328,17 +336,17 @@ Import stream format
|
||||
|
||||
`<filename>`: `<string>` ::
|
||||
|
||||
Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection as input. Else, the file is treated as common file.
|
||||
Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection, the unix://PATH-TO-SOCKET format a UNIX socket as input.Else, the file is treated as common file.
|
||||
|
||||
`--allow-rename` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
|
||||
|
||||
`--base` `(?^:[a-z0-9_\-]{1,40})` ::
|
||||
`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
|
||||
|
||||
Base snapshot of an incremental stream
|
||||
|
||||
`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
|
||||
`--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
|
||||
|
||||
A snapshot to delete on success
|
||||
|
||||
@ -500,6 +508,30 @@ Scan remote NFS server.
|
||||
|
||||
The server address (name or IP).
|
||||
|
||||
*pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Scan remote Proxmox Backup Server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
The server address (name or IP).
|
||||
|
||||
`<username>`: `<string>` ::
|
||||
|
||||
User-name or API token-ID.
|
||||
|
||||
`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
|
||||
|
||||
Certificate SHA 256 fingerprint.
|
||||
|
||||
`--password` `<string>` ::
|
||||
|
||||
User password or API token secret.
|
||||
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
|
||||
Optional port.
|
||||
|
||||
*pvesm scan zfs*
|
||||
|
||||
Scan zfs pool list on local node.
|
||||
@ -578,6 +610,10 @@ Always access rbd through krbd kernel module.
|
||||
|
||||
target portal group for Linux LIO targets
|
||||
|
||||
`--master-pubkey` `a file containing a PEM-formatted master public key` ::
|
||||
|
||||
Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.
|
||||
|
||||
`--maxfiles` `<integer> (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
@ -594,6 +630,10 @@ IP addresses of monitors (for external clusters).
|
||||
|
||||
mount point
|
||||
|
||||
`--namespace` `<string>` ::
|
||||
|
||||
RBD Namespace.
|
||||
|
||||
`--nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
@ -34,7 +34,7 @@ Storage replication schedule. The format is a subset of `systemd` calendar event
|
||||
|
||||
`--source` `<string>` ::
|
||||
|
||||
Source of the replication.
|
||||
For internal use, to detect if the guest was stolen.
|
||||
|
||||
*pvesr delete* `<id>` `[OPTIONS]`
|
||||
|
||||
@ -228,6 +228,6 @@ Storage replication schedule. The format is a subset of `systemd` calendar event
|
||||
|
||||
`--source` `<string>` ::
|
||||
|
||||
Source of the replication.
|
||||
For internal use, to detect if the guest was stolen.
|
||||
|
||||
|
||||
|
||||
@ -136,6 +136,54 @@ Change user password.
|
||||
|
||||
User ID
|
||||
|
||||
*pveum pool add* `<poolid>` `[OPTIONS]`
|
||||
|
||||
Create new pool.
|
||||
|
||||
`<poolid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`--comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
*pveum pool delete* `<poolid>`
|
||||
|
||||
Delete pool.
|
||||
|
||||
`<poolid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
*pveum pool list* `[FORMAT_OPTIONS]`
|
||||
|
||||
Pool index.
|
||||
|
||||
*pveum pool modify* `<poolid>` `[OPTIONS]`
|
||||
|
||||
Update pool data.
|
||||
|
||||
`<poolid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`--comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`--delete` `<boolean>` ::
|
||||
|
||||
Remove vms/storage (instead of adding it).
|
||||
|
||||
`--storage` `<string>` ::
|
||||
|
||||
List of storage IDs.
|
||||
|
||||
`--vms` `<string>` ::
|
||||
|
||||
List of virtual machines.
|
||||
|
||||
*pveum realm add* `<realm> --type <string>` `[OPTIONS]`
|
||||
|
||||
Add an authentication server.
|
||||
|
||||
@ -19,7 +19,7 @@ Specify a custom file containing all user data passed to the VM via cloud-init.
|
||||
|
||||
Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
|
||||
|
||||
`citype`: `<configdrive2 | nocloud>` ::
|
||||
`citype`: `<configdrive2 | nocloud | opennebula>` ::
|
||||
|
||||
Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
|
||||
|
||||
@ -35,7 +35,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
|
||||
gateway should be provided.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
|
||||
cloud-init 19.4 or newer.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
|
||||
@ -127,7 +127,7 @@ The backup archive. Either the file system path to a .tar or .vma file (use '-'
|
||||
|
||||
Arbitrary arguments passed to kvm.
|
||||
|
||||
`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
|
||||
`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
|
||||
|
||||
Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
@ -167,7 +167,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at
|
||||
|
||||
cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
|
||||
|
||||
`--citype` `<configdrive2 | nocloud>` ::
|
||||
`--citype` `<configdrive2 | nocloud | opennebula>` ::
|
||||
|
||||
Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
|
||||
|
||||
@ -197,7 +197,7 @@ Description for the VM. Only used on the configuration web interface. This is sa
|
||||
|
||||
`--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
|
||||
Configure a Disk for storing EFI vars
|
||||
Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
|
||||
|
||||
`--force` `<boolean>` ::
|
||||
|
||||
@ -227,7 +227,7 @@ Enable/disable hugepages memory.
|
||||
|
||||
`--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
|
||||
|
||||
@ -237,7 +237,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
|
||||
gateway should be provided.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
|
||||
cloud-init 19.4 or newer.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
@ -258,6 +259,12 @@ Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg
|
||||
|
||||
Enable/disable KVM hardware virtualization.
|
||||
|
||||
`--live-restore` `<boolean>` ::
|
||||
|
||||
Start the VM immediately from the backup and restore in background. PBS only.
|
||||
+
|
||||
NOTE: Requires option(s): `archive`
|
||||
|
||||
`--localtime` `<boolean>` ::
|
||||
|
||||
Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
|
||||
@ -334,11 +341,11 @@ Configure a VirtIO-based Random Number Generator.
|
||||
|
||||
`--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
|
||||
|
||||
@ -434,7 +441,7 @@ Configure the VGA hardware.
|
||||
|
||||
`--virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
|
||||
|
||||
@ -466,15 +473,20 @@ For removal from config file, even if removing disk snapshots fails.
|
||||
|
||||
*qm destroy* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Destroy the vm (also delete all used/owned volumes).
|
||||
Destroy the VM and all used/owned volumes. Removes any VM specific
|
||||
permissions and firewall rules
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--destroy-unreferenced-disks` `<boolean>` ('default =' `1`)::
|
||||
|
||||
If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.
|
||||
|
||||
`--purge` `<boolean>` ::
|
||||
|
||||
Remove vmid from backup cron jobs.
|
||||
Remove VMID from configurations, like backup & replication jobs and HA.
|
||||
|
||||
`--skiplock` `<boolean>` ::
|
||||
|
||||
@ -848,7 +860,7 @@ Virtual processor architecture. Defaults to the host.
|
||||
|
||||
Arbitrary arguments passed to kvm.
|
||||
|
||||
`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
|
||||
`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
|
||||
|
||||
Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
@ -884,7 +896,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at
|
||||
|
||||
cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
|
||||
|
||||
`--citype` `<configdrive2 | nocloud>` ::
|
||||
`--citype` `<configdrive2 | nocloud | opennebula>` ::
|
||||
|
||||
Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
|
||||
|
||||
@ -922,7 +934,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
|
||||
|
||||
`--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
|
||||
Configure a Disk for storing EFI vars
|
||||
Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
|
||||
|
||||
`--force` `<boolean>` ::
|
||||
|
||||
@ -952,7 +964,7 @@ Enable/disable hugepages memory.
|
||||
|
||||
`--ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
|
||||
|
||||
@ -962,7 +974,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
|
||||
gateway should be provided.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
|
||||
cloud-init 19.4 or newer.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
@ -1059,11 +1072,11 @@ Configure a VirtIO-based Random Number Generator.
|
||||
|
||||
`--sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
|
||||
|
||||
@ -1149,7 +1162,7 @@ Configure the VGA hardware.
|
||||
|
||||
`--virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ Enable/disable Qemu GuestAgent.
|
||||
|
||||
`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Run fstrim after cloning/moving a disk.
|
||||
Run fstrim after moving a disk or migrating the VM.
|
||||
|
||||
`type`=`<isa | virtio>` ('default =' `virtio`);;
|
||||
|
||||
@ -30,7 +30,7 @@ args: -no-reboot -no-hpet
|
||||
+
|
||||
NOTE: this option is for experts only.
|
||||
|
||||
`audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
|
||||
`audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` ::
|
||||
|
||||
Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
@ -38,7 +38,7 @@ Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
Configure an audio device.
|
||||
|
||||
`driver`=`<spice>` ('default =' `spice`);;
|
||||
`driver`=`<none | spice>` ('default =' `spice`);;
|
||||
|
||||
Driver backend for the audio device.
|
||||
|
||||
@ -105,7 +105,7 @@ Specify a custom file containing all user data passed to the VM via cloud-init.
|
||||
|
||||
cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.
|
||||
|
||||
`citype`: `<configdrive2 | nocloud>` ::
|
||||
`citype`: `<configdrive2 | nocloud | opennebula>` ::
|
||||
|
||||
Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.
|
||||
|
||||
@ -161,7 +161,7 @@ Description for the VM. Only used on the configuration web interface. This is sa
|
||||
|
||||
`efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
|
||||
Configure a Disk for storing EFI vars
|
||||
Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.
|
||||
|
||||
`file`=`<volume>` ;;
|
||||
|
||||
@ -237,7 +237,7 @@ Enable/disable hugepages memory.
|
||||
|
||||
`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
@ -421,7 +421,8 @@ IP addresses use CIDR notation, gateways are optional but need an IP of the same
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit
|
||||
gateway should be provided.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires
|
||||
cloud-init 19.4 or newer.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
@ -601,7 +602,7 @@ w2k8;; Microsoft Windows 2008
|
||||
wvista;; Microsoft Windows Vista
|
||||
win7;; Microsoft Windows 7
|
||||
win8;; Microsoft Windows 8/2012/2012r2
|
||||
win10;; Microsoft Windows 10/2016
|
||||
win10;; Microsoft Windows 10/2016/2019
|
||||
l24;; Linux 2.4 Kernel
|
||||
l26;; Linux 2.6 - 5.X Kernel
|
||||
solaris;; Solaris/OpenSolaris/OpenIndiania kernel
|
||||
@ -641,7 +642,7 @@ The file on the host to gather entropy from. In most cases /dev/urandom should b
|
||||
|
||||
`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
@ -815,7 +816,7 @@ The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
|
||||
|
||||
`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
@ -1160,7 +1161,7 @@ Select the VGA type.
|
||||
|
||||
`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
|
||||
@ -20,6 +20,10 @@ Override i/o bandwidth limit (in KiB/s).
|
||||
|
||||
Allow to overwrite existing VM.
|
||||
|
||||
`--live-restore` `<boolean>` ::
|
||||
|
||||
Start the VM immediately from the backup and restore in background. PBS only.
|
||||
|
||||
`--pool` `<string>` ::
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
@ -30,7 +30,7 @@ Exclude specified guest systems (assumes --all)
|
||||
|
||||
`--exclude-path` `<string>` ::
|
||||
|
||||
Exclude certain files/directories (shell globs).
|
||||
Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
|
||||
|
||||
`--ionice` `<integer> (0 - 8)` ('default =' `7`)::
|
||||
|
||||
@ -46,7 +46,7 @@ Specify when to send an email
|
||||
|
||||
`--mailto` `<string>` ::
|
||||
|
||||
Comma-separated list of email addresses that should receive email notifications.
|
||||
Comma-separated list of email addresses or users that should receive email notifications.
|
||||
|
||||
`--maxfiles` `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ Store resulting files to specified directory.
|
||||
|
||||
`exclude-path`: `<string>` ::
|
||||
|
||||
Exclude certain files/directories (shell globs).
|
||||
Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
|
||||
|
||||
`ionice`: `<integer> (0 - 8)` ('default =' `7`)::
|
||||
|
||||
@ -28,7 +28,7 @@ Specify when to send an email
|
||||
|
||||
`mailto`: `<string>` ::
|
||||
|
||||
Comma-separated list of email addresses that should receive email notifications.
|
||||
Comma-separated list of email addresses or users that should receive email notifications.
|
||||
|
||||
`maxfiles`: `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user