OpenStack v5.3.3 published on Friday, Sep 12, 2025 by Pulumi
openstack.compute.getAggregateV2
Use this data source to get information about host aggregates by name.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";
const test = openstack.compute.getAggregateV2({
    name: "test",
});
import pulumi
import pulumi_openstack as openstack
test = openstack.compute.get_aggregate_v2(name="test")
package main
import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupAggregateV2(ctx, &compute.LookupAggregateV2Args{
			Name: "test",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;
return await Deployment.RunAsync(() => 
{
    var test = OpenStack.Compute.GetAggregateV2.Invoke(new()
    {
        Name = "test",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.compute.ComputeFunctions;
import com.pulumi.openstack.compute.inputs.GetAggregateV2Args;
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 test = ComputeFunctions.getAggregateV2(GetAggregateV2Args.builder()
            .name("test")
            .build());
    }
}
variables:
  test:
    fn::invoke:
      function: openstack:compute:getAggregateV2
      arguments:
        name: test
Using getAggregateV2
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 getAggregateV2(args: GetAggregateV2Args, opts?: InvokeOptions): Promise<GetAggregateV2Result>
function getAggregateV2Output(args: GetAggregateV2OutputArgs, opts?: InvokeOptions): Output<GetAggregateV2Result>def get_aggregate_v2(hosts: Optional[Sequence[str]] = None,
                     metadata: Optional[Mapping[str, str]] = None,
                     name: Optional[str] = None,
                     region: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAggregateV2Result
def get_aggregate_v2_output(hosts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     metadata: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     region: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAggregateV2Result]func LookupAggregateV2(ctx *Context, args *LookupAggregateV2Args, opts ...InvokeOption) (*LookupAggregateV2Result, error)
func LookupAggregateV2Output(ctx *Context, args *LookupAggregateV2OutputArgs, opts ...InvokeOption) LookupAggregateV2ResultOutput> Note: This function is named LookupAggregateV2 in the Go SDK.
public static class GetAggregateV2 
{
    public static Task<GetAggregateV2Result> InvokeAsync(GetAggregateV2Args args, InvokeOptions? opts = null)
    public static Output<GetAggregateV2Result> Invoke(GetAggregateV2InvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAggregateV2Result> getAggregateV2(GetAggregateV2Args args, InvokeOptions options)
public static Output<GetAggregateV2Result> getAggregateV2(GetAggregateV2Args args, InvokeOptions options)
fn::invoke:
  function: openstack:compute/getAggregateV2:getAggregateV2
  arguments:
    # arguments dictionaryThe following arguments are supported:
getAggregateV2 Result
The following output properties are available:
- Hosts List<string>
- List of Hypervisors contained in the Host Aggregate
- Id string
- The provider-assigned unique ID for this managed resource.
- Metadata Dictionary<string, string>
- Metadata of the Host Aggregate
- Name string
- See Argument Reference above.
- Region string
- See Argument Reference above.
- Zone string
- Availability zone of the Host Aggregate
- Hosts []string
- List of Hypervisors contained in the Host Aggregate
- Id string
- The provider-assigned unique ID for this managed resource.
- Metadata map[string]string
- Metadata of the Host Aggregate
- Name string
- See Argument Reference above.
- Region string
- See Argument Reference above.
- Zone string
- Availability zone of the Host Aggregate
- hosts List<String>
- List of Hypervisors contained in the Host Aggregate
- id String
- The provider-assigned unique ID for this managed resource.
- metadata Map<String,String>
- Metadata of the Host Aggregate
- name String
- See Argument Reference above.
- region String
- See Argument Reference above.
- zone String
- Availability zone of the Host Aggregate
- hosts string[]
- List of Hypervisors contained in the Host Aggregate
- id string
- The provider-assigned unique ID for this managed resource.
- metadata {[key: string]: string}
- Metadata of the Host Aggregate
- name string
- See Argument Reference above.
- region string
- See Argument Reference above.
- zone string
- Availability zone of the Host Aggregate
- hosts Sequence[str]
- List of Hypervisors contained in the Host Aggregate
- id str
- The provider-assigned unique ID for this managed resource.
- metadata Mapping[str, str]
- Metadata of the Host Aggregate
- name str
- See Argument Reference above.
- region str
- See Argument Reference above.
- zone str
- Availability zone of the Host Aggregate
- hosts List<String>
- List of Hypervisors contained in the Host Aggregate
- id String
- The provider-assigned unique ID for this managed resource.
- metadata Map<String>
- Metadata of the Host Aggregate
- name String
- See Argument Reference above.
- region String
- See Argument Reference above.
- zone String
- Availability zone of the Host Aggregate
Package Details
- Repository
- OpenStack pulumi/pulumi-openstack
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the openstackTerraform Provider.
