Skip to content

Set-PveClusterHaGroups

Update ha group configuration. (deprecated in favor of HA rules)

API: PUT /cluster/ha/groups/{group}, Proxmox VE API viewer

Set-PveClusterHaGroups
[-PveTicket <PveTicket>]
[-Comment <string>]
[-Delete <string>]
[-Digest <string>]
-Group <string>
[-Nodes <string>]
[-Nofailback <bool>]
[-Restricted <bool>]
[<CommonParameters>]
Parameter Type Required Description
-PveTicket PveTicket No Ticket data connection.
-Comment string No Description.
-Delete string No A list of settings you want to delete.
-Digest string No Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
-Group string Yes The HA group identifier.
-Nodes string No List of cluster node names with optional priority.
-Nofailback bool No The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
-Restricted bool No Resources bound to restricted groups may only run on nodes defined by the group.

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.

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