1. Packages
  2. Nutanix
  3. API Docs
  4. getNdbClusters
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

nutanix.getNdbClusters

Explore with Pulumi AI

nutanix logo
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    List all clusters in Nutanix Database Service

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pulumi/nutanix";
    
    const clusters = nutanix.getNdbClusters({});
    export const clustersOp = clusters;
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    clusters = nutanix.get_ndb_clusters()
    pulumi.export("clustersOp", clusters)
    
    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 {
    		clusters, err := nutanix.GetNdbClusters(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("clustersOp", clusters)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var clusters = Nutanix.GetNdbClusters.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["clustersOp"] = clusters,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NutanixFunctions;
    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 clusters = NutanixFunctions.getNdbClusters();
    
            ctx.export("clustersOp", clusters.applyValue(getNdbClustersResult -> getNdbClustersResult));
        }
    }
    
    variables:
      clusters:
        fn::invoke:
          Function: nutanix:getNdbClusters
          Arguments: {}
    outputs:
      clustersOp: ${clusters}
    

    clusters

    The following attributes are exported for each cluster:

    • id: - id of cluster
    • name: - name of cluster
    • unique_name: - unique name of cluster
    • ip_addresses: - IP address
    • fqdns: - fqdn
    • nx_cluster_uuid: - nutanix cluster uuid
    • description: - description
    • cloud_type: - cloud type
    • date_created: - creation date
    • date_modified: - date modified
    • version: - version
    • owner_id: - owner UUID
    • status: - current status
    • hypervisor_type: - hypervisor type
    • hypervisor_version: - hypervisor version
    • properties: - list of properties
    • reference_count: - NA
    • username: - username
    • password: - password
    • cloud_info: - cloud info
    • resource_config: - resource related consumption info
    • management_server_info: - NA
    • entity_counts: - no. of entities related
    • healthy: - if healthy status

    See detailed information in NDB Clusters.

    Using getNdbClusters

    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 getNdbClusters(opts?: InvokeOptions): Promise<GetNdbClustersResult>
    function getNdbClustersOutput(opts?: InvokeOptions): Output<GetNdbClustersResult>
    def get_ndb_clusters(opts: Optional[InvokeOptions] = None) -> GetNdbClustersResult
    def get_ndb_clusters_output(opts: Optional[InvokeOptions] = None) -> Output[GetNdbClustersResult]
    func GetNdbClusters(ctx *Context, opts ...InvokeOption) (*GetNdbClustersResult, error)
    func GetNdbClustersOutput(ctx *Context, opts ...InvokeOption) GetNdbClustersResultOutput

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

    public static class GetNdbClusters 
    {
        public static Task<GetNdbClustersResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetNdbClustersResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNdbClustersResult> getNdbClusters(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nutanix:index/getNdbClusters:getNdbClusters
      arguments:
        # arguments dictionary

    getNdbClusters Result

    The following output properties are available:

    Clusters List<PiersKarsenbarg.Nutanix.Outputs.GetNdbClustersCluster>
    list of clusters
    Id string
    The provider-assigned unique ID for this managed resource.
    Clusters []GetNdbClustersCluster
    list of clusters
    Id string
    The provider-assigned unique ID for this managed resource.
    clusters List<GetNdbClustersCluster>
    list of clusters
    id String
    The provider-assigned unique ID for this managed resource.
    clusters GetNdbClustersCluster[]
    list of clusters
    id string
    The provider-assigned unique ID for this managed resource.
    clusters Sequence[GetNdbClustersCluster]
    list of clusters
    id str
    The provider-assigned unique ID for this managed resource.
    clusters List<Property Map>
    list of clusters
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetNdbClustersCluster

    GetNdbClustersClusterEntityCount

    GetNdbClustersClusterEntityCountEngineCount

    GetNdbClustersClusterEntityCountEngineCountMariadbDatabase

    GetNdbClustersClusterEntityCountEngineCountMariadbDatabaseProfile

    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

    GetNdbClustersClusterEntityCountEngineCountMongodbDatabase

    GetNdbClustersClusterEntityCountEngineCountMongodbDatabaseProfile

    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

    GetNdbClustersClusterEntityCountEngineCountMysqlDatabase

    GetNdbClustersClusterEntityCountEngineCountMysqlDatabaseProfile

    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

    GetNdbClustersClusterEntityCountEngineCountOracleDatabase

    GetNdbClustersClusterEntityCountEngineCountOracleDatabaseProfile

    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

    GetNdbClustersClusterEntityCountEngineCountPostgresDatabase

    GetNdbClustersClusterEntityCountEngineCountPostgresDatabaseProfile

    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

    GetNdbClustersClusterEntityCountEngineCountSaphanaDatabase

    GetNdbClustersClusterEntityCountEngineCountSaphanaDatabaseProfile

    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

    GetNdbClustersClusterEntityCountEngineCountSqlserverDatabase

    GetNdbClustersClusterEntityCountEngineCountSqlserverDatabaseProfile

    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

    GetNdbClustersClusterProperty

    Description string
    Name string
    RefId string
    Secure bool
    Value string
    Description string
    Name string
    RefId string
    Secure bool
    Value string
    description String
    name String
    refId String
    secure Boolean
    value String
    description string
    name string
    refId string
    secure boolean
    value string
    description String
    name String
    refId String
    secure Boolean
    value String

    GetNdbClustersClusterResourceConfig

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg