Set-PveClusterOptions

Set datacenter options.

API: PUT /cluster/options, Proxmox VE API viewer

Syntax

Set-PveClusterOptions
    [-PveTicket <PveTicket>]
    [-Bwlimit <string>]
    [-ConsentText <string>]
    [-Console <string>]
    [-Crs <string>]
    [-Delete <string>]
    [-Description <string>]
    [-EmailFrom <string>]
    [-Fencing <string>]
    [-Ha <string>]
    [-HttpProxy <string>]
    [-Keyboard <string>]
    [-Language <string>]
    [-Location <string>]
    [-MacPrefix <string>]
    [-MaxWorkers <int>]
    [-Migration <string>]
    [-MigrationUnsecure <bool>]
    [-NextId <string>]
    [-Notify <string>]
    [-RegisteredTags <string>]
    [-Replication <string>]
    [-TagStyle <string>]
    [-U2f <string>]
    [-UserTagAccess <string>]
    [-Webauthn <string>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Bwlimit	string	No	Set I/O bandwidth limit for various operations (in KiB/s).
-ConsentText	string	No	Consent text that is displayed before logging in.
-Console	string	No	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. Values: applet, vv, html5, xtermjs.
-Crs	string	No	Cluster resource scheduling settings.
-Delete	string	No	A list of settings you want to delete.
-Description	string	No	Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.
-EmailFrom	string	No	Specify email address to send notification from (default is root@$hostname)
-Fencing	string	No	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. WARNING: ‘hardware’ and ‘both’ are EXPERIMENTAL & WIP. Values: watchdog, hardware, both.
-Ha	string	No	Cluster wide HA settings.
-HttpProxy	string	No	Specify external http proxy which is used for downloads (example: ‘http://username:password@host:port/’)
-Keyboard	string	No	Default keybord layout for vnc server. Values: de, de-ch, da, 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, sv, sl, tr.
-Language	string	No	Default GUI language. Values: ar, ca, da, de, en, es, eu, fa, fr, hr, he, it, ja, ka, kr, nb, nl, nn, pl, pt_BR, ru, sl, sv, tr, ukr, zh_CN, zh_TW.
-Location	string	No	The location of the cluster.
-MacPrefix	string	No	Prefix for the auto-generated MAC addresses of virtual guests. The default ‘BC:24:11’ is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You’re allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT).
-MaxWorkers	int	No	Defines how many workers (per node) are maximal started on actions like ‘stopall VMs’ or task from the ha-manager.
-Migration	string	No	For cluster wide migration settings.
-MigrationUnsecure	bool	No	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!
-NextId	string	No	Control the range for the free VMID auto-selection pool.
-Notify	string	No	Cluster-wide notification settings.
-RegisteredTags	string	No	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.
-Replication	string	No	For cluster wide replication settings.
-TagStyle	string	No	Tag style options.
-U2f	string	No	u2f.
-UserTagAccess	string	No	Privilege options for user-settable tags.
-Webauthn	string	No	webauthn configuration.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.