Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
nutanix.getNdbCluster
Explore with Pulumi AI
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg
Describes a cluster in Nutanix Database Service
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pulumi/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.applyValue(getNdbClusterResult -> getNdbClusterResult));
    }
}
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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: nutanix:index/getNdbCluster:getNdbCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Cluster
Id string - ID of cluster
 - Cluster
Name string - and 
cluster_idare mutually exclusive. 
- Cluster
Id string - ID of cluster
 - Cluster
Name string - and 
cluster_idare mutually exclusive. 
- cluster
Id String - ID of cluster
 - cluster
Name String - and 
cluster_idare mutually exclusive. 
- cluster
Id string - ID of cluster
 - cluster
Name string - and 
cluster_idare mutually exclusive. 
- cluster_
id str - ID of cluster
 - cluster_
name str - and 
cluster_idare mutually exclusive. 
- cluster
Id String - ID of cluster
 - cluster
Name String - and 
cluster_idare mutually exclusive. 
getNdbCluster Result
The following output properties are available:
- Cloud
Info string - cloud info
 
- Cloud
Type string - cloud type
 
- Date
Created string - creation date
 
- Date
Modified string - date modified
 
- Description string
 - description
 
- Entity
Counts List<PiersKarsenbarg. Nutanix. Outputs. Get Ndb Cluster Entity Count>  - no. of entities related
 
- Fqdns string
 - fqdn
 
- Healthy bool
 - if healthy status
 
- Hypervisor
Type string - hypervisor type
 
- Hypervisor
Version string - hypervisor version
 
- Id string
 - id of cluster
 
- Ip
Addresses List<string> - IP address
 
- Management
Server stringInfo  - NA
 
- Name string
 - name of cluster
 
- Nx
Cluster stringUuid  - nutanix cluster uuid
 
- Owner
Id string - owner UUID
 
- Password string
 - password
 
- Properties
List<Piers
Karsenbarg. Nutanix. Outputs. Get Ndb Cluster Property>  - list of properties
 
- Reference
Count int - NA
 
- Resource
Configs List<PiersKarsenbarg. Nutanix. Outputs. Get Ndb Cluster Resource Config>  - resource related consumption info
 
- Status string
 - current status
 
- Unique
Name string - unique name of cluster
 
- Username string
 - username
 
- Version string
 - version
 
- Cluster
Id string - Cluster
Name string 
- Cloud
Info string - cloud info
 
- Cloud
Type string - cloud type
 
- Date
Created string - creation date
 
- Date
Modified string - date modified
 
- Description string
 - description
 
- Entity
Counts []GetNdb Cluster Entity Count  - no. of entities related
 
- Fqdns string
 - fqdn
 
- Healthy bool
 - if healthy status
 
- Hypervisor
Type string - hypervisor type
 
- Hypervisor
Version string - hypervisor version
 
- Id string
 - id of cluster
 
- Ip
Addresses []string - IP address
 
- Management
Server stringInfo  - NA
 
- Name string
 - name of cluster
 
- Nx
Cluster stringUuid  - nutanix cluster uuid
 
- Owner
Id string - owner UUID
 
- Password string
 - password
 
- Properties
[]Get
Ndb Cluster Property  - list of properties
 
- Reference
Count int - NA
 
- Resource
Configs []GetNdb Cluster Resource Config  - resource related consumption info
 
- Status string
 - current status
 
- Unique
Name string - unique name of cluster
 
- Username string
 - username
 
- Version string
 - version
 
- Cluster
Id string - Cluster
Name string 
- cloud
Info String - cloud info
 
- cloud
Type String - cloud type
 
- date
Created String - creation date
 
- date
Modified String - date modified
 
- description String
 - description
 
- entity
Counts List<GetNdb Cluster Entity Count>  - no. of entities related
 
- fqdns String
 - fqdn
 
- healthy Boolean
 - if healthy status
 
- hypervisor
Type String - hypervisor type
 
- hypervisor
Version String - hypervisor version
 
- id String
 - id of cluster
 
- ip
Addresses List<String> - IP address
 
- management
Server StringInfo  - NA
 
- name String
 - name of cluster
 
- nx
Cluster StringUuid  - nutanix cluster uuid
 
- owner
Id String - owner UUID
 
- password String
 - password
 
- properties
List<Get
Ndb Cluster Property>  - list of properties
 
