Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-03 01:17:49 +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 2023-03-20 19:55:17 +01:00
parent 8d71568ee1
commit 9d2e98ed4f
14 changed files with 2001 additions and 352 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2146
api-viewer/apidata.js
View File

File diff suppressed because it is too large Load Diff

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

@ -26,7 +26,7 @@ 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.
`crs`: `ha=<basic|static>` ::
`crs`: `[ha=<basic|static>] [,ha-rebalance-on-start=<1|0>]` ::
Cluster resource scheduling settings.
@ -34,6 +34,10 @@ Cluster resource scheduling settings.
Configures how the HA manager should select nodes to start or recover services. With 'basic', only the number of services is used, with 'static', static CPU and memory configuration of services is considered.
`ha-rebalance-on-start`=`<boolean>` ('default =' `0`);;
Set to use CRS for selecting a suited node when a HA services request-state changes from stop to start.
`description`: `<string>` ::
Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
@ -104,6 +108,17 @@ Lower, inclusive boundary for free next-id API range.
Upper, exclusive boundary for free next-id API range.
`notify`: `package-updates=<auto|always|never>` ::
Cluster-wide notification settings.
`package-updates`=`<always | auto | never>` ('default =' `auto`);;
Control how often the daily update job should send out notification mails:
* '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.
`registered-tags`: `<tag>[;<tag>...]` ::
A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`.
@ -146,7 +161,7 @@ Privilege options for user-settable tags
`user-allow`=`<existing | free | list | none>` ('default =' `free`);;
Controls which tags can be set or deleted on resources a user controls (such as guests). Users with the `Sys.Modify` privilege on `/` are always unrestricted. 'none' no tags are usable. 'list' tags from 'user-allow-list' are usable. 'existing' like list, but already existing tags of resources are also usable.'free' no tag restrictions.
Controls which tags can be set or deleted on resources a user controls (such as guests). Users with the `Sys.Modify` privilege on `/` are always unrestricted. * 'none' no tags are usable. * 'list' tags from 'user-allow-list' are usable. * 'existing' like list, but already existing tags of resources are also usable.* 'free' no tag restrictions.
`user-allow-list`=`<tag>[;<tag>...]` ;;

16
ha-manager.1-synopsis.adoc
View File

@ -52,6 +52,22 @@ HA resource ID. This consists of a resource type followed by a resource specific
Target node.
*ha-manager crm-command node-maintenance disable* `<node>`
Change the node-maintenance request state.
`<node>`: `<string>` ::
The cluster node name.
*ha-manager crm-command node-maintenance enable* `<node>`
Change the node-maintenance request state.
`<node>`: `<string>` ::
The cluster node name.
*ha-manager crm-command relocate* `<sid> <node>`
Request resource relocatzion to another node. This stops the service on the

6
pct-network-opts.adoc
View File

@ -1,4 +1,4 @@
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@ -30,6 +30,10 @@ IPv4 address in CIDR format.
IPv6 address in CIDR format.
`link_down`=`<boolean>` ;;
Whether this interface should be disconnected (like pulling the plug).
`mtu`=`<integer> (64 - 65535)` ;;
Maximum transfer unit of the interface. (lxc.network.mtu)

15
pct.1-synopsis.adoc
View File

@ -88,7 +88,7 @@ The (unique) ID of the VM.
The OS template or backup file.
`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
OS architecture type.
@ -162,7 +162,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@ -330,7 +330,8 @@ Force checking, even if the filesystem seems clean
*pct fstrim* `<vmid>` `[OPTIONS]`
Run fstrim on a chosen CT and its mountpoints.
Run fstrim on a chosen CT and its mountpoints, except bind or read-only
mountpoints.
`<vmid>`: `<integer> (1 - N)` ::
@ -620,7 +621,7 @@ The (unique) ID of the VM.
The OS template or backup file.
`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
OS architecture type.
@ -694,7 +695,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@ -808,7 +809,7 @@ Set container options.
The (unique) ID of the VM.
`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
OS architecture type.
@ -878,7 +879,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.

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

@ -1,4 +1,4 @@
`arch`: `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
`arch`: `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
OS architecture type.
@ -128,7 +128,7 @@ Volume, device or directory to mount into the container.
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
@ -160,6 +160,10 @@ IPv4 address in CIDR format.
IPv6 address in CIDR format.
`link_down`=`<boolean>` ;;
Whether this interface should be disconnected (like pulling the plug).
`mtu`=`<integer> (64 - 65535)` ;;
Maximum transfer unit of the interface. (lxc.network.mtu)

4
pve-firewall-host-opts.adoc
View File

@ -22,6 +22,10 @@ Enable NDP (Neighbor Discovery Protocol).
Allow invalid packets on connection tracking.
`nf_conntrack_helpers`: `<string>` ('default =' ``)::
Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp
`nf_conntrack_max`: `<integer> (32768 - N)` ('default =' `262144`)::
Maximum number of tracked connections.

5
pveceph.1-synopsis.adoc
View File

