1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. HA
  5. getHAGroups
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves the list of High Availability groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const example = proxmoxve.HA.getHAGroups({});
    export const dataProxmoxVirtualEnvironmentHagroups = example.then(example => example.groupIds);
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    example = proxmoxve.HA.get_ha_groups()
    pulumi.export("dataProxmoxVirtualEnvironmentHagroups", example.group_ids)
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve/ha"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := ha.GetHAGroups(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dataProxmoxVirtualEnvironmentHagroups", example.GroupIds)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var example = ProxmoxVE.HA.GetHAGroups.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["dataProxmoxVirtualEnvironmentHagroups"] = example.Apply(getHAGroupsResult => getHAGroupsResult.GroupIds),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.HA.HAFunctions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = HAFunctions.getHAGroups(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
            ctx.export("dataProxmoxVirtualEnvironmentHagroups", example.groupIds());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: proxmoxve:HA:getHAGroups
          arguments: {}
    outputs:
      dataProxmoxVirtualEnvironmentHagroups: ${example.groupIds}
    

    Using getHAGroups

    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 getHAGroups(opts?: InvokeOptions): Promise<GetHAGroupsResult>
    function getHAGroupsOutput(opts?: InvokeOptions): Output<GetHAGroupsResult>
    def get_ha_groups(opts: Optional[InvokeOptions] = None) -> GetHAGroupsResult
    def get_ha_groups_output(opts: Optional[InvokeOptions] = None) -> Output[GetHAGroupsResult]
    func GetHAGroups(ctx *Context, opts ...InvokeOption) (*GetHAGroupsResult, error)
    func GetHAGroupsOutput(ctx *Context, opts ...InvokeOption) GetHAGroupsResultOutput

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

    public static class GetHAGroups 
    {
        public static Task<GetHAGroupsResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetHAGroupsResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHAGroupsResult> getHAGroups(InvokeOptions options)
    public static Output<GetHAGroupsResult> getHAGroups(InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:HA/getHAGroups:getHAGroups
      arguments:
        # arguments dictionary

    getHAGroups Result

    The following output properties are available:

    GroupIds List<string>
    The identifiers of the High Availability groups.
    Id string
    The unique identifier of this resource.
    GroupIds []string
    The identifiers of the High Availability groups.
    Id string
    The unique identifier of this resource.
    groupIds List<String>
    The identifiers of the High Availability groups.
    id String
    The unique identifier of this resource.
    groupIds string[]
    The identifiers of the High Availability groups.
    id string
    The unique identifier of this resource.
    group_ids Sequence[str]
    The identifiers of the High Availability groups.
    id str
    The unique identifier of this resource.
    groupIds List<String>
    The identifiers of the High Availability groups.
    id String
    The unique identifier of this resource.

    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) v7.13.0
    published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.