- reference
Count Integer - NA
 
- resource
Configs List<GetNdb Cluster Resource Config>  - resource related consumption info
 
- status String
 - current status
 
- unique
Name String - unique name of cluster
 
- username String
 - username
 
- version String
 - version
 
- cluster
Id String - cluster
Name String 
- cloud
Info string - cloud info
 
- cloud
Type string - cloud type
 
- date
Created string - creation date
 
- date
Modified string - date modified
 
- description string
 - description
 
- entity
Counts GetNdb Cluster Entity Count[]  - no. of entities related
 
- fqdns string
 - fqdn
 
- healthy boolean
 - if healthy status
 
- hypervisor
Type string - hypervisor type
 
- hypervisor
Version string - hypervisor version
 
- id string
 - id of cluster
 
- ip
Addresses string[] - IP address
 
- management
Server stringInfo  - NA
 
- name string
 - name of cluster
 
- nx
Cluster stringUuid  - nutanix cluster uuid
 
- owner
Id string - owner UUID
 
- password string
 - password
 
- properties
Get
Ndb Cluster Property[]  - list of properties
 
- reference
Count number - NA
 
- resource
Configs GetNdb Cluster Resource Config[]  - resource related consumption info
 
- status string
 - current status
 
- unique
Name string - unique name of cluster
 
- username string
 - username
 
- version string
 - version
 
- cluster
Id string - cluster
Name 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[GetNdb Cluster Entity Count]  - 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_ strinfo  - NA
 
- name str
 - name of cluster
 
- nx_
cluster_ struuid  - nutanix cluster uuid
 
- owner_
id str - owner UUID
 
- password str
 - password
 
- properties
Sequence[Get
Ndb Cluster Property]  - list of properties
 
- reference_
count int - NA
 
- resource_
configs Sequence[GetNdb Cluster Resource Config]  - 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 
- cloud
Info String - cloud info
 
- cloud
Type String - cloud type
 
- date
Created String - creation date
 
- date
Modified String - date modified
 
- description String
 - description
 
- entity
Counts List<Property Map> - no. of entities related
 
- fqdns String
 - fqdn
 
- healthy Boolean
 - if healthy status
 
- hypervisor
Type String - hypervisor type
 
- hypervisor
Version String - hypervisor version
 
- id String
 - id of cluster
 
- ip
Addresses List<String> - IP address
 
- management
Server StringInfo  - NA
 
- name String
 - name of cluster
 
- nx
Cluster StringUuid  - nutanix cluster uuid
 
- owner
Id String - owner UUID
 
- password String
 - password
 
- properties List<Property Map>
 - list of properties
 
- reference
Count Number - NA
 
- resource
Configs List<Property Map> - resource related consumption info
 
- status String
 - current status
 
- unique
Name String - unique name of cluster
 
- username String
 - username
 
- version String
 - version
 
