Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. vSphere
  5. getDatastoreCluster

getDatastoreCluster

The vsphere.DatastoreCluster data source can be used to discover the ID of a datastore cluster in vSphere. This is useful to fetch the ID of a datastore cluster that you want to use to assign datastores to using the vsphere.NasDatastore or vsphere.VmfsDatastore resources, or create virtual machines in using the vsphere.VirtualMachine resource.

Example Usage

using Pulumi;
using VSphere = Pulumi.VSphere;

class MyStack : Stack
{
    public MyStack()
    {
        var datacenter = Output.Create(VSphere.GetDatacenter.InvokeAsync(new VSphere.GetDatacenterArgs
        {
            Name = "dc1",
        }));
        var datastoreCluster = Output.Create(VSphere.GetDatastoreCluster.InvokeAsync(new VSphere.GetDatastoreClusterArgs
        {
            DatacenterId = data.Vsphere_datacenter.Dc.Id,
            Name = "datastore-cluster1",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-vsphere/sdk/v2/go/vsphere"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := "dc1"
        _, err := vsphere.LookupDatacenter(ctx, &vsphere.LookupDatacenterArgs{
            Name: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        opt1 := data.Vsphere_datacenter.Dc.Id
        _, err = vsphere.LookupDatastoreCluster(ctx, &vsphere.LookupDatastoreClusterArgs{
            DatacenterId: &opt1,
            Name:         "datastore-cluster1",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc1")
datastore_cluster = vsphere.get_datastore_cluster(datacenter_id=data["vsphere_datacenter"]["dc"]["id"],
    name="datastore-cluster1")
import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";

const datacenter = pulumi.output(vsphere.getDatacenter({
    name: "dc1",
}, { async: true }));
const datastoreCluster = vsphere_datacenter_dc.id.apply(id => vsphere.getDatastoreCluster({
    datacenterId: id,
    name: "datastore-cluster1",
}, { async: true }));

Using getDatastoreCluster

function getDatastoreCluster(args: GetDatastoreClusterArgs, opts?: InvokeOptions): Promise<GetDatastoreClusterResult>
def get_datastore_cluster(datacenter_id: Optional[str] = None, name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetDatastoreClusterResult
func LookupDatastoreCluster(ctx *Context, args *LookupDatastoreClusterArgs, opts ...InvokeOption) (*LookupDatastoreClusterResult, error)

Note: This function is named LookupDatastoreCluster in the Go SDK.

public static class GetDatastoreCluster {
    public static Task<GetDatastoreClusterResult> InvokeAsync(GetDatastoreClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name or absolute path to the datastore cluster.

DatacenterId string

The managed object reference ID of the datacenter the datastore cluster is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.

Name string

The name or absolute path to the datastore cluster.

DatacenterId string

The managed object reference ID of the datacenter the datastore cluster is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.

name string

The name or absolute path to the datastore cluster.

datacenterId string

The managed object reference ID of the datacenter the datastore cluster is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.

name str

The name or absolute path to the datastore cluster.

datacenter_id str

The managed object reference ID of the datacenter the datastore cluster is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.

getDatastoreCluster Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Name string
DatacenterId string
Id string

The provider-assigned unique ID for this managed resource.

Name string
DatacenterId string
id string

The provider-assigned unique ID for this managed resource.

name string
datacenterId string
id str

The provider-assigned unique ID for this managed resource.

name str
datacenter_id str

Package Details

Repository
https://github.com/pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.