datacenter.cfg.5-opts.adoc

   1 `bwlimit`: `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
   2
   3 Set I/O bandwidth limit for various operations (in KiB/s).
   4
   5 `clone`=`<LIMIT>` ;;
   6
   7 bandwidth limit in KiB/s for cloning disks
   8
   9 `default`=`<LIMIT>` ;;
  10
  11 default bandwidth limit in KiB/s
  12
  13 `migration`=`<LIMIT>` ;;
  14
  15 bandwidth limit in KiB/s for migrating guests (including moving local disks)
  16
  17 `move`=`<LIMIT>` ;;
  18
  19 bandwidth limit in KiB/s for moving disks
  20
  21 `restore`=`<LIMIT>` ;;
  22
  23 bandwidth limit in KiB/s for restoring guests from backups
  24
  25 `console`: `<applet | html5 | vv | xtermjs>` ::
  26
  27 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.
  28
  29 `crs`: `[ha=<basic|static>] [,ha-rebalance-on-start=<1|0>]` ::
  30
  31 Cluster resource scheduling settings.
  32
  33 `ha`=`<basic | static>` ('default =' `basic`);;
  34
  35 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.
  36
  37 `ha-rebalance-on-start`=`<boolean>` ('default =' `0`);;
  38
  39 Set to use CRS for selecting a suited node when a HA services request-state changes from stop to start.
  40
  41 `description`: `<string>` ::
  42
  43 Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
  44
  45 `email_from`: `<string>` ::
  46
  47 Specify email address to send notification from (default is root@$hostname)
  48
  49 `fencing`: `<both | hardware | watchdog>` ('default =' `watchdog`)::
  50
  51 Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.
  52 +
  53 WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
  54
  55 `ha`: `shutdown_policy=<enum>` ::
  56
  57 Cluster wide HA settings.
  58
  59 `shutdown_policy`=`<conditional | failover | freeze | migrate>` ('default =' `conditional`);;
  60
  61 Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes. Migrate will try to move all running services to another node when a reboot or shutdown was triggered. The poweroff process will only continue once no running services are located on the node anymore. If the node comes up again, the service will be moved back to the previously powered-off node, at least if no other migration, reloaction or recovery took place.
  62
  63 `http_proxy`: `http://.*` ::
  64
  65 Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
  66
  67 `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>` ::
  68
  69 Default keybord layout for vnc server.
  70
  71 `language`: `<ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW>` ::
  72
  73 Default GUI language.
  74
  75 `mac_prefix`: `<string>` ::
  76
  77 Prefix for autogenerated MAC addresses.
  78
  79 `max_workers`: `<integer> (1 - N)` ::
  80
  81 Defines how many workers (per node) are maximal started  on actions like 'stopall VMs' or task from the ha-manager.
  82
  83 `migration`: `[type=]<secure|insecure> [,network=<CIDR>]` ::
  84
  85 For cluster wide migration settings.
  86
  87 `network`=`<CIDR>` ;;
  88
  89 CIDR of the (sub) network that is used for migration.
  90
  91 `type`=`<insecure | secure>` ('default =' `secure`);;
  92
  93 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
  94
  95 `migration_unsecure`: `<boolean>` ::
  96
  97 Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!
  98
  99 `next-id`: `[lower=<integer>] [,upper=<integer>]` ::
 100
 101 Control the range for the free VMID auto-selection pool.
 102
 103 `lower`=`<integer>` ('default =' `100`);;
 104
 105 Lower, inclusive boundary for free next-id API range.
 106
 107 `upper`=`<integer>` ('default =' `1000000`);;
 108
 109 Upper, exclusive boundary for free next-id API range.
 110
 111 `notify`: `[fencing=<always|never>] [,package-updates=<auto|always|never>] [,replication=<always|never>] [,target-fencing=<TARGET>] [,target-package-updates=<TARGET>] [,target-replication=<TARGET>]` ::
 112
 113 Cluster-wide notification settings.
 114
 115 `fencing`=`<always | never>` ('default =' `always`);;
 116
 117 Control if notifications about node fencing should be sent.
 118 * 'always' always send out notifications
 119 * 'never' never send out notifications.
 120 For production systems, turning off node fencing notifications is notrecommended!
 121
 122 `package-updates`=`<always | auto | never>` ('default =' `auto`);;
 123
 124 Control how often the daily update job should send out notifications:
 125 * 'auto' daily for systems with a valid subscription, as those are assumed to be  production-ready and thus should know about pending updates.
 126 * 'always' every update, if there are new pending updates.
 127 * 'never' never send a notification for new pending updates.
 128
 129 `replication`=`<always | never>` ('default =' `always`);;
 130
 131 Control if notifications for replication failures should be sent.
 132 * 'always' always send out notifications
 133 * 'never' never send out notifications.
 134 For production systems, turning off replication notifications is notrecommended!
 135
 136 `target-fencing`=`<TARGET>` ;;
 137
 138 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.
 139
 140 `target-package-updates`=`<TARGET>` ;;
 141
 142 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.
 143
 144 `target-replication`=`<TARGET>` ;;
 145
 146 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.
 147
 148 `registered-tags`: `<tag>[;<tag>...]` ::
 149
 150 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
 152 `tag-style`: `[case-sensitive=<1|0>] [,color-map=<tag>:<hex-color>[:<hex-color-for-text>][;<tag>=...]] [,ordering=<config|alphabetical>] [,shape=<enum>]` ::
 153
 154 Tag style options.
 155
 156 `case-sensitive`=`<boolean>` ('default =' `0`);;
 157
 158 Controls if filtering for unique tags on update should check case-sensitive.
 159
 160 `color-map`=`<tag>:<hex-color>[:<hex-color-for-text>][;<tag>=...]` ;;
 161
 162 Manual color mapping for tags (semicolon separated).
 163
 164 `ordering`=`<alphabetical | config>` ('default =' `alphabetical`);;
 165
 166 Controls the sorting of the tags in the web-interface and the API update.
 167
 168 `shape`=`<circle | dense | full | none>` ('default =' `circle`);;
 169
 170 Tag shape for the web ui tree. 'full' draws the full tag. 'circle' draws only a circle with the background color. 'dense' only draws a small rectancle (useful when many tags are assigned to each guest).'none' disables showing the tags.
 171
 172 `u2f`: `[appid=<APPID>] [,origin=<URL>]` ::
 173
 174 u2f
 175
 176 `appid`=`<APPID>` ;;
 177
 178 U2F AppId URL override. Defaults to the origin.
 179
 180 `origin`=`<URL>` ;;
 181
 182 U2F Origin override. Mostly useful for single nodes with a single URL.
 183
 184 `user-tag-access`: `[user-allow=<enum>] [,user-allow-list=<tag>[;<tag>...]]` ::
 185
 186 Privilege options for user-settable tags
 187
 188 `user-allow`=`<existing | free | list | none>` ('default =' `free`);;
 189
 190 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.
 191
 192 `user-allow-list`=`<tag>[;<tag>...]` ;;
 193
 194 List of tags users are allowed to set and delete (semicolon separated) for 'user-allow' values 'list' and 'existing'.
 195
 196 `webauthn`: `[allow-subdomains=<1|0>] [,id=<DOMAINNAME>] [,origin=<URL>] [,rp=<RELYING_PARTY>]` ::
 197
 198 webauthn configuration
 199
 200 `allow-subdomains`=`<boolean>` ('default =' `1`);;
 201
 202 Whether to allow the origin to be a subdomain, rather than the exact URL.
 203
 204 `id`=`<DOMAINNAME>` ;;
 205
 206 Relying party ID. Must be the domain name without protocol, port or location. Changing this *will* break existing credentials.
 207
 208 `origin`=`<URL>` ;;
 209
 210 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.
 211
 212 `rp`=`<RELYING_PARTY>` ;;
 213
 214 Relying party name. Any text identifier. Changing this *may* break existing credentials.
 215