- cluster
Id String - cluster
Name String 
Supporting Types
GetNdbClusterEntityCount    
GetNdbClusterEntityCountEngineCount      
- Mariadb
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Mariadb Database>  - Mongodb
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Mongodb Database>  - Mysql
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Mysql Database>  - Oracle
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Oracle Database>  - Postgres
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Postgres Database>  - Saphana
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Saphana Database>  - Sqlserver
Databases List<PiersKarsenbarg. Nutanix. Inputs. Get Ndb Cluster Entity Count Engine Count Sqlserver Database>  
- Mariadb
Databases []GetNdb Cluster Entity Count Engine Count Mariadb Database  - Mongodb
Databases []GetNdb Cluster Entity Count Engine Count Mongodb Database  - Mysql
Databases []GetNdb Cluster Entity Count Engine Count Mysql Database  - Oracle
Databases []GetNdb Cluster Entity Count Engine Count Oracle Database  - Postgres
Databases []GetNdb Cluster Entity Count Engine Count Postgres Database  - Saphana
Databases []GetNdb Cluster Entity Count Engine Count Saphana Database  - Sqlserver
Databases []GetNdb Cluster Entity Count Engine Count Sqlserver Database  
- mariadb
Databases List<GetNdb Cluster Entity Count Engine Count Mariadb Database>  - mongodb
Databases List<GetNdb Cluster Entity Count Engine Count Mongodb Database>  - mysql
Databases List<GetNdb Cluster Entity Count Engine Count Mysql Database>  - oracle
Databases List<GetNdb Cluster Entity Count Engine Count Oracle Database>  - postgres
Databases List<GetNdb Cluster Entity Count Engine Count Postgres Database>  - saphana
Databases List<GetNdb Cluster Entity Count Engine Count Saphana Database>  - sqlserver
Databases List<GetNdb Cluster Entity Count Engine Count Sqlserver Database>  
- mariadb
Databases GetNdb Cluster Entity Count Engine Count Mariadb Database[]  - mongodb
Databases GetNdb Cluster Entity Count Engine Count Mongodb Database[]  - mysql
Databases GetNdb Cluster Entity Count Engine Count Mysql Database[]  - oracle
Databases GetNdb Cluster Entity Count Engine Count Oracle Database[]  - postgres
Databases GetNdb Cluster Entity Count Engine Count Postgres Database[]  - saphana
Databases GetNdb Cluster Entity Count Engine Count Saphana Database[]  - sqlserver
Databases GetNdb Cluster Entity Count Engine Count Sqlserver Database[]  
- mariadb_
databases Sequence[GetNdb Cluster Entity Count Engine Count Mariadb Database]  - mongodb_
databases Sequence[GetNdb Cluster Entity Count Engine Count Mongodb Database]  - mysql_
databases Sequence[GetNdb Cluster Entity Count Engine Count Mysql Database]  - oracle_
databases Sequence[GetNdb Cluster Entity Count Engine Count Oracle Database]  - postgres_
databases Sequence[GetNdb Cluster Entity Count Engine Count Postgres Database]  - saphana_
databases Sequence[GetNdb Cluster Entity Count Engine Count Saphana Database]  - sqlserver_
databases Sequence[GetNdb Cluster Entity Count Engine Count Sqlserver Database]  
GetNdbClusterEntityCountEngineCountMariadbDatabase        
GetNdbClusterEntityCountEngineCountMariadbDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterEntityCountEngineCountMongodbDatabase        
GetNdbClusterEntityCountEngineCountMongodbDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterEntityCountEngineCountMysqlDatabase        
GetNdbClusterEntityCountEngineCountMysqlDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterEntityCountEngineCountOracleDatabase        
GetNdbClusterEntityCountEngineCountOracleDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterEntityCountEngineCountPostgresDatabase        
GetNdbClusterEntityCountEngineCountPostgresDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterEntityCountEngineCountSaphanaDatabase        
GetNdbClusterEntityCountEngineCountSaphanaDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterEntityCountEngineCountSqlserverDatabase        
GetNdbClusterEntityCountEngineCountSqlserverDatabaseProfile         
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- Compute int
 - Database
Parameter int - Network int
 - Software int
 - Storage int
 - Windows
Domain int 
- compute Integer
 - database
Parameter Integer - network Integer
 - software Integer
 - storage Integer
 - windows
Domain Integer 
- compute number
 - database
Parameter number - network number
 - software number
 - storage number
 - windows
Domain number 
- compute int
 - database_
parameter int - network int
 - software int
 - storage int
 - windows_
domain int 
- compute Number
 - database
Parameter Number - network Number
 - software Number
 - storage Number
 - windows
Domain Number 
GetNdbClusterProperty   
- Description string
 - description
 
- Name string
 - name of cluster
 
- Ref
Id string - Secure bool
 - Value string
 
- Description string
 - description
 
- Name string
 - name of cluster
 
- Ref
Id string - Secure bool
 - Value string
 
- description String
 - description
 
- name String
 - name of cluster
 
- ref
Id String - secure Boolean
 - value String
 
- description string
 - description
 
- name string
 - name of cluster
 
- ref
Id 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
 
- ref
Id String - secure Boolean
 - value String
 
GetNdbClusterResourceConfig    
- Memory
Threshold doublePercentage  - Storage
Threshold doublePercentage  
- Memory
Threshold float64Percentage  - Storage
Threshold float64Percentage  
- memory
Threshold DoublePercentage  - storage
Threshold DoublePercentage  
- memory
Threshold numberPercentage  - storage
Threshold numberPercentage  
- memory
Threshold NumberPercentage  - storage
Threshold NumberPercentage  
Package Details
- Repository
 - nutanix pierskarsenbarg/pulumi-nutanix
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
nutanixTerraform Provider. 
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg