1. Packages
  2. Nutanix
  3. API Docs
  4. getNdbCluster
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

nutanix.getNdbCluster

nutanix logo
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

    Describes a cluster in Nutanix Database Service

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";

const c1 = nutanix.getNdbCluster({
    clusterName: "<era-cluster-name>",
});
export const cluster = c1;

    import pulumi
import pulumi_nutanix as nutanix

c1 = nutanix.get_ndb_cluster(cluster_name="<era-cluster-name>")
pulumi.export("cluster", c1)

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		c1, err := nutanix.LookupNdbCluster(ctx, &nutanix.LookupNdbClusterArgs{
			ClusterName: pulumi.StringRef("<era-cluster-name>"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("cluster", c1)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var c1 = Nutanix.GetNdbCluster.Invoke(new()
    {
        ClusterName = "<era-cluster-name>",
    });

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

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetNdbClusterArgs;
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 c1 = NutanixFunctions.getNdbCluster(GetNdbClusterArgs.builder()
            .clusterName("<era-cluster-name>")
            .build());

        ctx.export("cluster", c1);
    }
}

    variables:
  c1:
    fn::invoke:
      function: nutanix:getNdbCluster
      arguments:
        clusterName: <era-cluster-name>
outputs:
  cluster: ${c1}

    Using getNdbCluster

    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 getNdbCluster(args: GetNdbClusterArgs, opts?: InvokeOptions): Promise<GetNdbClusterResult>
function getNdbClusterOutput(args: GetNdbClusterOutputArgs, opts?: InvokeOptions): Output<GetNdbClusterResult>
    def get_ndb_cluster(cluster_id: Optional[str] = None,
                    cluster_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNdbClusterResult
def get_ndb_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                    cluster_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNdbClusterResult]
    func LookupNdbCluster(ctx *Context, args *LookupNdbClusterArgs, opts ...InvokeOption) (*LookupNdbClusterResult, error)
func LookupNdbClusterOutput(ctx *Context, args *LookupNdbClusterOutputArgs, opts ...InvokeOption) LookupNdbClusterResultOutput

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

    public static class GetNdbCluster 
{
    public static Task<GetNdbClusterResult> InvokeAsync(GetNdbClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetNdbClusterResult> Invoke(GetNdbClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNdbClusterResult> getNdbCluster(GetNdbClusterArgs args, InvokeOptions options)
public static Output<GetNdbClusterResult> getNdbCluster(GetNdbClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getNdbCluster:getNdbCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    ID of cluster
    ClusterName string
    and cluster_id are mutually exclusive.
    ClusterId string
    ID of cluster
    ClusterName string
    and cluster_id are mutually exclusive.
    clusterId String
    ID of cluster
    clusterName String
    and cluster_id are mutually exclusive.
    clusterId string
    ID of cluster
    clusterName string
    and cluster_id are mutually exclusive.
    cluster_id str
    ID of cluster
    cluster_name str
    and cluster_id are mutually exclusive.
    clusterId String
    ID of cluster
    clusterName String
    and cluster_id are mutually exclusive.

    getNdbCluster Result

    The following output properties are available:

    CloudInfo string
    • cloud info
    CloudType string
    • cloud type
    DateCreated string
    • creation date
    DateModified string
    • date modified
    Description string
    • description
    EntityCounts List<PiersKarsenbarg.Nutanix.Outputs.GetNdbClusterEntityCount>
    • no. of entities related
    Fqdns string
    • fqdn
    Healthy bool
    • if healthy status
    HypervisorType string
    • hypervisor type
    HypervisorVersion string
    • hypervisor version
    Id string
    • id of cluster
    IpAddresses List<string>
    • IP address
    ManagementServerInfo string
    • NA
    Name string
    • name of cluster
    NxClusterUuid string
    • nutanix cluster uuid
    OwnerId string
    • owner UUID
    Password string
    • password
    Properties List<PiersKarsenbarg.Nutanix.Outputs.GetNdbClusterProperty>
    • list of properties
    ReferenceCount int
    • NA
    ResourceConfigs List<PiersKarsenbarg.Nutanix.Outputs.GetNdbClusterResourceConfig>
    • resource related consumption info
    Status string
    • current status
    UniqueName string
    • unique name of cluster
    Username string
    • username
    Version string
    • version
    ClusterId string
    ClusterName string
    CloudInfo string
    • cloud info
    CloudType string
    • cloud type
    DateCreated string
    • creation date
    DateModified string
    • date modified
    Description string
    • description
    EntityCounts []GetNdbClusterEntityCount
    • no. of entities related
    Fqdns string
    • fqdn
    Healthy bool
    • if healthy status
    HypervisorType string
    • hypervisor type
    HypervisorVersion string
    • hypervisor version
    Id string
    • id of cluster
    IpAddresses []string
    • IP address
    ManagementServerInfo string
    • NA
    Name string
    • name of cluster
    NxClusterUuid string
    • nutanix cluster uuid
    OwnerId string
    • owner UUID
    Password string
    • password
    Properties []GetNdbClusterProperty
    • list of properties
    ReferenceCount int
    • NA
    ResourceConfigs []GetNdbClusterResourceConfig
    • resource related consumption info
    Status string
    • current status
    UniqueName string
    • unique name of cluster
    Username string
    • username
    Version string
    • version
    ClusterId string
    ClusterName string
    cloudInfo String
    • cloud info
    cloudType String
    • cloud type
    dateCreated String
    • creation date
    dateModified String
    • date modified
    description String
    • description
    entityCounts List<GetNdbClusterEntityCount>
    • no. of entities related
    fqdns String
    • fqdn
    healthy Boolean
    • if healthy status
    hypervisorType String
    • hypervisor type
    hypervisorVersion String
    • hypervisor version
    id String
    • id of cluster
    ipAddresses List<String>
    • IP address
    managementServerInfo String
    • NA
    name String
    • name of cluster
    nxClusterUuid String
    • nutanix cluster uuid
    ownerId String
    • owner UUID
    password String
    • password
    properties List<GetNdbClusterProperty>
    • list of properties
    referenceCount Integer
    • NA
    resourceConfigs List<GetNdbClusterResourceConfig>
    • resource related consumption info
    status String
    • current status
    uniqueName String
    • unique name of cluster
    username String
    • username
    version String
    • version
    clusterId String
    clusterName String
    cloudInfo string
    • cloud info
    cloudType string
    • cloud type
    dateCreated string
    • creation date
    dateModified string
    • date modified
    description string
    • description
    entityCounts GetNdbClusterEntityCount[]
    • no. of entities related
    fqdns string
    • fqdn
    healthy boolean
    • if healthy status
    hypervisorType string
    • hypervisor type
    hypervisorVersion string
    • hypervisor version
    id string
    • id of cluster
    ipAddresses string[]
    • IP address
    managementServerInfo string
    • NA
    name string
    • name of cluster
    nxClusterUuid string
    • nutanix cluster uuid
    ownerId string
    • owner UUID
    password string
    • password
    properties GetNdbClusterProperty[]
    • list of properties
    referenceCount number
    • NA
    resourceConfigs GetNdbClusterResourceConfig[]
    • resource related consumption info
    status string
    • current status
    uniqueName string
    • unique name of cluster
    username string
    • username
    version string
    • version
    clusterId string
    clusterName string
    cloud_info str
    • cloud info
    cloud_type str
    • cloud type
    date_created str
    • creation date
    date_modified str
    • date modified
    description str
    • description
    entity_counts Sequence[GetNdbClusterEntityCount]
    • no. of entities related
    fqdns str
    • fqdn
    healthy bool
    • if healthy status
    hypervisor_type str
    • hypervisor type
    hypervisor_version str
    • hypervisor version
    id str
    • id of cluster
    ip_addresses Sequence[str]
    • IP address
    management_server_info str
    • NA
    name str
    • name of cluster
    nx_cluster_uuid str
    • nutanix cluster uuid
    owner_id str
    • owner UUID
    password str
    • password
    properties Sequence[GetNdbClusterProperty]
    • list of properties
    reference_count int
    • NA
    resource_configs Sequence[GetNdbClusterResourceConfig]
    • resource related consumption info
    status str
    • current status
    unique_name str
    • unique name of cluster
    username str
    • username
    version str
    • version
    cluster_id str
    cluster_name str
    cloudInfo String
    • cloud info
    cloudType String
    • cloud type
    dateCreated String
    • creation date
    dateModified String
    • date modified
    description String
    • description
    entityCounts List<Property Map>
    • no. of entities related
    fqdns String
    • fqdn
    healthy Boolean
    • if healthy status
    hypervisorType String
    • hypervisor type
    hypervisorVersion String
    • hypervisor version
    id String
    • id of cluster
    ipAddresses List<String>
    • IP address
    managementServerInfo String
    • NA
    name String
    • name of cluster
    nxClusterUuid String
    • nutanix cluster uuid
    ownerId String
    • owner UUID
    password String
    • password
    properties List<Property Map>
    • list of properties
    referenceCount Number
    • NA
    resourceConfigs List<Property Map>
    • resource related consumption info
    status String
    • current status
    uniqueName String
    • unique name of cluster
    username String
    • username
    version String
    • version
    clusterId String
    clusterName String

    Supporting Types

    GetNdbClusterEntityCount

    GetNdbClusterEntityCountEngineCount

    GetNdbClusterEntityCountEngineCountMariadbDatabase

    GetNdbClusterEntityCountEngineCountMariadbDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterEntityCountEngineCountMongodbDatabase

    GetNdbClusterEntityCountEngineCountMongodbDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterEntityCountEngineCountMysqlDatabase

    GetNdbClusterEntityCountEngineCountMysqlDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterEntityCountEngineCountOracleDatabase

    GetNdbClusterEntityCountEngineCountOracleDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterEntityCountEngineCountPostgresDatabase

    GetNdbClusterEntityCountEngineCountPostgresDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterEntityCountEngineCountSaphanaDatabase

    GetNdbClusterEntityCountEngineCountSaphanaDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterEntityCountEngineCountSqlserverDatabase

    GetNdbClusterEntityCountEngineCountSqlserverDatabaseProfile

    compute Integer
    databaseParameter Integer
    network Integer
    software Integer
    storage Integer
    windowsDomain Integer
    compute number
    databaseParameter number
    network number
    software number
    storage number
    windowsDomain number
    compute Number
    databaseParameter Number
    network Number
    software Number
    storage Number
    windowsDomain Number

    GetNdbClusterProperty

    Description string
    • description
    Name string
    • name of cluster
    RefId string
    Secure bool
    Value string
    Description string
    • description
    Name string
    • name of cluster
    RefId string
    Secure bool
    Value string
    description String
    • description
    name String
    • name of cluster
    refId String
    secure Boolean
    value String
    description string
    • description
    name string
    • name of cluster
    refId string
    secure boolean
    value string
    description str
    • description
    name str
    • name of cluster
    ref_id str
    secure bool
    value str
    description String
    • description
    name String
    • name of cluster
    refId String
    secure Boolean
    value String

    GetNdbClusterResourceConfig

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Viewing docs for Nutanix v0.11.0
    published on Monday, Nov 24, 2025 by Piers Karsenbarg
    Schema (JSON)
    pierskarsenbarg/pulumi-nutanix
      Try Pulumi Cloud free. Your team will thank you.