mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-06-13 01:42:15 +00:00
update static and schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
9d999d1bf6
commit
4772952b60
File diff suppressed because it is too large
Load Diff
@ -104,11 +104,11 @@ Console mode. By default, the console command tries to open a connection to one
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`--cores` `<integer> (1 - 128)` ::
|
||||
`--cores` `<integer> (1 - 8192)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
|
||||
`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
|
||||
|
||||
Limit of CPU usage.
|
||||
+
|
||||
@ -326,7 +326,7 @@ A volume on which to run the filesystem check
|
||||
|
||||
Force checking, even if the filesystem seems clean
|
||||
|
||||
*pct fstrim* `<vmid>`
|
||||
*pct fstrim* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Run fstrim on a chosen CT and its mountpoints.
|
||||
|
||||
@ -334,6 +334,10 @@ Run fstrim on a chosen CT and its mountpoints.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--ignore-mountpoints` `<boolean>` ::
|
||||
|
||||
Skip all mountpoints, only do fstrim on the container root.
|
||||
|
||||
*pct help* `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
@ -565,11 +569,11 @@ Console mode. By default, the console command tries to open a connection to one
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`--cores` `<integer> (1 - 128)` ::
|
||||
`--cores` `<integer> (1 - 8192)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
|
||||
`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
|
||||
|
||||
Limit of CPU usage.
|
||||
+
|
||||
@ -747,11 +751,11 @@ Console mode. By default, the console command tries to open a connection to one
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`--cores` `<integer> (1 - 128)` ::
|
||||
`--cores` `<integer> (1 - 8192)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::
|
||||
`--cpulimit` `<number> (0 - 8192)` ('default =' `0`)::
|
||||
|
||||
Limit of CPU usage.
|
||||
+
|
||||
|
||||
@ -10,11 +10,11 @@ Console mode. By default, the console command tries to open a connection to one
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`cores`: `<integer> (1 - 128)` ::
|
||||
`cores`: `<integer> (1 - 8192)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
|
||||
`cpulimit`: `<number> (0 - 8192)` ('default =' `0`)::
|
||||
|
||||
Limit of CPU usage.
|
||||
+
|
||||
|
||||
@ -12,7 +12,7 @@ Log ratelimiting settings
|
||||
|
||||
`burst`=`<integer> (0 - N)` ('default =' `5`);;
|
||||
|
||||
Inital burst of packages which will get logged
|
||||
Initial burst of packages which will always get logged before the rate is applied
|
||||
|
||||
`enable`=`<boolean>` ('default =' `1`);;
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@
|
||||
|===========================================================
|
||||
|
||||
[horizontal]
|
||||
'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Deamons)
|
||||
'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Daemons)
|
||||
|
||||
[width="100%",options="header"]
|
||||
|===========================================================
|
||||
@ -182,7 +182,7 @@
|
||||
|===========================================================
|
||||
|
||||
[horizontal]
|
||||
'HKP':: OpenPGP HTTP keyserver protocol traffic
|
||||
'HKP':: OpenPGP HTTP key server protocol traffic
|
||||
|
||||
[width="100%",options="header"]
|
||||
|===========================================================
|
||||
|
||||
@ -6,6 +6,10 @@ Restrict packet destination address. This can refer to a single IP address, an I
|
||||
|
||||
Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.
|
||||
|
||||
`--icmp-type` `<string>` ::
|
||||
|
||||
Specify icmp-type. Only valid if proto equals 'icmp'.
|
||||
|
||||
`--iface` `<string>` ::
|
||||
|
||||
Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.
|
||||
|
||||
@ -226,9 +226,9 @@ The name of the pool. It must be unique.
|
||||
|
||||
Configure VM and CT storage using the new pool.
|
||||
|
||||
`--application` `<cephfs | rbd | rgw>` ::
|
||||
`--application` `<cephfs | rbd | rgw>` ('default =' `rbd`)::
|
||||
|
||||
The application of the pool, 'rbd' by default.
|
||||
The application of the pool.
|
||||
|
||||
`--crush_rule` `<string>` ::
|
||||
|
||||
@ -238,6 +238,10 @@ The rule to use for mapping object placement in the cluster.
|
||||
|
||||
Minimum number of replicas per object
|
||||
|
||||
`--pg_autoscale_mode` `<off | on | warn>` ('default =' `warn`)::
|
||||
|
||||
The automatic PG scaling mode of the pool.
|
||||
|
||||
`--pg_num` `<integer> (8 - 32768)` ('default =' `128`)::
|
||||
|
||||
Number of placement groups.
|
||||
@ -266,6 +270,38 @@ Remove all pveceph-managed storages configured for this pool
|
||||
|
||||
List all pools.
|
||||
|
||||
*pveceph pool set* `<name>` `[OPTIONS]`
|
||||
|
||||
Change POOL settings
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`--application` `<cephfs | rbd | rgw>` ::
|
||||
|
||||
The application of the pool.
|
||||
|
||||
`--crush_rule` `<string>` ::
|
||||
|
||||
The rule to use for mapping object placement in the cluster.
|
||||
|
||||
`--min_size` `<integer> (1 - 7)` ::
|
||||
|
||||
Minimum number of replicas per object
|
||||
|
||||
`--pg_autoscale_mode` `<off | on | warn>` ::
|
||||
|
||||
The automatic PG scaling mode of the pool.
|
||||
|
||||
`--pg_num` `<integer> (8 - 32768)` ::
|
||||
|
||||
Number of placement groups.
|
||||
|
||||
`--size` `<integer> (1 - 7)` ::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
*pveceph purge* `[OPTIONS]`
|
||||
|
||||
Destroy ceph related data and configuration files.
|
||||
|
||||
@ -44,7 +44,7 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
|
||||
|
||||
`--datastore` `<string>` ::
|
||||
|
||||
Proxmox backup server datastore name.
|
||||
Proxmox Backup Server datastore name.
|
||||
|
||||
`--disable` `<boolean>` ::
|
||||
|
||||
@ -130,11 +130,15 @@ File system path.
|
||||
|
||||
Pool.
|
||||
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
|
||||
For non default port.
|
||||
|
||||
`--portal` `<string>` ::
|
||||
|
||||
iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
|
||||
|
||||
@ -384,7 +388,9 @@ Volume identifier
|
||||
|
||||
*pvesm prune-backups* `<storage>` `[OPTIONS]`
|
||||
|
||||
Prune backups. This is only a wrapper for the proper API endpoints.
|
||||
Prune backups. Only those using the standard naming scheme are considered.
|
||||
If no keep options are specified, those from the storage configuration are
|
||||
used.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
@ -394,9 +400,33 @@ The storage identifier.
|
||||
|
||||
Only show what would be pruned, don't delete anything.
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
`--keep-all` `<boolean>` ::
|
||||
|
||||
Use these retention options instead of those from the storage configuration.
|
||||
Keep all backups. Conflicts with the other options when true.
|
||||
|
||||
`--keep-daily` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
|
||||
|
||||
`--keep-hourly` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
|
||||
|
||||
`--keep-last` `<N>` ::
|
||||
|
||||
Keep the last <N> backups.
|
||||
|
||||
`--keep-monthly` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
|
||||
|
||||
`--keep-weekly` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
|
||||
|
||||
`--keep-yearly` `<N>` ::
|
||||
|
||||
Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
|
||||
|
||||
`--type` `<lxc | qemu>` ::
|
||||
|
||||
@ -584,7 +614,11 @@ Password for accessing the share/datastore.
|
||||
|
||||
Pool.
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
|
||||
For non default port.
|
||||
|
||||
`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
|
||||
|
||||
|
||||
@ -156,6 +156,10 @@ LDAP bind domain name
|
||||
|
||||
Path to the CA certificate store
|
||||
|
||||
`--case-sensitive` `<boolean>` ('default =' `1`)::
|
||||
|
||||
username is case-sensitive
|
||||
|
||||
`--cert` `<string>` ::
|
||||
|
||||
Path to the client certificate
|
||||
@ -284,6 +288,10 @@ LDAP bind domain name
|
||||
|
||||
Path to the CA certificate store
|
||||
|
||||
`--case-sensitive` `<boolean>` ('default =' `1`)::
|
||||
|
||||
username is case-sensitive
|
||||
|
||||
`--cert` `<string>` ::
|
||||
|
||||
Path to the client certificate
|
||||
|
||||
@ -4,7 +4,8 @@ Specify custom files to replace the automatically generated ones at start.
|
||||
|
||||
`meta`=`<volume>` ;;
|
||||
|
||||
Specify a custom file containing all meta data passed to the VM via cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
|
||||
Specify a custom file containing all meta data passed to the VM via"
|
||||
." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
|
||||
|
||||
`network`=`<volume>` ;;
|
||||
|
||||
@ -32,10 +33,12 @@ Specify IP addresses and gateways for the corresponding interface.
|
||||
+
|
||||
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
|
||||
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.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
|
||||
`gw`=`<GatewayIPv4>` ;;
|
||||
|
||||
@ -59,11 +62,15 @@ IPv6 address in CIDR format.
|
||||
|
||||
`nameserver`: `<string>` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
Sets DNS server IP address for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`searchdomain`: `<string>` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
Sets DNS search domains for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`sshkeys`: `<string>` ::
|
||||
|
||||
|
||||
@ -143,13 +143,13 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
|
||||
|
||||
Select BIOS implementation.
|
||||
|
||||
`--boot` `[acdn]{1,4}` ('default =' `cdn`)::
|
||||
`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
|
||||
|
||||
Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
|
||||
Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
|
||||
|
||||
`--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
|
||||
|
||||
Enable booting from specified disk.
|
||||
Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
|
||||
|
||||
`--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::
|
||||
|
||||
@ -235,15 +235,21 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface.
|
||||
+
|
||||
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
|
||||
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.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
|
||||
`--ivshmem` `size=<integer> [,name=<string>]` ::
|
||||
|
||||
Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
|
||||
|
||||
`--keephugepages` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
|
||||
|
||||
`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
|
||||
|
||||
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
|
||||
@ -282,7 +288,9 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
`--nameserver` `<string>` ::
|
||||
|
||||
cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
cloud-init: Sets DNS server IP address for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
@ -338,7 +346,9 @@ SCSI controller model
|
||||
|
||||
`--searchdomain` `<string>` ::
|
||||
|
||||
cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
cloud-init: Sets DNS search domains for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`--serial[n]` `(/dev/.+|socket)` ::
|
||||
|
||||
@ -374,7 +384,7 @@ Start VM after it was created successfully.
|
||||
|
||||
`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
|
||||
|
||||
Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
|
||||
Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.
|
||||
|
||||
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
|
||||
|
||||
@ -854,13 +864,13 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
|
||||
|
||||
Select BIOS implementation.
|
||||
|
||||
`--boot` `[acdn]{1,4}` ('default =' `cdn`)::
|
||||
`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
|
||||
|
||||
Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
|
||||
Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
|
||||
|
||||
`--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
|
||||
|
||||
Enable booting from specified disk.
|
||||
Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
|
||||
|
||||
`--cdrom` `<volume>` ::
|
||||
|
||||
@ -950,15 +960,21 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface.
|
||||
+
|
||||
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
|
||||
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.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
|
||||
`--ivshmem` `size=<integer> [,name=<string>]` ::
|
||||
|
||||
Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
|
||||
|
||||
`--keephugepages` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
|
||||
|
||||
`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
|
||||
|
||||
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
|
||||
@ -997,7 +1013,9 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
`--nameserver` `<string>` ::
|
||||
|
||||
cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
cloud-init: Sets DNS server IP address for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
@ -1053,7 +1071,9 @@ SCSI controller model
|
||||
|
||||
`--searchdomain` `<string>` ::
|
||||
|
||||
cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
cloud-init: Sets DNS search domains for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`--serial[n]` `(/dev/.+|socket)` ::
|
||||
|
||||
@ -1089,7 +1109,7 @@ cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
|
||||
|
||||
`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
|
||||
|
||||
Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
|
||||
Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.
|
||||
|
||||
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
|
||||
|
||||
|
||||
@ -54,13 +54,31 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
|
||||
|
||||
Select BIOS implementation.
|
||||
|
||||
`boot`: `[acdn]{1,4}` ('default =' `cdn`)::
|
||||
`boot`: `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
|
||||
|
||||
Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
|
||||
Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
|
||||
|
||||
`legacy`=`<[acdn]{1,4}>` ('default =' `cdn`);;
|
||||
|
||||
Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use 'order=' instead.
|
||||
|
||||
`order`=`<device[;device...]>` ;;
|
||||
|
||||
The guest will attempt to boot from devices in the order they appear here.
|
||||
+
|
||||
Disks, optical drives and passed-through storage USB devices will be directly
|
||||
booted from, NICs will load PXE, and PCIe devices will either behave like disks
|
||||
(e.g. NVMe) or load an option ROM (e.g. RAID controller, hardware NIC).
|
||||
+
|
||||
Note that only devices in this list will be marked as bootable and thus loaded
|
||||
by the guest firmware (BIOS/UEFI). If you require multiple disks for booting
|
||||
(e.g. software-raid), you need to specify all of them here.
|
||||
+
|
||||
Overrides the deprecated 'legacy=[acdn]*' value when given.
|
||||
|
||||
`bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
|
||||
|
||||
Enable booting from specified disk.
|
||||
Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.
|
||||
|
||||
`cdrom`: `<volume>` ::
|
||||
|
||||
@ -72,7 +90,8 @@ cloud-init: Specify custom files to replace the automatically generated ones at
|
||||
|
||||
`meta`=`<volume>` ;;
|
||||
|
||||
Specify a custom file containing all meta data passed to the VM via cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
|
||||
Specify a custom file containing all meta data passed to the VM via"
|
||||
." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.
|
||||
|
||||
`network`=`<volume>` ;;
|
||||
|
||||
@ -400,10 +419,12 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface.
|
||||
+
|
||||
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
|
||||
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.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using
|
||||
dhcp on IPv4.
|
||||
|
||||
`gw`=`<GatewayIPv4>` ;;
|
||||
|
||||
@ -437,6 +458,10 @@ The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Wil
|
||||
|
||||
The size of the file in MB.
|
||||
|
||||
`keephugepages`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.
|
||||
|
||||
`keyboard`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
|
||||
|
||||
Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.
|
||||
@ -475,7 +500,9 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
`nameserver`: `<string>` ::
|
||||
|
||||
cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
cloud-init: Sets DNS server IP address for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
@ -583,7 +610,8 @@ solaris;; Solaris/OpenSolaris/OpenIndiania kernel
|
||||
|
||||
Map host parallel devices (n is 0 to 2).
|
||||
+
|
||||
NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
|
||||
NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
|
||||
machines - use with special care.
|
||||
+
|
||||
CAUTION: Experimental! User reported problems with this option.
|
||||
|
||||
@ -979,7 +1007,9 @@ SCSI controller model
|
||||
|
||||
`searchdomain`: `<string>` ::
|
||||
|
||||
cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.
|
||||
cloud-init: Sets DNS search domains for a container. Create will'
|
||||
.' automatically use the setting from the host if neither searchdomain nor nameserver'
|
||||
.' are set.
|
||||
|
||||
`serial[n]`: `(/dev/.+|socket)` ::
|
||||
|
||||
@ -987,7 +1017,8 @@ Create a serial device inside the VM (n is 0 to 3), and pass through a
|
||||
host serial device (i.e. /dev/ttyS0), or create a unix socket on the
|
||||
host side (use 'qm terminal' to open a terminal connection).
|
||||
+
|
||||
NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
|
||||
NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -
|
||||
use with special care.
|
||||
+
|
||||
CAUTION: Experimental! User reported problems with this option.
|
||||
|
||||
@ -1057,7 +1088,7 @@ cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
|
||||
|
||||
`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
|
||||
|
||||
Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
|
||||
Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.
|
||||
|
||||
`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
|
||||
|
||||
@ -1065,7 +1096,7 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
|
||||
|
||||
`tablet`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl).
|
||||
Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (`qm set <vmid> --vga qxl`).
|
||||
|
||||
`tags`: `<string>` ::
|
||||
|
||||
@ -1101,7 +1132,8 @@ The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
|
||||
+
|
||||
You can use the 'lsusb -t' command to list existing usb devices.
|
||||
+
|
||||
NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
|
||||
NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such
|
||||
machines - use with special care.
|
||||
+
|
||||
The value 'spice' can be used to add a usb redirection devices for spice.
|
||||
|
||||
@ -1299,7 +1331,7 @@ Write error action.
|
||||
`vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
|
||||
|
||||
The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.
|
||||
Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
|
||||
Note that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file.
|
||||
|
||||
`vmstatestorage`: `<string>` ::
|
||||
|
||||
|
||||
@ -68,7 +68,7 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread
|
||||
|
||||
Backup all known guest systems included in the specified pool.
|
||||
|
||||
`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
Use these retention options instead of those from the storage configuration.
|
||||
|
||||
|
||||
@ -46,10 +46,14 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread
|
||||
|
||||
Backup all known guest systems included in the specified pool.
|
||||
|
||||
`prune-backups`: `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
`prune-backups`: `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
|
||||
|
||||
Use these retention options instead of those from the storage configuration.
|
||||
|
||||
`keep-all`=`<boolean>` ;;
|
||||
|
||||
Keep all backups. Conflicts with the other options when true.
|
||||
|
||||
`keep-daily`=`<N>` ;;
|
||||
|
||||
Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user