Get-PveClusterHaRules
Get HA rules.
API: GET /cluster/ha/rules, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveClusterHaRules [-PveTicket <PveTicket>] [-Resource <string>] [-Type <string>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Resource |
string |
No | Limit the returned list to rules affecting the specified resource. |
-Type |
string |
No | Limit the returned list to the specified rule type. Values: node-affinity, resource-affinity. |
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
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
