Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. HA
  5. getHAGroup
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

proxmoxve.HA.getHAGroup

Explore with Pulumi AI

Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve

Retrieves information about a specific High Availability group.

Example Usage

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

const all = proxmoxve.HA.getHAGroups({});
const example = all.then(all => .map(([__key, __value]) => (proxmoxve.HA.getHAGroup({
    group: __value,
}))));
export const proxmoxVirtualEnvironmentHagroupsFull = example;
Copy
import pulumi
import pulumi_proxmoxve as proxmoxve

all = proxmoxve.HA.get_ha_groups()
example = [proxmoxve.HA.get_ha_group(group=__value) for __key, __value in all.group_ids]
pulumi.export("proxmoxVirtualEnvironmentHagroupsFull", example)
Copy
package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/ha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		all, err := ha.GetHAGroups(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example := "TODO: For expression"
		ctx.Export("proxmoxVirtualEnvironmentHagroupsFull", example)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    var all = ProxmoxVE.HA.GetHAGroups.Invoke();

    var example = .Select(__value => 
    {
        return ProxmoxVE.HA.GetHAGroup.Invoke(new()
        {
            Group = __value,
        });
    }).ToList();

    return new Dictionary<string, object?>
    {
        ["proxmoxVirtualEnvironmentHagroupsFull"] = example,
    };
});
Copy
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 all = HAFunctions.getHAGroups();

        final var example = "TODO: ForExpression";

        ctx.export("proxmoxVirtualEnvironmentHagroupsFull", example);
    }
}
Copy
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>
Copy
def get_ha_group(group: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetHAGroupResult
def get_ha_group_output(group: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetHAGroupResult]
Copy
func GetHAGroup(ctx *Context, args *GetHAGroupArgs, opts ...InvokeOption) (*GetHAGroupResult, error)
func GetHAGroupOutput(ctx *Context, args *GetHAGroupOutputArgs, opts ...InvokeOption) GetHAGroupResultOutput
Copy

> Note: This function is named GetHAGroup 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)
}
Copy
public static CompletableFuture<GetHAGroupResult> getHAGroup(GetHAGroupArgs args, InvokeOptions options)
public static Output<GetHAGroupResult> getHAGroup(GetHAGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: proxmoxve:HA/getHAGroup:getHAGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Group This property is required. string
The identifier of the High Availability group to read.
Group This property is required. string
The identifier of the High Availability group to read.
group This property is required. String
The identifier of the High Availability group to read.
group This property is required. string
The identifier of the High Availability group to read.
group This property is required. str
The identifier of the High Availability group to read.
group This property is required. 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.
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.
Proxmox Virtual Environment (Proxmox VE) v7.0.0 published on Tuesday, Apr 1, 2025 by Daniel Muehlbachler-Pietrzykowski
muhlba91/pulumi-proxmoxve