1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. getHagroup
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.getHagroup

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Retrieves information about a specific High Availability group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";

// This will fetch the set of HA group identifiers...
const all = proxmoxve.getHagroups({});
// ...which we will go through in order to fetch the whole data on each group.
const example = all.then(all => .reduce((__obj, [__key, __value]) => ({ ...__obj, [__key]: proxmoxve.getHagroup({
    group: __value,
}) }), {}));
export const proxmoxHagroupsFull = example;

    import pulumi
import pulumi_proxmoxve as proxmoxve

# This will fetch the set of HA group identifiers...
all = proxmoxve.get_hagroups()
# ...which we will go through in order to fetch the whole data on each group.
example = {__key: proxmoxve.get_hagroup(group=__value) for __key, __value in enumerate(all.group_ids)}
pulumi.export("proxmoxHagroupsFull", example)

    Example coming soon!

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    // This will fetch the set of HA group identifiers...
    var all = ProxmoxVE.Index.GetHagroups.Invoke();

    // ...which we will go through in order to fetch the whole data on each group.
    var example = ;

    return new Dictionary<string, object?>
    {
        ["proxmoxHagroupsFull"] = example,
    };
});

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Using getHagroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHagroup(args: GetHagroupArgs, opts?: InvokeOptions): Promise<GetHagroupResult>
function getHagroupOutput(args: GetHagroupOutputArgs, opts?: InvokeOptions): Output<GetHagroupResult>
    def get_hagroup(group: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetHagroupResult
def get_hagroup_output(group: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetHagroupResult]
    func LookupHagroup(ctx *Context, args *LookupHagroupArgs, opts ...InvokeOption) (*LookupHagroupResult, error)
func LookupHagroupOutput(ctx *Context, args *LookupHagroupOutputArgs, opts ...InvokeOption) LookupHagroupResultOutput

    > Note: This function is named LookupHagroup in the Go SDK.

    public static class GetHagroup 
{
    public static Task<GetHagroupResult> InvokeAsync(GetHagroupArgs args, InvokeOptions? opts = null)
    public static Output<GetHagroupResult> Invoke(GetHagroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHagroupResult> getHagroup(GetHagroupArgs args, InvokeOptions options)
public static Output<GetHagroupResult> getHagroup(GetHagroupArgs args, InvokeOptions options)

    fn::invoke:
  function: proxmoxve:index/getHagroup:getHagroup
  arguments:
    # arguments dictionary
    data "proxmoxve_gethagroup" "name" {
    # arguments
}

    The following arguments are supported:

    Group string
    The identifier of the High Availability group to read.
    Group string
    The identifier of the High Availability group to read.
    group string
    The identifier of the High Availability group to read.
    group String
    The identifier of the High Availability group to read.
    group string
    The identifier of the High Availability group to read.
    group str
    The identifier of the High Availability group to read.
    group String
    The identifier of the High Availability group to read.

    getHagroup Result

    The following output properties are available:

    Comment string
    The comment associated with this group
    Group string
    The identifier of the High Availability group to read.
    Id string
    The unique identifier of this resource.
    NoFailback bool
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    Nodes Dictionary<string, int>
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    Restricted bool
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.
    Comment string
    The comment associated with this group
    Group string
    The identifier of the High Availability group to read.
    Id string
    The unique identifier of this resource.
    NoFailback bool
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    Nodes map[string]int
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    Restricted bool
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.
    comment string
    The comment associated with this group
    group string
    The identifier of the High Availability group to read.
    id string
    The unique identifier of this resource.
    no_failback bool
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    nodes map(number)
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    restricted bool
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.
    comment String
    The comment associated with this group
    group String
    The identifier of the High Availability group to read.
    id String
    The unique identifier of this resource.
    noFailback Boolean
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    nodes Map<String,Integer>
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    restricted Boolean
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.
    comment string
    The comment associated with this group
    group string
    The identifier of the High Availability group to read.
    id string
    The unique identifier of this resource.
    noFailback boolean
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    nodes {[key: string]: number}
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    restricted boolean
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.
    comment str
    The comment associated with this group
    group str
    The identifier of the High Availability group to read.
    id str
    The unique identifier of this resource.
    no_failback bool
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    nodes Mapping[str, int]
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    restricted bool
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.
    comment String
    The comment associated with this group
    group String
    The identifier of the High Availability group to read.
    id String
    The unique identifier of this resource.
    noFailback Boolean
    A flag that indicates that failing back to a higher priority node is disabled for this HA group.
    nodes Map<Number>
    The member nodes for this group. They are provided as a map, where the keys are the node names and the values represent their priority: integers for known priorities or null for unset priorities.
    restricted Boolean
    A flag that indicates that other nodes may not be used to run resources associated to this HA group.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
    published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.