Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-02-08 05:57:33 +03:00
Code Releases Activity

update static/schema information

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2024-11-19 12:03:28 +01:00
parent ee6ba5d24d
commit 9cd1ca7852
12 changed files with 1008 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1033
api-viewer/apidata.js
View File

File diff suppressed because it is too large Load Diff

2
datacenter.cfg.5-opts.adoc
View File

@ -66,7 +66,7 @@ Specify external http proxy which is used for downloads (example: 'http://userna
`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>` ::
Default keyboard layout for vnc server.
Default keybord layout for vnc server.
`language`: `<ar | ca | da | de | en | es | eu | fa | fr | he | hr | it | ja | ka | kr | nb | nl | nn | pl | pt_BR | ru | sl | sv | tr | ukr | zh_CN | zh_TW>` ::

2
ha-resources-opts.adoc
View File

@ -8,7 +8,7 @@ The HA group identifier.
`max_relocate`: `<integer> (0 - N)` ('default =' `1`)::
Maximal number of service relocate tries when a service fails to start.
Maximal number of service relocate tries when a service failes to start.
`max_restart`: `<integer> (0 - N)` ('default =' `1`)::

14
pct.1-synopsis.adoc
View File

@ -126,7 +126,7 @@ Try to be more verbose. For now this only enables debug log-level on start.
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
`--dev[n]` `[[path=]<Path>] [,deny-write=<1|0>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
Device to pass through to the container
@ -140,7 +140,7 @@ Allow to overwrite existing container.
`--hookscript` `<string>` ::
Script that will be exectued during various steps in the containers lifetime.
Script that will be executed during various steps in the containers lifetime.
`--hostname` `<string>` ::
@ -595,7 +595,7 @@ Rescan all storages and update disk sizes and unused disk images.
`--dryrun` `<boolean>` ('default =' `0`)::
Do not actually write changes out to conifg.
Do not actually write changes to the configuration.
`--vmid` `<integer> (100 - 999999999)` ::
@ -671,7 +671,7 @@ Try to be more verbose. For now this only enables debug log-level on start.
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
`--dev[n]` `[[path=]<Path>] [,deny-write=<1|0>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
Device to pass through to the container
@ -685,7 +685,7 @@ Allow to overwrite existing container.
`--hookscript` `<string>` ::
Script that will be exectued during various steps in the containers lifetime.
Script that will be executed during various steps in the containers lifetime.
`--hostname` `<string>` ::
@ -863,7 +863,7 @@ A list of settings you want to delete.
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
`--dev[n]` `[[path=]<Path>] [,deny-write=<1|0>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
Device to pass through to the container
@ -877,7 +877,7 @@ Allow containers access to advanced features.
`--hookscript` `<string>` ::
Script that will be exectued during various steps in the containers lifetime.
Script that will be executed during various steps in the containers lifetime.
`--hostname` `<string>` ::

6
pct.conf.5-opts.adoc
View File

@ -32,10 +32,14 @@ Try to be more verbose. For now this only enables debug log-level on start.
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
`dev[n]`: `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
`dev[n]`: `[[path=]<Path>] [,deny-write=<1|0>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
Device to pass through to the container
`deny-write`=`<boolean>` ('default =' `0`);;
Deny the container to write to the device
`gid`=`<integer> (0 - N)` ;;
Group ID to be assigned to the device node

2
pve-firewall-macros.adoc
View File

@ -443,7 +443,7 @@
|===========================================================
[horizontal]
'PCA':: Symantec pcAnywhere (tm)
'PCA':: Symantec PCAnywere (tm)
[width="100%",options="header"]
|===========================================================

2
pveceph.1-synopsis.adoc
View File

@ -122,7 +122,7 @@ Allow experimental versions. Use with care!
Ceph repository to use.
`--version` `<quincy | reef>` ('default =' `quincy`)::
`--version` `<quincy | reef | squid>` ('default =' `quincy`)::
Ceph version to install.

4
pvesm.1-synopsis.adoc
View File

@ -172,7 +172,7 @@ Pool.
`--port` `<integer> (1 - 65535)` ::
For non default port.
Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options.
`--portal` `<string>` ::
@ -732,7 +732,7 @@ Pool.
`--port` `<integer> (1 - 65535)` ::
For non default port.
Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options.
`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::

24
qm.1-synopsis.adoc
View File

@ -135,6 +135,10 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
Enable/disable communication with the QEMU Guest Agent and its properties.
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
`--arch` `<aarch64 | x86_64>` ::
Virtual processor architecture. Defaults to the host.
@ -253,6 +257,10 @@ Enable/disable hugepages memory.
Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
`--import-working-storage` `<storage ID>` ::
A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage.
`--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
cloud-init: Specify IP addresses and gateways for the corresponding interface.
@ -535,6 +543,10 @@ Target storage ID
Target format
`--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 disk name where the volume will be imported to (e.g. scsi1).
*qm disk move* `<vmid> <disk> [<storage>]` `[OPTIONS]`
Move volume to different storage or to a different VM.
@ -663,7 +675,7 @@ When set, read STDIN until EOF and forward to guest agent via 'input-data' (usua
`--synchronous` `<boolean>` ('default =' `1`)::
If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
If set to off, returns the pid immediately instead of waiting for the command to finish or the timeout.
`--timeout` `<integer> (0 - N)` ('default =' `30`)::
@ -734,6 +746,10 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
Enable/disable communication with the QEMU Guest Agent and its properties.
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
`--arch` `<aarch64 | x86_64>` ::
Virtual processor architecture. Defaults to the host.
@ -1300,7 +1316,7 @@ Ignore locks - only root is allowed to use this option.
*qm set* `<vmid>` `[OPTIONS]`
Set virtual machine options (synchrounous API) - You should consider using
Set virtual machine options (synchronous API) - You should consider using
the POST method instead for any actions involving hotplug or storage
allocation.
@ -1320,6 +1336,10 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
Enable/disable communication with the QEMU Guest Agent and its properties.
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
`--arch` `<aarch64 | x86_64>` ::
Virtual processor architecture. Defaults to the host.

22
qm.conf.5-opts.adoc
View File

@ -26,6 +26,26 @@ Run fstrim after moving a disk or migrating the VM.
Select the agent type
`amd-sev`: `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
`kernel-hashes`=`<boolean>` ('default =' `0`);;
Add kernel hashes to guest firmware for measured linux kernel launch
`no-debug`=`<boolean>` ('default =' `0`);;
Sets policy bit 0 to 1 to disallow debugging of guest
`no-key-sharing`=`<boolean>` ('default =' `0`);;
Sets policy bit 1 to 1 to disallow key sharing with other guests
`type`=`<sev-type>` ;;
Enable standard SEV with type='std' or enable experimental SEV-ES with the 'es' option.
`arch`: `<aarch64 | x86_64>` ::
Virtual processor architecture. Defaults to the host.
@ -227,7 +247,7 @@ of PCI virtual functions of the host. HOSTPCIID syntax is:
+
'bus:dev.func' (hexadecimal numbers)
+
You can us the 'lspci' command to list existing PCI devices.
You can use the 'lspci' command to list existing PCI devices.
+
Either this or the 'mapping' key must be set.

4
vzdump.1-synopsis.adoc
View File

@ -40,7 +40,7 @@ Options for backup fleecing (VM only).
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.
`--job-id` `<string>` ::
`--job-id` `\S+` ::
The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter.
@ -88,7 +88,7 @@ Deprecated: Do not use
`--pbs-change-detection-mode` `<data | legacy | metadata>` ::
PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.
PBS mode used to detect file changes and switch encoding format for container backups.
`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::

2
vzdump.conf.5-opts.adoc
View File

@ -70,7 +70,7 @@ Deprecated: Do not use
`pbs-change-detection-mode`: `<data | legacy | metadata>` ::
PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.
PBS mode used to detect file changes and switch encoding format for container backups.
`performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::