mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-28 12:12:29 +00:00
update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
parent
501744f77d
commit
82551b2bea
File diff suppressed because it is too large
Load Diff
@ -108,17 +108,43 @@ Lower, inclusive boundary for free next-id API range.
|
|||||||
|
|
||||||
Upper, exclusive boundary for free next-id API range.
|
Upper, exclusive boundary for free next-id API range.
|
||||||
|
|
||||||
`notify`: `package-updates=<auto|always|never>` ::
|
`notify`: `[fencing=<always|never>] [,package-updates=<auto|always|never>] [,replication=<always|never>] [,target-fencing=<TARGET>] [,target-package-updates=<TARGET>] [,target-replication=<TARGET>]` ::
|
||||||
|
|
||||||
Cluster-wide notification settings.
|
Cluster-wide notification settings.
|
||||||
|
|
||||||
|
`fencing`=`<always | never>` ('default =' `always`);;
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
`package-updates`=`<always | auto | never>` ('default =' `auto`);;
|
`package-updates`=`<always | auto | never>` ('default =' `auto`);;
|
||||||
|
|
||||||
Control how often the daily update job should send out notification mails:
|
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.
|
* '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.
|
* 'always' every update, if there are new pending updates.
|
||||||
* 'never' never send a notification for new pending updates.
|
* 'never' never send a notification for new pending updates.
|
||||||
|
|
||||||
|
`replication`=`<always | never>` ('default =' `always`);;
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
`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.
|
||||||
|
|
||||||
|
`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.
|
||||||
|
|
||||||
|
`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.
|
||||||
|
|
||||||
`registered-tags`: `<tag>[;<tag>...]` ::
|
`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`.
|
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`.
|
||||||
|
@ -151,7 +151,7 @@ A list of settings you want to delete.
|
|||||||
|
|
||||||
`--digest` `<string>` ::
|
`--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 a different digest. This can be used to prevent concurrent modifications.
|
||||||
|
|
||||||
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
|
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
|
||||||
|
|
||||||
@ -211,7 +211,7 @@ A list of settings you want to delete.
|
|||||||
|
|
||||||
`--digest` `<string>` ::
|
`--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 a different digest. This can be used to prevent concurrent modifications.
|
||||||
|
|
||||||
`--group` `<string>` ::
|
`--group` `<string>` ::
|
||||||
|
|
||||||
|
@ -122,7 +122,7 @@ Allow experimental versions. Use with care!
|
|||||||
|
|
||||||
Ceph repository to use.
|
Ceph repository to use.
|
||||||
|
|
||||||
`--version` `<quincy>` ('default =' `quincy`)::
|
`--version` `<quincy | reef>` ('default =' `quincy`)::
|
||||||
|
|
||||||
Ceph version to install.
|
Ceph version to install.
|
||||||
|
|
||||||
|
@ -147,7 +147,7 @@ A list of settings you want to delete.
|
|||||||
|
|
||||||
`--digest` `<string>` ::
|
`--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 a different digest. This can be used to prevent concurrent modifications.
|
||||||
|
|
||||||
`--disable` `<boolean>` ::
|
`--disable` `<boolean>` ::
|
||||||
|
|
||||||
|
@ -628,7 +628,7 @@ A list of settings you want to delete.
|
|||||||
|
|
||||||
`--digest` `<string>` ::
|
`--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 a different digest. This can be used to prevent concurrent modifications.
|
||||||
|
|
||||||
`--disable` `<boolean>` ::
|
`--disable` `<boolean>` ::
|
||||||
|
|
||||||
|
@ -208,7 +208,7 @@ A list of settings you want to delete.
|
|||||||
|
|
||||||
`--digest` `<string>` ::
|
`--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 a different digest. This can be used to prevent concurrent modifications.
|
||||||
|
|
||||||
`--disable` `<boolean>` ::
|
`--disable` `<boolean>` ::
|
||||||
|
|
||||||
|
@ -168,21 +168,25 @@ Update pool data.
|
|||||||
|
|
||||||
no description available
|
no description available
|
||||||
|
|
||||||
|
`--allow-move` `<boolean>` ('default =' `0`)::
|
||||||
|
|
||||||
|
Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.
|
||||||
|
|
||||||
`--comment` `<string>` ::
|
`--comment` `<string>` ::
|
||||||
|
|
||||||
no description available
|
no description available
|
||||||
|
|
||||||
`--delete` `<boolean>` ::
|
`--delete` `<boolean>` ('default =' `0`)::
|
||||||
|
|
||||||
Remove vms/storage (instead of adding it).
|
Remove the passed VMIDs and/or storage IDs instead of adding them.
|
||||||
|
|
||||||
`--storage` `<string>` ::
|
`--storage` `<string>` ::
|
||||||
|
|
||||||
List of storage IDs.
|
List of storage IDs to add or remove from this pool.
|
||||||
|
|
||||||
`--vms` `<string>` ::
|
`--vms` `<string>` ::
|
||||||
|
|
||||||
List of virtual machines.
|
List of guest VMIDs to add or remove from this pool.
|
||||||
|
|
||||||
*pveum realm add* `<realm> --type <string>` `[OPTIONS]`
|
*pveum realm add* `<realm> --type <string>` `[OPTIONS]`
|
||||||
|
|
||||||
@ -200,11 +204,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
|
|||||||
|
|
||||||
Automatically create users if they do not exist.
|
Automatically create users if they do not exist.
|
||||||
|
|
||||||
`--base_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
|
`--base_dn` `<string>` ::
|
||||||
|
|
||||||
LDAP base domain name
|
LDAP base domain name
|
||||||
|
|
||||||
`--bind_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
|
`--bind_dn` `<string>` ::
|
||||||
|
|
||||||
LDAP bind domain name
|
LDAP bind domain name
|
||||||
|
|
||||||
@ -224,6 +228,10 @@ Path to the client certificate
|
|||||||
|
|
||||||
Path to the client certificate key
|
Path to the client certificate key
|
||||||
|
|
||||||
|
`--check-connection` `<boolean>` ('default =' `0`)::
|
||||||
|
|
||||||
|
Check bind connection to the server.
|
||||||
|
|
||||||
`--client-id` `<string>` ::
|
`--client-id` `<string>` ::
|
||||||
|
|
||||||
OpenID Client ID
|
OpenID Client ID
|
||||||
@ -252,7 +260,7 @@ LDAP filter for user sync.
|
|||||||
|
|
||||||
The objectclasses for groups.
|
The objectclasses for groups.
|
||||||
|
|
||||||
`--group_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
|
`--group_dn` `<string>` ::
|
||||||
|
|
||||||
LDAP base domain name for group sync. If not set, the base_dn will be used.
|
LDAP base domain name for group sync. If not set, the base_dn will be used.
|
||||||
|
|
||||||
@ -364,11 +372,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
|
|||||||
|
|
||||||
Automatically create users if they do not exist.
|
Automatically create users if they do not exist.
|
||||||
|
|
||||||
`--base_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
|
`--base_dn` `<string>` ::
|
||||||
|
|
||||||
LDAP base domain name
|
LDAP base domain name
|
||||||
|
|
||||||
`--bind_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
|
`--bind_dn` `<string>` ::
|
||||||
|
|
||||||
LDAP bind domain name
|
LDAP bind domain name
|
||||||
|
|
||||||
@ -388,6 +396,10 @@ Path to the client certificate
|
|||||||
|
|
||||||
Path to the client certificate key
|
Path to the client certificate key
|
||||||
|
|
||||||
|
`--check-connection` `<boolean>` ('default =' `0`)::
|
||||||
|
|
||||||
|
Check bind connection to the server.
|
||||||
|
|
||||||
`--client-id` `<string>` ::
|
`--client-id` `<string>` ::
|
||||||
|
|
||||||
OpenID Client ID
|
OpenID Client ID
|
||||||
@ -410,7 +422,7 @@ A list of settings you want to delete.
|
|||||||
|
|
||||||
`--digest` `<string>` ::
|
`--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 a different digest. This can be used to prevent concurrent modifications.
|
||||||
|
|
||||||
`--domain` `\S+` ::
|
`--domain` `\S+` ::
|
||||||
|
|
||||||
@ -424,7 +436,7 @@ LDAP filter for user sync.
|
|||||||
|
|
||||||
The objectclasses for groups.
|
The objectclasses for groups.
|
||||||
|
|
||||||
`--group_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
|
`--group_dn` `<string>` ::
|
||||||
|
|
||||||
LDAP base domain name for group sync. If not set, the base_dn will be used.
|
LDAP base domain name for group sync. If not set, the base_dn will be used.
|
||||||
|
|
||||||
|
@ -42,11 +42,11 @@ Maximal time to wait for the global lock (minutes).
|
|||||||
|
|
||||||
`--mailnotification` `<always | failure>` ('default =' `always`)::
|
`--mailnotification` `<always | failure>` ('default =' `always`)::
|
||||||
|
|
||||||
Specify when to send an email
|
Deprecated: use 'notification-policy' instead.
|
||||||
|
|
||||||
`--mailto` `<string>` ::
|
`--mailto` `<string>` ::
|
||||||
|
|
||||||
Comma-separated list of email addresses or users that should receive email notifications.
|
Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.
|
||||||
|
|
||||||
`--maxfiles` `<integer> (1 - N)` ::
|
`--maxfiles` `<integer> (1 - N)` ::
|
||||||
|
|
||||||
@ -66,7 +66,15 @@ Template string for generating notes for the backup(s). It can contain variables
|
|||||||
+
|
+
|
||||||
NOTE: Requires option(s): `storage`
|
NOTE: Requires option(s): `storage`
|
||||||
|
|
||||||
`--performance` `[max-workers=<integer>]` ::
|
`--notification-policy` `<always | failure | never>` ('default =' `always`)::
|
||||||
|
|
||||||
|
Specify when to send a notification
|
||||||
|
|
||||||
|
`--notification-target` `<string>` ::
|
||||||
|
|
||||||
|
Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.
|
||||||
|
|
||||||
|
`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
|
||||||
|
|
||||||
Other performance-related settings.
|
Other performance-related settings.
|
||||||
|
|
||||||
|
@ -24,11 +24,11 @@ Maximal time to wait for the global lock (minutes).
|
|||||||
|
|
||||||
`mailnotification`: `<always | failure>` ('default =' `always`)::
|
`mailnotification`: `<always | failure>` ('default =' `always`)::
|
||||||
|
|
||||||
Specify when to send an email
|
Deprecated: use 'notification-policy' instead.
|
||||||
|
|
||||||
`mailto`: `<string>` ::
|
`mailto`: `<string>` ::
|
||||||
|
|
||||||
Comma-separated list of email addresses or users that should receive email notifications.
|
Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.
|
||||||
|
|
||||||
`maxfiles`: `<integer> (1 - N)` ::
|
`maxfiles`: `<integer> (1 - N)` ::
|
||||||
|
|
||||||
@ -44,7 +44,15 @@ Template string for generating notes for the backup(s). It can contain variables
|
|||||||
+
|
+
|
||||||
NOTE: Requires option(s): `storage`
|
NOTE: Requires option(s): `storage`
|
||||||
|
|
||||||
`performance`: `[max-workers=<integer>]` ::
|
`notification-policy`: `<always | failure | never>` ('default =' `always`)::
|
||||||
|
|
||||||
|
Specify when to send a notification
|
||||||
|
|
||||||
|
`notification-target`: `<string>` ::
|
||||||
|
|
||||||
|
Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.
|
||||||
|
|
||||||
|
`performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
|
||||||
|
|
||||||
Other performance-related settings.
|
Other performance-related settings.
|
||||||
|
|
||||||
@ -52,6 +60,10 @@ Other performance-related settings.
|
|||||||
|
|
||||||
Applies to VMs. Allow up to this many IO workers at the same time.
|
Applies to VMs. Allow up to this many IO workers at the same time.
|
||||||
|
|
||||||
|
`pbs-entries-max`=`<integer> (1 - N)` ('default =' `1048576`);;
|
||||||
|
|
||||||
|
Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files.
|
||||||
|
|
||||||
`pigz`: `<integer>` ('default =' `0`)::
|
`pigz`: `<integer>` ('default =' `0`)::
|
||||||
|
|
||||||
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
|
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
|
||||||
|
Loading…
Reference in New Issue
Block a user