@ -308,7 +308,7 @@ Remove all pveceph-managed storages configured for this pool
*pveceph pool get* `<name>` `[OPTIONS]` `[FORMAT_OPTIONS]`
List pool settings.
Show the current pool status.
`<name>`: `<string>` ::
@ -320,7 +320,8 @@ If enabled, will display additional data(eg. statistics).
*pveceph pool ls* `[FORMAT_OPTIONS]`
List all pools.
List all pools and their settings (which are settable by the POST/PUT
endpoints).
*pveceph pool set* `<name>` `[OPTIONS]`

20
pvenode.1-synopsis.adoc
View File

@ -81,7 +81,7 @@ ACME challenge type.
ACME Plugin ID name
`--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` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | 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 | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | 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 | 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` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | 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 | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
API plugin name
@ -255,7 +255,7 @@ Target node.
`--maxworkers` `<integer> (1 - N)` ::
Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!
`--vms` `<string>` ::
@ -282,6 +282,14 @@ Only consider guests from this comma separated list of VMIDs.
Stop all VMs and Containers.
`--force-stop` `<boolean>` ('default =' `1`)::
Force a hard-stop after the timeout.
`--timeout` `<integer> (0 - 7200)` ('default =' `180`)::
Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced.
`--vms` `<string>` ::
Only consider Guests with these IDs.
@ -338,9 +346,13 @@ Read task log.
The task's unique ID.
`--download` `<boolean>` ::
Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters
`--start` `<integer> (0 - N)` ('default =' `0`)::
The line number to start printing at.
Start at this line when reading the tasklog
*pvenode task status* `<upid>` `[FORMAT_OPTIONS]`

8
pvesm.1-synopsis.adoc
View File

@ -42,6 +42,10 @@ Allowed content types.
+
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
`--content-dirs` `<string>` ::
Overrides for default content type directories.
`--data-pool` `<string>` ::
Data Pool (for erasure coding only)
@ -594,6 +598,10 @@ Allowed content types.
+
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
`--content-dirs` `<string>` ::
Overrides for default content type directories.
`--data-pool` `<string>` ::
Data Pool (for erasure coding only)

40
pveum.1-synopsis.adoc
View File

@ -134,7 +134,7 @@ Change user password.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
*pveum pool add* `<poolid>` `[OPTIONS]`
@ -200,11 +200,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
Automatically create users if they do not exist.
`--base_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
`--base_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
LDAP base domain name
`--bind_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
`--bind_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
LDAP bind domain name
@ -252,7 +252,7 @@ LDAP filter for user sync.
The objectclasses for groups.
`--group_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
`--group_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
LDAP base domain name for group sync. If not set, the base_dn will be used.
@ -304,7 +304,7 @@ Fallback Server IP address (or DNS name)
LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!
`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=[acl];[properties];[entry]] [,scope=<users|groups|both>]` ::
`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=([acl];[properties];[entry])|none] [,scope=<users|groups|both>]` ::
The default options for behavior of synchronizations.
@ -364,11 +364,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
Automatically create users if they do not exist.
`--base_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
`--base_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
LDAP base domain name
`--bind_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
`--bind_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
LDAP bind domain name
@ -424,7 +424,7 @@ LDAP filter for user sync.
The objectclasses for groups.
`--group_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
`--group_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
LDAP base domain name for group sync. If not set, the base_dn will be used.
@ -476,7 +476,7 @@ Fallback Server IP address (or DNS name)
LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!
`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=[acl];[properties];[entry]] [,scope=<users|groups|both>]` ::
`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=([acl];[properties];[entry])|none] [,scope=<users|groups|both>]` ::
The default options for behavior of synchronizations.
@ -526,9 +526,9 @@ DEPRECATED: use 'remove-vanished' instead. If set, uses the LDAP Directory as so
DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync.
`--remove-vanished` `[acl];[properties];[entry]` ::
`--remove-vanished` `([acl];[properties];[entry])|none` ('default =' `none`)::
A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync.
A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).
`--scope` `<both | groups | users>` ::
@ -630,7 +630,7 @@ Create new user.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`--comment` `<string>` ::
@ -674,7 +674,7 @@ Delete user.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
@ -694,7 +694,7 @@ Update user configuration.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`--append` `<boolean>` ::
@ -752,7 +752,7 @@ Delete TFA entries from a user.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`--id` `<string>` ::
@ -765,7 +765,7 @@ value, which needs to be stored as it cannot be retrieved afterwards!
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
@ -789,7 +789,7 @@ Get user API tokens.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
*pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
@ -797,7 +797,7 @@ Update API token for a specific user.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
@ -821,7 +821,7 @@ Retrieve effective permissions of given token.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
@ -837,7 +837,7 @@ Remove API token for a specific user.
`<userid>`: `<string>` ::
User ID
Full User ID, in the `name@realm` format.
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::

6
qm-cloud-init-opts.adoc
View File

@ -9,15 +9,15 @@ Specify a custom file containing all meta data passed to the VM via"
`network`=`<volume>` ;;
Specify a custom file containing all network data passed to the VM via cloud-init.
To pass a custom file containing all network data to the VM via cloud-init.
`user`=`<volume>` ;;
Specify a custom file containing all user data passed to the VM via cloud-init.
To pass a custom file containing all user data to the VM via cloud-init.
`vendor`=`<volume>` ;;
Specify a custom file containing all vendor data passed to the VM via cloud-init.
To pass a custom file containing all vendor data to the VM via cloud-init.
`cipassword`: `<string>` ::

32
qm.1-synopsis.adoc
View File

@ -131,9 +131,9 @@ Enable/disable ACPI.
List of host cores used to execute guest processes, for example: 0,5,8-11
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
Enable/disable communication with the Qemu Guest Agent and its properties.
Enable/disable communication with the QEMU Guest Agent and its properties.
`--arch` `<aarch64 | x86_64>` ::
@ -157,7 +157,7 @@ Automatic restart after crash (currently ignored).
`--balloon` `<integer> (0 - N)` ::
Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
`--bios` `<ovmf | seabios>` ('default =' `seabios`)::
@ -217,7 +217,7 @@ Description for the VM. Shown in the web-interface VM's summary. This is saved a
`--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
`--force` `<boolean>` ::
@ -295,11 +295,11 @@ 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+)?)` ::
Specifies the Qemu machine type.
Specifies the QEMU machine type.
`--memory` `<integer> (16 - N)` ('default =' `512`)::
Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
@ -633,7 +633,7 @@ A list of disk IDs you want to delete.
*qm guest cmd* `<vmid> <command>`
Execute Qemu Guest Agent commands.
Execute QEMU Guest Agent commands.
`<vmid>`: `<integer> (1 - N)` ::
@ -793,7 +793,7 @@ Enable live storage migration for local disk
*qm monitor* `<vmid>`
Enter Qemu Monitor interface.
Enter QEMU Monitor interface.
`<vmid>`: `<integer> (1 - N)` ::
@ -927,7 +927,7 @@ The name of the snapshot.
`--start` `<boolean>` ('default =' `0`)::
Whether the VM should get started after rolling back successfully
Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)
*qm sendkey* `<vmid> <key>` `[OPTIONS]`
@ -963,9 +963,9 @@ Enable/disable ACPI.
List of host cores used to execute guest processes, for example: 0,5,8-11
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
Enable/disable communication with the Qemu Guest Agent and its properties.
Enable/disable communication with the QEMU Guest Agent and its properties.
`--arch` `<aarch64 | x86_64>` ::
@ -985,7 +985,7 @@ Automatic restart after crash (currently ignored).
`--balloon` `<integer> (0 - N)` ::
Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
`--bios` `<ovmf | seabios>` ('default =' `seabios`)::
@ -1049,7 +1049,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
`--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
`--force` `<boolean>` ::
@ -1121,11 +1121,11 @@ 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+)?)` ::
Specifies the Qemu machine type.
Specifies the QEMU machine type.
`--memory` `<integer> (16 - N)` ('default =' `512`)::
Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
@ -1367,7 +1367,7 @@ 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+)?)` ::
Specifies the Qemu machine type.
Specifies the QEMU machine type.
`--migratedfrom` `<string>` ::

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

