mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-08-02 18:12:14 +00:00
update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
8d5c645cf7
commit
5370fa8ca1
File diff suppressed because it is too large
Load Diff
@ -26,6 +26,10 @@ bandwidth limit in KiB/s for restoring guests from backups
|
||||
|
||||
Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.
|
||||
|
||||
`description`: `<string>` ::
|
||||
|
||||
Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
|
||||
|
||||
`email_from`: `<string>` ::
|
||||
|
||||
Specify email address to send notification from (default is root@$hostname)
|
||||
@ -92,3 +96,19 @@ U2F AppId URL override. Defaults to the origin.
|
||||
|
||||
U2F Origin override. Mostly useful for single nodes with a single URL.
|
||||
|
||||
`webauthn`: `[id=<DOMAINNAME>] [,origin=<URL>] [,rp=<RELYING_PARTY>]` ::
|
||||
|
||||
webauthn configuration
|
||||
|
||||
`id`=`<DOMAINNAME>` ;;
|
||||
|
||||
Relying part ID. Must be the domain name without protocol, port or location. Changing this *will* break existing credentials.
|
||||
|
||||
`origin`=`<URL>` ;;
|
||||
|
||||
Site origin. Must be a `https://` URL (or `http://localhost`). Should contain the address users type in their browsers to access the web interface. Changing this *may* break existing credentials.
|
||||
|
||||
`rp`=`<RELYING_PARTY>` ;;
|
||||
|
||||
Relying party name. Any text identifier. Changing this *may* break existing credentials.
|
||||
|
||||
|
||||
@ -404,15 +404,16 @@ further operations on the container other than start and stop.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`
|
||||
*pct move-volume* `<vmid> <volume> [<storage>] [<target-vmid>] [<target-volume>]` `[OPTIONS]`
|
||||
|
||||
Move a rootfs-/mp-volume to a different storage
|
||||
Move a rootfs-/mp-volume to a different storage or to a different
|
||||
container.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
|
||||
`<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
|
||||
|
||||
Volume which will be moved.
|
||||
|
||||
@ -420,6 +421,14 @@ Volume which will be moved.
|
||||
|
||||
Target Storage.
|
||||
|
||||
`<target-vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<target-volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99>` ::
|
||||
|
||||
The config key the volume will be moved to. Default is the source volume key.
|
||||
|
||||
`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::
|
||||
|
||||
Override I/O bandwidth limit (in KiB/s).
|
||||
@ -430,7 +439,18 @@ Delete the original volume after successful copy. By default the original is kep
|
||||
|
||||
`--digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
Prevent changes if current configuration file has different SHA1 " .
|
||||
"digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--target-digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file of the target " .
|
||||
"container has a different SHA1 digest. This can be used to prevent " .
|
||||
"concurrent modifications.
|
||||
|
||||
*pct move_volume*
|
||||
|
||||
An alias for 'pct move-volume'.
|
||||
|
||||
*pct pending* `<vmid>`
|
||||
|
||||
@ -947,7 +967,7 @@ Ignore locks - only root is allowed to use this option.
|
||||
|
||||
*pct suspend* `<vmid>`
|
||||
|
||||
Suspend the container.
|
||||
Suspend the container. This is experimental.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
|
||||
@ -48,6 +48,22 @@ The ceph filesystem name.
|
||||
|
||||
Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.
|
||||
|
||||
*pveceph fs destroy* `<name>` `[OPTIONS]`
|
||||
|
||||
Destroy a Ceph filesystem
|
||||
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The ceph filesystem name.
|
||||
|
||||
`--remove-pools` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Remove data and metadata pools configured for this fs.
|
||||
|
||||
`--remove-storages` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Remove all pveceph-managed storages configured for this fs.
|
||||
|
||||
*pveceph help* `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
@ -81,7 +81,7 @@ ACME challenge type.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | 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 | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | 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 | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
@ -133,7 +133,7 @@ Update ACME plugin configuration.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | 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 | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | 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 | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
@ -292,7 +292,7 @@ Read task list for one node (finished tasks).
|
||||
|
||||
`--errors` `<boolean>` ('default =' `0`)::
|
||||
|
||||
no description available
|
||||
Only list tasks with a status of ERROR.
|
||||
|
||||
`--limit` `<integer> (0 - N)` ('default =' `50`)::
|
||||
|
||||
@ -336,11 +336,11 @@ Read task log.
|
||||
|
||||
`<upid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
The task's unique ID.
|
||||
|
||||
`--start` `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
no description available
|
||||
The line number to start printing at.
|
||||
|
||||
*pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
|
||||
|
||||
@ -348,7 +348,7 @@ Read task status.
|
||||
|
||||
`<upid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
The task's unique ID.
|
||||
|
||||
*pvenode wakeonlan* `<node>`
|
||||
|
||||
|
||||
@ -70,6 +70,10 @@ Certificate SHA 256 fingerprint.
|
||||
|
||||
Default image format.
|
||||
|
||||
`--fs-name` `<string>` ::
|
||||
|
||||
The Ceph filesystem name.
|
||||
|
||||
`--fuse` `<boolean>` ::
|
||||
|
||||
Mount CephFS through FUSE.
|
||||
@ -82,6 +86,10 @@ Assume the given path is an externally managed mountpoint and consider the stora
|
||||
|
||||
iscsi provider
|
||||
|
||||
`--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
|
||||
|
||||
Client keyring contents (for external clusters).
|
||||
|
||||
`--krbd` `<boolean>` ::
|
||||
|
||||
Always access rbd through krbd kernel module.
|
||||
@ -150,6 +158,10 @@ For non default port.
|
||||
|
||||
iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
|
||||
|
||||
Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
|
||||
|
||||
`--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.
|
||||
@ -180,9 +192,9 @@ CIFS share.
|
||||
|
||||
Mark storage as shared.
|
||||
|
||||
`--smbversion` `<2.0 | 2.1 | 3.0>` ::
|
||||
`--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
|
||||
|
||||
SMB protocol version
|
||||
SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
|
||||
|
||||
`--sparse` `<boolean>` ::
|
||||
|
||||
@ -602,6 +614,10 @@ Certificate SHA 256 fingerprint.
|
||||
|
||||
Default image format.
|
||||
|
||||
`--fs-name` `<string>` ::
|
||||
|
||||
The Ceph filesystem name.
|
||||
|
||||
`--fuse` `<boolean>` ::
|
||||
|
||||
Mount CephFS through FUSE.
|
||||
@ -610,6 +626,10 @@ Mount CephFS through FUSE.
|
||||
|
||||
Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.
|
||||
|
||||
`--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
|
||||
|
||||
Client keyring contents (for external clusters).
|
||||
|
||||
`--krbd` `<boolean>` ::
|
||||
|
||||
Always access rbd through krbd kernel module.
|
||||
@ -670,6 +690,10 @@ Pool.
|
||||
|
||||
For non default port.
|
||||
|
||||
`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
|
||||
|
||||
Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
|
||||
|
||||
`--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.
|
||||
@ -696,9 +720,9 @@ NOTE: Requires option(s): `server`
|
||||
|
||||
Mark storage as shared.
|
||||
|
||||
`--smbversion` `<2.0 | 2.1 | 3.0>` ::
|
||||
`--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
|
||||
|
||||
SMB protocol version
|
||||
SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
|
||||
|
||||
`--sparse` `<boolean>` ::
|
||||
|
||||
|
||||
@ -568,6 +568,10 @@ Create or verify authentication ticket.
|
||||
|
||||
User name
|
||||
|
||||
`--new-format` `<boolean>` ('default =' `0`)::
|
||||
|
||||
With webauthn the format of half-authenticated tickts changed. New clients should pass 1 here and not worry about the old format. The old format is deprecated and will be retired with PVE-8.0
|
||||
|
||||
`--otp` `<string>` ::
|
||||
|
||||
One-time password for Two-factor authentication.
|
||||
@ -588,6 +592,10 @@ NOTE: Requires option(s): `path`
|
||||
|
||||
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
|
||||
|
||||
`--tfa-challenge` `<string>` ::
|
||||
|
||||
The signed TFA challenge string the user wants to respond to.
|
||||
|
||||
*pveum user add* `<userid>` `[OPTIONS]`
|
||||
|
||||
Create new user.
|
||||
@ -712,27 +720,15 @@ Only dump this specific path, not the whole tree.
|
||||
|
||||
*pveum user tfa delete* `<userid>` `[OPTIONS]`
|
||||
|
||||
Change user u2f authentication.
|
||||
Delete TFA entries from a user.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`--config` `type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]` ::
|
||||
`--id` `<string>` ::
|
||||
|
||||
A TFA configuration. This must currently be of type TOTP of not set at all.
|
||||
|
||||
`--key` `<string>` ::
|
||||
|
||||
When adding TOTP, the shared secret value.
|
||||
|
||||
`--password` `<string>` ::
|
||||
|
||||
The current password.
|
||||
|
||||
`--response` `<string>` ::
|
||||
|
||||
Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.
|
||||
The TFA ID, if none provided, all TFA entries will be deleted.
|
||||
|
||||
*pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
|
||||
`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
|
||||
|
||||
Specify custom files to replace the automatically generated ones at start.
|
||||
|
||||
@ -15,6 +15,10 @@ Specify a custom file containing all network data passed to the VM via cloud-ini
|
||||
|
||||
Specify a custom file containing all user data passed to the VM via cloud-init.
|
||||
|
||||
`vendor`=`<volume>` ;;
|
||||
|
||||
Specify a custom file containing all vendor data passed to the VM via cloud-init.
|
||||
|
||||
`cipassword`: `<string>` ::
|
||||
|
||||
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.
|
||||
|
||||
@ -113,7 +113,7 @@ Enable/disable ACPI.
|
||||
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
Enable/disable communication with the Qemu Guest Agent and its properties.
|
||||
|
||||
`--arch` `<aarch64 | x86_64>` ::
|
||||
|
||||
@ -145,7 +145,7 @@ Select BIOS implementation.
|
||||
|
||||
`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
|
||||
|
||||
Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
|
||||
Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
|
||||
|
||||
`--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
|
||||
|
||||
@ -159,7 +159,7 @@ Override I/O bandwidth limit (in KiB/s).
|
||||
|
||||
This is an alias for option -ide2
|
||||
|
||||
`--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
|
||||
`--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
|
||||
|
||||
cloud-init: Specify custom files to replace the automatically generated ones at start.
|
||||
|
||||
@ -187,15 +187,15 @@ Emulated CPU type.
|
||||
|
||||
Limit of CPU usage.
|
||||
|
||||
`--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
|
||||
`--cpuunits` `<integer> (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
|
||||
|
||||
CPU weight for a VM.
|
||||
CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
|
||||
|
||||
`--description` `<string>` ::
|
||||
|
||||
Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
|
||||
|
||||
`--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
`--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
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.
|
||||
|
||||
@ -219,7 +219,7 @@ Map host PCI devices into guest.
|
||||
|
||||
`--hotplug` `<string>` ('default =' `network,disk,usb`)::
|
||||
|
||||
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
|
||||
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`.
|
||||
|
||||
`--hugepages` `<1024 | 2 | any>` ::
|
||||
|
||||
@ -253,7 +253,7 @@ Use together with hugepages. If enabled, hugepages will not not be deleted after
|
||||
|
||||
`--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.
|
||||
Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.
|
||||
|
||||
`--kvm` `<boolean>` ('default =' `1`)::
|
||||
|
||||
@ -267,7 +267,7 @@ 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.
|
||||
Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
|
||||
|
||||
`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
|
||||
|
||||
@ -315,7 +315,7 @@ NUMA topology.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
|
||||
`--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
|
||||
|
||||
Specify guest operating system.
|
||||
|
||||
@ -343,7 +343,7 @@ Configure a VirtIO-based Random Number Generator.
|
||||
|
||||
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|io_uring>] [,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>]` ::
|
||||
`--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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 the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
@ -417,6 +417,10 @@ Enable/disable time drift fix.
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`--tpmstate0` `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
|
||||
|
||||
Configure a Disk for storing TPM state. 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 size of 4 MiB will always be used instead. The format is also fixed to 'raw'.
|
||||
|
||||
`--unique` `<boolean>` ::
|
||||
|
||||
Assign a unique random ethernet address.
|
||||
@ -439,7 +443,7 @@ Number of hotplugged vcpus.
|
||||
|
||||
Configure the VGA hardware.
|
||||
|
||||
`--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
|
||||
`--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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 the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
@ -677,15 +681,15 @@ Enter Qemu Monitor interface.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
|
||||
*qm move-disk* `<vmid> <disk> [<storage>]` `[OPTIONS]`
|
||||
|
||||
Move volume to different storage.
|
||||
Move volume to different storage or to a different VM.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
The disk you want to move.
|
||||
|
||||
@ -703,12 +707,30 @@ Delete the original disk after successful copy. By default the original disk is
|
||||
|
||||
`--digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
Prevent changes if current configuration file has different SHA1"
|
||||
." digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--format` `<qcow2 | raw | vmdk>` ::
|
||||
|
||||
Target Format.
|
||||
|
||||
`--target-digest` `<string>` ::
|
||||
|
||||
Prevent changes if the current config file of the target VM has a"
|
||||
." different SHA1 digest. This can be used to detect concurrent modifications.
|
||||
|
||||
`--target-disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key.
|
||||
|
||||
`--target-vmid` `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*qm move_disk*
|
||||
|
||||
An alias for 'qm move-disk'.
|
||||
|
||||
*qm mtunnel*
|
||||
|
||||
Used by qmigrate - do not use manually.
|
||||
@ -774,7 +796,7 @@ Extend volume size.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
`<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
The disk you want to resize.
|
||||
|
||||
@ -850,7 +872,7 @@ Enable/disable ACPI.
|
||||
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
Enable/disable communication with the Qemu Guest Agent and its properties.
|
||||
|
||||
`--arch` `<aarch64 | x86_64>` ::
|
||||
|
||||
@ -878,7 +900,7 @@ Select BIOS implementation.
|
||||
|
||||
`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
|
||||
|
||||
Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
|
||||
Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
|
||||
|
||||
`--bootdisk` `(ide|sata|scsi|virtio)\d+` ::
|
||||
|
||||
@ -888,7 +910,7 @@ Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instea
|
||||
|
||||
This is an alias for option -ide2
|
||||
|
||||
`--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
|
||||
`--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
|
||||
|
||||
cloud-init: Specify custom files to replace the automatically generated ones at start.
|
||||
|
||||
@ -916,9 +938,9 @@ Emulated CPU type.
|
||||
|
||||
Limit of CPU usage.
|
||||
|
||||
`--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`)::
|
||||
`--cpuunits` `<integer> (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
|
||||
|
||||
CPU weight for a VM.
|
||||
CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.
|
||||
|
||||
`--delete` `<string>` ::
|
||||
|
||||
@ -932,7 +954,7 @@ Description for the VM. Shown in the web-interface VM's summary. This is saved a
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
`--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
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.
|
||||
|
||||
@ -956,7 +978,7 @@ Map host PCI devices into guest.
|
||||
|
||||
`--hotplug` `<string>` ('default =' `network,disk,usb`)::
|
||||
|
||||
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
|
||||
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`.
|
||||
|
||||
`--hugepages` `<1024 | 2 | any>` ::
|
||||
|
||||
@ -990,7 +1012,7 @@ Use together with hugepages. If enabled, hugepages will not not be deleted after
|
||||
|
||||
`--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.
|
||||
Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.
|
||||
|
||||
`--kvm` `<boolean>` ('default =' `1`)::
|
||||
|
||||
@ -998,7 +1020,7 @@ Enable/disable KVM hardware virtualization.
|
||||
|
||||
`--localtime` `<boolean>` ::
|
||||
|
||||
Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
|
||||
Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
|
||||
|
||||
`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
|
||||
|
||||
@ -1046,7 +1068,7 @@ NUMA topology.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
|
||||
`--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
|
||||
|
||||
Specify guest operating system.
|
||||
|
||||
@ -1074,7 +1096,7 @@ Configure a VirtIO-based Random Number Generator.
|
||||
|
||||
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|io_uring>] [,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>]` ::
|
||||
`--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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 the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
@ -1144,6 +1166,10 @@ Enable/disable time drift fix.
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`--tpmstate0` `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
|
||||
|
||||
Configure a Disk for storing TPM state. 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 size of 4 MiB will always be used instead. The format is also fixed to 'raw'.
|
||||
|
||||
`--unused[n]` `[file=]<volume>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
@ -1160,7 +1186,7 @@ Number of hotplugged vcpus.
|
||||
|
||||
Configure the VGA hardware.
|
||||
|
||||
`--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
|
||||
`--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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 the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
@ -1349,7 +1375,7 @@ Create a Template.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
`--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` ::
|
||||
|
||||
If you want to convert only 1 disk to base image.
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@ Enable/disable ACPI.
|
||||
|
||||
`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
Enable/disable communication with the Qemu Guest Agent and its properties.
|
||||
|
||||
`enabled`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Enable/disable Qemu GuestAgent.
|
||||
Enable/disable communication with a Qemu Guest Agent (QGA) running in the VM.
|
||||
|
||||
`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
@ -56,7 +56,7 @@ Select BIOS implementation.
|
||||
|
||||
`boot`: `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` ::
|
||||
|
||||
Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated.
|
||||
Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.
|
||||
|
||||
`legacy`=`<[acdn]{1,4}>` ('default =' `cdn`);;
|
||||
|
||||
@ -84,7 +84,7 @@ Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instea
|
||||
|
||||
This is an alias for option -ide2
|
||||
|
||||
`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
|
||||
`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` ::
|
||||
|
||||
cloud-init: Specify custom files to replace the automatically generated ones at start.
|
||||
|
||||
@ -101,6 +101,10 @@ Specify a custom file containing all network data passed to the VM via cloud-ini
|
||||
|
||||
Specify a custom file containing all user data passed to the VM via cloud-init.
|
||||
|
||||
`vendor`=`<volume>` ;;
|
||||
|
||||
Specify a custom file containing all vendor data passed to the VM via cloud-init.
|
||||
|
||||
`cipassword`: `<string>` ::
|
||||
|
||||
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.
|
||||
@ -151,7 +155,7 @@ Limit of CPU usage.
|
||||
+
|
||||
NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
|
||||
|
||||
`cpuunits`: `<integer> (2 - 262144)` ('default =' `1024`)::
|
||||
`cpuunits`: `<integer> (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
|
||||
|
||||
CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
|
||||
|
||||
@ -159,10 +163,14 @@ CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger t
|
||||
|
||||
Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.
|
||||
|
||||
`efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
`efidisk0`: `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
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.
|
||||
|
||||
`efitype`=`<2m | 4m>` ('default =' `2m`);;
|
||||
|
||||
Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified.
|
||||
|
||||
`file`=`<volume>` ;;
|
||||
|
||||
The drive's backing volume.
|
||||
@ -171,6 +179,10 @@ The drive's backing volume.
|
||||
|
||||
The drive's backing file's data format.
|
||||
|
||||
`pre-enrolled-keys`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with 'efitype=4m'. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.
|
||||
|
||||
`size`=`<DiskSize>` ;;
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
@ -229,7 +241,7 @@ Enable vfio-vga device support.
|
||||
|
||||
`hotplug`: `<string>` ('default =' `network,disk,usb`)::
|
||||
|
||||
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
|
||||
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`.
|
||||
|
||||
`hugepages`: `<1024 | 2 | any>` ::
|
||||
|
||||
@ -465,7 +477,7 @@ Use together with hugepages. If enabled, hugepages will not not be deleted after
|
||||
|
||||
`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.
|
||||
Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.
|
||||
|
||||
`kvm`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
@ -473,7 +485,7 @@ Enable/disable KVM hardware virtualization.
|
||||
|
||||
`localtime`: `<boolean>` ::
|
||||
|
||||
Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
|
||||
Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.
|
||||
|
||||
`lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::
|
||||
|
||||
@ -536,7 +548,7 @@ Whether this interface should be disconnected (like pulling the plug).
|
||||
|
||||
A common MAC address with the I/G (Individual/Group) bit not set.
|
||||
|
||||
`model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
|
||||
`model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | e1000e | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
|
||||
|
||||
Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.
|
||||
|
||||
@ -588,7 +600,7 @@ NUMA allocation policy.
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
|
||||
`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` ::
|
||||
|
||||
Specify guest operating system. This is used to enable special
|
||||
optimization/features for specific operating systems:
|
||||
@ -603,6 +615,7 @@ wvista;; Microsoft Windows Vista
|
||||
win7;; Microsoft Windows 7
|
||||
win8;; Microsoft Windows 8/2012/2012r2
|
||||
win10;; Microsoft Windows 10/2016/2019
|
||||
win11;; Microsoft Windows 11/2022
|
||||
l24;; Linux 2.4 Kernel
|
||||
l26;; Linux 2.6 - 5.X Kernel
|
||||
solaris;; Solaris/OpenSolaris/OpenIndiania kernel
|
||||
@ -630,7 +643,7 @@ Configure a VirtIO-based Random Number Generator.
|
||||
|
||||
`max_bytes`=`<integer>` ('default =' `1024`);;
|
||||
|
||||
Maximum bytes of entropy injected into the guest every 'period' milliseconds. Prefer a lower value when using /dev/random as source. Use 0 to disable limiting (potentially dangerous!).
|
||||
Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).
|
||||
|
||||
`period`=`<integer>` ('default =' `1000`);;
|
||||
|
||||
@ -638,7 +651,7 @@ Every 'period' milliseconds the entropy-injection quota is reset, allowing the g
|
||||
|
||||
`source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
|
||||
|
||||
The file on the host to gather entropy from. In most cases /dev/urandom should be preferred over /dev/random to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. /dev/hwrng can be used to pass through a hardware RNG from the host.
|
||||
The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.
|
||||
|
||||
`sata[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
|
||||
|
||||
@ -814,7 +827,7 @@ Write error action.
|
||||
|
||||
The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
|
||||
|
||||
`scsi[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
|
||||
`scsi[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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 the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
@ -958,6 +971,10 @@ Whether the drive should considered for replication jobs.
|
||||
|
||||
Read error action.
|
||||
|
||||
`ro`=`<boolean>` ;;
|
||||
|
||||
Whether the drive is read-only.
|
||||
|
||||
`scsiblock`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
whether to use scsi-block for full passthrough of host block device
|
||||
@ -1111,6 +1128,22 @@ Enable/disable time drift fix.
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`tpmstate0`: `[file=]<volume> [,size=<DiskSize>] [,version=<v1.2|v2.0>]` ::
|
||||
|
||||
Configure a Disk for storing TPM state. 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 size of 4 MiB will always be used instead. The format is also fixed to 'raw'.
|
||||
|
||||
`file`=`<volume>` ;;
|
||||
|
||||
The drive's backing volume.
|
||||
|
||||
`size`=`<DiskSize>` ;;
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`version`=`<v1.2 | v2.0>` ('default =' `v2.0`);;
|
||||
|
||||
The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.
|
||||
|
||||
`unused[n]`: `[file=]<volume>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
@ -1159,7 +1192,7 @@ Sets the VGA memory (in MiB). Has no effect with serial display.
|
||||
|
||||
Select the VGA type.
|
||||
|
||||
`virtio[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>]` ::
|
||||
`virtio[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,ro=<1|0>] [,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 the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
|
||||
|
||||
@ -1299,6 +1332,10 @@ Whether the drive should considered for replication jobs.
|
||||
|
||||
Read error action.
|
||||
|
||||
`ro`=`<boolean>` ;;
|
||||
|
||||
Whether the drive is read-only.
|
||||
|
||||
`secs`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific sector count.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user