mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-28 04:35:36 +00:00
update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
62ef2acb18
commit
907e4bc32b
File diff suppressed because it is too large
Load Diff
@ -117,38 +117,33 @@ Upper, exclusive boundary for free next-id API range.
|
||||
|
||||
Cluster-wide notification settings.
|
||||
|
||||
`fencing`=`<always | never>` ('default =' `always`);;
|
||||
`fencing`=`<always | never>` ;;
|
||||
|
||||
Control if notifications about node fencing should be sent.
|
||||
* 'always' always send out notifications
|
||||
* 'never' never send out notifications.
|
||||
For production systems, turning off node fencing notifications is notrecommended!
|
||||
UNUSED - Use datacenter notification settings instead.
|
||||
|
||||
`package-updates`=`<always | auto | never>` ('default =' `auto`);;
|
||||
|
||||
DEPRECATED: Use datacenter notification settings instead.
|
||||
Control how often the daily update job should send out notifications:
|
||||
* 'auto' daily for systems with a valid subscription, as those are assumed to be production-ready and thus should know about pending updates.
|
||||
* 'always' every update, if there are new pending updates.
|
||||
* 'never' never send a notification for new pending updates.
|
||||
|
||||
`replication`=`<always | never>` ('default =' `always`);;
|
||||
`replication`=`<always | never>` ;;
|
||||
|
||||
Control if notifications for replication failures should be sent.
|
||||
* 'always' always send out notifications
|
||||
* 'never' never send out notifications.
|
||||
For production systems, turning off replication notifications is notrecommended!
|
||||
UNUSED - Use datacenter notification settings instead.
|
||||
|
||||
`target-fencing`=`<TARGET>` ;;
|
||||
|
||||
Control where notifications about fenced cluster nodes should be sent to. Has to be the name of a notification target (endpoint or notification group). If the 'target-fencing' parameter is not set, the system will send mails to root via a 'sendmail' notification endpoint.
|
||||
UNUSED - Use datacenter notification settings instead.
|
||||
|
||||
`target-package-updates`=`<TARGET>` ;;
|
||||
|
||||
Control where notifications about available updates should be sent to. Has to be the name of a notification target (endpoint or notification group). If the 'target-package-updates' parameter is not set, the system will send mails to root via a 'sendmail' notification endpoint.
|
||||
UNUSED - Use datacenter notification settings instead.
|
||||
|
||||
`target-replication`=`<TARGET>` ;;
|
||||
|
||||
Control where notifications for failed storage replication jobs should be sent to. Has to be the name of a notification target (endpoint or notification group). If the 'target-replication' parameter is not set, the system will send mails to root via a 'sendmail' notification endpoint.
|
||||
UNUSED - Use datacenter notification settings instead.
|
||||
|
||||
`registered-tags`: `<tag>[;<tag>...]` ::
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ Add the new CT to the specified pool.
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Target storage for full clone.
|
||||
|
||||
@ -214,7 +214,7 @@ Start the CT after its creation finished successfully.
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
|
||||
|
||||
`--storage` `<string>` ('default =' `local`)::
|
||||
`--storage` `<storage ID>` ('default =' `local`)::
|
||||
|
||||
Default Storage.
|
||||
|
||||
@ -432,7 +432,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Volume which will be moved.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
Target Storage.
|
||||
|
||||
@ -557,7 +557,7 @@ The (unique) ID of the VM.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<target-endpoint>`: `apitoken=<user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
|
||||
`<target-endpoint>`: `apitoken=<PVEAPIToken=user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
|
||||
|
||||
Remote target endpoint
|
||||
|
||||
@ -755,7 +755,7 @@ Start the CT after its creation finished successfully.
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
|
||||
|
||||
`--storage` `<string>` ('default =' `local`)::
|
||||
`--storage` `<storage ID>` ('default =' `local`)::
|
||||
|
||||
Default Storage.
|
||||
|
||||
@ -1029,6 +1029,10 @@ container.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--overrule-shutdown` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Try to abort active 'vzshutdown' tasks before stopping.
|
||||
|
||||
`--skiplock` `<boolean>` ::
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
|
||||
@ -38,6 +38,10 @@ Conntrack established timeout.
|
||||
|
||||
Conntrack syn recv timeout.
|
||||
|
||||
`nftables`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable nftables based firewall (tech preview)
|
||||
|
||||
`nosmurfs`: `<boolean>` ::
|
||||
|
||||
Enable SMURFS filter.
|
||||
|
||||
@ -12,7 +12,7 @@ Restrict list to specified section.
|
||||
|
||||
Download appliance templates.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage where the template will be stored
|
||||
|
||||
@ -36,7 +36,7 @@ Verbose output format.
|
||||
|
||||
Get list of all templates on storage
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
Only list templates on specified storage
|
||||
|
||||
|
||||
@ -185,4 +185,8 @@ Force generation of new SSL certificate.
|
||||
|
||||
Ignore errors (i.e. when cluster has no quorum).
|
||||
|
||||
`--unmerge-known-hosts` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Unmerge legacy SSH known hosts.
|
||||
|
||||
|
||||
|
||||
@ -229,9 +229,9 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
|
||||
|
||||
Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
|
||||
|
||||
`--wakeonlan` `<string>` ::
|
||||
`--wakeonlan` `[mac=]<MAC address> [,bind-interface=<bind interface>] [,broadcast-address=<IPv4 broadcast address>]` ::
|
||||
|
||||
MAC address for wake on LAN
|
||||
Node specific wake on LAN settings.
|
||||
|
||||
*pvenode help* `[OPTIONS]`
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ Create a new storage.
|
||||
|
||||
Storage type.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -170,7 +170,7 @@ File system path.
|
||||
|
||||
Pool.
|
||||
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
`--port` `<integer> (1 - 65535)` ::
|
||||
|
||||
For non default port.
|
||||
|
||||
@ -260,7 +260,7 @@ Glusterfs Volume.
|
||||
|
||||
Allocate disk images.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -342,7 +342,7 @@ Volume identifier
|
||||
|
||||
Time to wait for the task to finish. We return 'null' if the task finish within that time.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -406,7 +406,7 @@ An alias for 'pvesm scan iscsi'.
|
||||
|
||||
List storage content.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -444,7 +444,7 @@ 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>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -492,7 +492,7 @@ Only consider backups for this guest.
|
||||
|
||||
Delete storage configuration.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -584,7 +584,7 @@ Scan zfs pool list on local node.
|
||||
|
||||
Update storage configuration.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -730,7 +730,7 @@ Password for accessing the share/datastore.
|
||||
|
||||
Pool.
|
||||
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
`--port` `<integer> (1 - 65535)` ::
|
||||
|
||||
For non default port.
|
||||
|
||||
@ -808,7 +808,7 @@ Only list stores which are enabled (not disabled in config).
|
||||
|
||||
Include information about formats
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Only list status for specified storage
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ Add the new VM to the specified pool.
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Target storage for full clone.
|
||||
|
||||
@ -295,9 +295,9 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
|
||||
|
||||
Specifies the QEMU machine type.
|
||||
Specify the QEMU machine.
|
||||
|
||||
`--memory` `[current=]<integer>` ::
|
||||
|
||||
@ -415,7 +415,7 @@ Set the initial date of the real time clock. Valid format for date are:'now' or
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Default storage.
|
||||
|
||||
@ -469,7 +469,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID
|
||||
|
||||
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
|
||||
|
||||
`--vmstatestorage` `<string>` ::
|
||||
`--vmstatestorage` `<storage ID>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
|
||||
@ -527,7 +527,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Path to the disk image to import
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
Target storage ID
|
||||
|
||||
@ -547,7 +547,7 @@ The (unique) ID of the VM.
|
||||
|
||||
The disk you want to move.
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
Target storage.
|
||||
|
||||
@ -892,9 +892,9 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
|
||||
|
||||
Specifies the QEMU machine type.
|
||||
Specify the QEMU machine.
|
||||
|
||||
`--memory` `[current=]<integer>` ::
|
||||
|
||||
@ -1004,7 +1004,7 @@ Set the initial date of the real time clock. Valid format for date are:'now' or
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Default storage.
|
||||
|
||||
@ -1052,7 +1052,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
|
||||
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
|
||||
|
||||
`--vmstatestorage` `<string>` ::
|
||||
`--vmstatestorage` `<storage ID>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
|
||||
@ -1076,7 +1076,7 @@ The (unique) ID of the VM.
|
||||
|
||||
path to the ovf file
|
||||
|
||||
`<storage>`: `<string>` ::
|
||||
`<storage>`: `<storage ID>` ::
|
||||
|
||||
Target storage ID
|
||||
|
||||
@ -1206,7 +1206,7 @@ The (unique) ID of the VM.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<target-endpoint>`: `apitoken=<user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
|
||||
`<target-endpoint>`: `apitoken=<PVEAPIToken=user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
|
||||
|
||||
Remote target endpoint
|
||||
|
||||
@ -1476,9 +1476,9 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
|
||||
|
||||
Specifies the QEMU machine type.
|
||||
Specify the QEMU machine.
|
||||
|
||||
`--memory` `[current=]<integer>` ::
|
||||
|
||||
@ -1640,7 +1640,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID
|
||||
|
||||
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
|
||||
|
||||
`--vmstatestorage` `<string>` ::
|
||||
`--vmstatestorage` `<storage ID>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
|
||||
@ -1667,7 +1667,7 @@ Fetch config values from given snapshot.
|
||||
*qm shutdown* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Shutdown virtual machine. This is similar to pressing the power button on a
|
||||
physical machine.This will send an ACPI event for the guest OS, which
|
||||
physical machine. This will send an ACPI event for the guest OS, which
|
||||
should then proceed to a clean shutdown.
|
||||
|
||||
`<vmid>`: `<integer> (100 - 999999999)` ::
|
||||
@ -1722,9 +1722,9 @@ The (unique) ID of the VM.
|
||||
|
||||
Override QEMU's -cpu argument with the given string.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
|
||||
|
||||
Specifies the QEMU machine type.
|
||||
Specify the QEMU machine.
|
||||
|
||||
`--migratedfrom` `<string>` ::
|
||||
|
||||
@ -1768,8 +1768,8 @@ Verbose output format
|
||||
|
||||
*qm stop* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Stop virtual machine. The qemu process will exit immediately. Thisis akin
|
||||
to pulling the power plug of a running computer and may damage the VM data
|
||||
Stop virtual machine. The qemu process will exit immediately. This is akin
|
||||
to pulling the power plug of a running computer and may damage the VM data.
|
||||
|
||||
`<vmid>`: `<integer> (100 - 999999999)` ::
|
||||
|
||||
@ -1783,6 +1783,10 @@ Do not deactivate storage volumes.
|
||||
|
||||
The cluster node name.
|
||||
|
||||
`--overrule-shutdown` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Try to abort active 'qmshutdown' tasks before stopping.
|
||||
|
||||
`--skiplock` `<boolean>` ::
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
@ -1803,7 +1807,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
|
||||
`--statestorage` `<string>` ::
|
||||
`--statestorage` `<storage ID>` ::
|
||||
|
||||
The storage for the VM state
|
||||
+
|
||||
|
||||
@ -525,10 +525,18 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` ::
|
||||
`machine`: `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
|
||||
|
||||
Specify the QEMU machine.
|
||||
|
||||
`type`=`<machine type>` ;;
|
||||
|
||||
Specifies the QEMU machine type.
|
||||
|
||||
`viommu`=`<intel | virtio>` ;;
|
||||
|
||||
Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).
|
||||
|
||||
`memory`: `[current=]<integer>` ::
|
||||
|
||||
Memory properties.
|
||||
@ -1423,7 +1431,7 @@ Write error action.
|
||||
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 through API/CLI create or update methods, but not when manually editing the config file.
|
||||
|
||||
`vmstatestorage`: `<string>` ::
|
||||
`vmstatestorage`: `<storage ID>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ Start the VM immediately from the backup and restore in background. PBS only.
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Default storage.
|
||||
|
||||
|
||||
@ -32,6 +32,10 @@ Exclude specified guest systems (assumes --all)
|
||||
|
||||
Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
|
||||
|
||||
`--fleecing` `[[enabled=]<1|0>] [,storage=<storage ID>]` ::
|
||||
|
||||
Options for backup fleecing (VM only).
|
||||
|
||||
`--ionice` `<integer> (0 - 8)` ('default =' `7`)::
|
||||
|
||||
Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
|
||||
@ -128,7 +132,7 @@ Stop running backup jobs on this host.
|
||||
|
||||
Maximal time to wait until a guest system is stopped (minutes).
|
||||
|
||||
`--storage` `<string>` ::
|
||||
`--storage` `<storage ID>` ::
|
||||
|
||||
Store resulting file to this storage.
|
||||
|
||||
|
||||
@ -14,6 +14,18 @@ Store resulting files to specified directory.
|
||||
|
||||
Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.
|
||||
|
||||
`fleecing`: `[[enabled=]<1|0>] [,storage=<storage ID>]` ::
|
||||
|
||||
Options for backup fleecing (VM only).
|
||||
|
||||
`enabled`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Enable backup fleecing. Cache backup data from blocks where new guest writes happen on specified storage instead of copying them directly to the backup target. This can help guest IO performance and even prevent hangs, at the cost of requiring more storage space.
|
||||
|
||||
`storage`=`<storage ID>` ;;
|
||||
|
||||
Use this storage to storage fleecing images. For efficient space usage, it's best to use a local storage that supports discard and either thin provisioning or sparse files.
|
||||
|
||||
`ionice`: `<integer> (0 - 8)` ('default =' `7`)::
|
||||
|
||||
Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
|
||||
@ -130,7 +142,7 @@ Exclude temporary files and logs.
|
||||
|
||||
Maximal time to wait until a guest system is stopped (minutes).
|
||||
|
||||
`storage`: `<string>` ::
|
||||
`storage`: `<storage ID>` ::
|
||||
|
||||
Store resulting file to this storage.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user