@ -6,13 +6,17 @@ Enable/disable ACPI.
List of host cores used to execute guest processes, for example: 0,5,8-11
`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
`agent`: `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` ::
Enable/disable communication with the Qemu Guest Agent and its properties.
Enable/disable communication with the QEMU Guest Agent and its properties.
`enabled`=`<boolean>` ('default =' `0`);;
Enable/disable communication with a Qemu Guest Agent (QGA) running in the VM.
Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.
`freeze-fs-on-backup`=`<boolean>` ('default =' `1`);;
Freeze/thaw guest filesystems on backup for consistency.
`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
@ -52,7 +56,7 @@ Automatic restart after crash (currently ignored).
`balloon`: `<integer> (0 - N)` ::
Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.
`bios`: `<ovmf | seabios>` ('default =' `seabios`)::
@ -99,15 +103,15 @@ Specify a custom file containing all meta data passed to the VM via"
`network`=`<volume>` ;;
Specify a custom file containing all network data passed to the VM via cloud-init.
To pass a custom file containing all network data to the VM via cloud-init.
`user`=`<volume>` ;;
Specify a custom file containing all user data passed to the VM via cloud-init.
To pass a custom file containing all user data to the VM via cloud-init.
`vendor`=`<volume>` ;;
Specify a custom file containing all vendor data passed to the VM via cloud-init.
To pass a custom file containing all vendor data to the VM via cloud-init.
`cipassword`: `<string>` ::
@ -169,11 +173,11 @@ Description for the VM. Shown in the web-interface VM's summary. This is saved a
`efidisk0`: `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars.
Configure a disk for storing EFI vars.
`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.
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. Ignored for VMs with arch=aarc64 (ARM).
`file`=`<volume>` ;;
@ -513,11 +517,11 @@ 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+)?)` ::
Specifies the Qemu machine type.
Specifies the QEMU machine type.
`memory`: `<integer> (16 - N)` ('default =' `512`)::
Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.
`migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
@ -635,7 +639,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
l26;; Linux 2.6 - 6.X Kernel
solaris;; Solaris/OpenSolaris/OpenIndiania kernel
`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::