New-PveClusterHaGroups

Create a new HA group. (deprecated in favor of HA rules)

API: POST /cluster/ha/groups, Proxmox VE API viewer

Syntax

New-PveClusterHaGroups
    [-PveTicket <PveTicket>]
    [-Comment <string>]
    -Group <string>
    -Nodes <string>
    [-Nofailback <bool>]
    [-Restricted <bool>]
    [-Type <string>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Comment	string	No	Description.
-Group	string	Yes	The HA group identifier.
-Nodes	string	Yes	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.
-Type	string	No	Group type. Values: 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.

Output

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