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

nutanix.getNdbDatabases

Explore with Pulumi AI

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

    List all database instances in Nutanix Database Service

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pulumi/nutanix";
    
    const dbs = nutanix.getNdbDatabases({});
    export const dbsOutput = dbs;
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    dbs = nutanix.get_ndb_databases()
    pulumi.export("dbsOutput", dbs)
    
    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 {
    		dbs, err := nutanix.GetNdbDatabases(ctx, &nutanix.GetNdbDatabasesArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dbsOutput", dbs)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var dbs = Nutanix.GetNdbDatabases.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["dbsOutput"] = dbs,
        };
    });
    
    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.GetNdbDatabasesArgs;
    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 dbs = NutanixFunctions.getNdbDatabases();
    
            ctx.export("dbsOutput", dbs.applyValue(getNdbDatabasesResult -> getNdbDatabasesResult));
        }
    }
    
    variables:
      dbs:
        fn::invoke:
          Function: nutanix:getNdbDatabases
          Arguments: {}
    outputs:
      dbsOutput: ${dbs}
    

    database_instances

    The following attributes are exported for each database_instances:

    • id: - id of database instance
    • name: - name of database instance
    • description: - description
    • date_created: - creation date
    • date_modified: - date modified
    • properties: - properties
    • tags: - tags attached
    • clustered: - if clustered or not
    • clone: - if cloned
    • database_name: - database instance name
    • type: - database engine type
    • status: - status of database instance
    • dbserver_logical_cluster_id: - NA
    • time_machine_id: - time machine ID
    • time_zone: - timezone
    • info: - info regarding disks, vm, storage, etc.
    • metric: - metrics
    • parent_database_id: - parent database ID
    • lcm_config: - lcm configuration
    • time_machine: - time machine related config info
    • database_nodes: - nodes info
    • dbserver_logical_cluster: - NA
    • linked_databases: - list of databases created in instance with info

    See detailed information in List Database Instances.

    Using getNdbDatabases

    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 getNdbDatabases(args: GetNdbDatabasesArgs, opts?: InvokeOptions): Promise<GetNdbDatabasesResult>
    function getNdbDatabasesOutput(args: GetNdbDatabasesOutputArgs, opts?: InvokeOptions): Output<GetNdbDatabasesResult>
    def get_ndb_databases(database_type: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNdbDatabasesResult
    def get_ndb_databases_output(database_type: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNdbDatabasesResult]
    func GetNdbDatabases(ctx *Context, args *GetNdbDatabasesArgs, opts ...InvokeOption) (*GetNdbDatabasesResult, error)
    func GetNdbDatabasesOutput(ctx *Context, args *GetNdbDatabasesOutputArgs, opts ...InvokeOption) GetNdbDatabasesResultOutput

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

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

    The following arguments are supported:

    getNdbDatabases Result

    The following output properties are available:

    DatabaseInstances List<PiersKarsenbarg.Nutanix.Outputs.GetNdbDatabasesDatabaseInstance>
    • list of database instances
    Id string
    The provider-assigned unique ID for this managed resource.
    DatabaseType string
    DatabaseInstances []GetNdbDatabasesDatabaseInstance
    • list of database instances
    Id string
    The provider-assigned unique ID for this managed resource.
    DatabaseType string
    databaseInstances List<GetNdbDatabasesDatabaseInstance>
    • list of database instances
    id String
    The provider-assigned unique ID for this managed resource.
    databaseType String
    databaseInstances GetNdbDatabasesDatabaseInstance[]
    • list of database instances
    id string
    The provider-assigned unique ID for this managed resource.
    databaseType string
    database_instances Sequence[GetNdbDatabasesDatabaseInstance]
    • list of database instances
    id str
    The provider-assigned unique ID for this managed resource.
    database_type str
    databaseInstances List<Property Map>
    • list of database instances
    id String
    The provider-assigned unique ID for this managed resource.
    databaseType String

    Supporting Types

    GetNdbDatabasesDatabaseInstance

    Clone bool
    Clustered bool
    DatabaseClusterType string
    DatabaseName string
    DatabaseNodes List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceDatabaseNode>
    Databases Dictionary<string, string>
    DateCreated string
    DateModified string
    DbserverLogicalCluster Dictionary<string, string>
    DbserverLogicalClusterId string
    Description string
    Id string
    Infos List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceInfo>
    LcmConfigs List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceLcmConfig>
    LinkedDatabases List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceLinkedDatabase>
    Metadatas List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceMetadata>
    Metric Dictionary<string, string>
    Name string
    ParentDatabaseId string
    Properties List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceProperty>
    List of all the properties
    Status string
    Tags List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTag>
    TimeMachineId string
    TimeMachines List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachine>
    TimeZone string
    Type string
    clone_ Boolean
    clustered Boolean
    databaseClusterType String
    databaseName String
    databaseNodes List<GetNdbDatabasesDatabaseInstanceDatabaseNode>
    databases Map<String,String>
    dateCreated String
    dateModified String
    dbserverLogicalCluster Map<String,String>
    dbserverLogicalClusterId String
    description String
    id String
    infos List<GetNdbDatabasesDatabaseInstanceInfo>
    lcmConfigs List<GetNdbDatabasesDatabaseInstanceLcmConfig>
    linkedDatabases List<GetNdbDatabasesDatabaseInstanceLinkedDatabase>
    metadatas List<GetNdbDatabasesDatabaseInstanceMetadata>
    metric Map<String,String>
    name String
    parentDatabaseId String
    properties List<GetNdbDatabasesDatabaseInstanceProperty>
    List of all the properties
    status String
    tags List<GetNdbDatabasesDatabaseInstanceTag>
    timeMachineId String
    timeMachines List<GetNdbDatabasesDatabaseInstanceTimeMachine>
    timeZone String
    type String
    clone boolean
    clustered boolean
    databaseClusterType string
    databaseName string
    databaseNodes GetNdbDatabasesDatabaseInstanceDatabaseNode[]
    databases {[key: string]: string}
    dateCreated string
    dateModified string
    dbserverLogicalCluster {[key: string]: string}
    dbserverLogicalClusterId string
    description string
    id string
    infos GetNdbDatabasesDatabaseInstanceInfo[]
    lcmConfigs GetNdbDatabasesDatabaseInstanceLcmConfig[]
    linkedDatabases GetNdbDatabasesDatabaseInstanceLinkedDatabase[]
    metadatas GetNdbDatabasesDatabaseInstanceMetadata[]
    metric {[key: string]: string}
    name string
    parentDatabaseId string
    properties GetNdbDatabasesDatabaseInstanceProperty[]
    List of all the properties
    status string
    tags GetNdbDatabasesDatabaseInstanceTag[]
    timeMachineId string
    timeMachines GetNdbDatabasesDatabaseInstanceTimeMachine[]
    timeZone string
    type string
    clone bool
    clustered bool
    database_cluster_type str
    database_name str
    database_nodes Sequence[GetNdbDatabasesDatabaseInstanceDatabaseNode]
    databases Mapping[str, str]
    date_created str
    date_modified str
    dbserver_logical_cluster Mapping[str, str]
    dbserver_logical_cluster_id str
    description str
    id str
    infos Sequence[GetNdbDatabasesDatabaseInstanceInfo]
    lcm_configs Sequence[GetNdbDatabasesDatabaseInstanceLcmConfig]
    linked_databases Sequence[GetNdbDatabasesDatabaseInstanceLinkedDatabase]
    metadatas Sequence[GetNdbDatabasesDatabaseInstanceMetadata]
    metric Mapping[str, str]
    name str
    parent_database_id str
    properties Sequence[GetNdbDatabasesDatabaseInstanceProperty]
    List of all the properties
    status str
    tags Sequence[GetNdbDatabasesDatabaseInstanceTag]
    time_machine_id str
    time_machines Sequence[GetNdbDatabasesDatabaseInstanceTimeMachine]
    time_zone str
    type str

    GetNdbDatabasesDatabaseInstanceDatabaseNode

    GetNdbDatabasesDatabaseInstanceDatabaseNodeInfo

    Info Dictionary<string, string>
    SecureInfo Dictionary<string, string>
    Info map[string]string
    SecureInfo map[string]string
    info Map<String,String>
    secureInfo Map<String,String>
    info {[key: string]: string}
    secureInfo {[key: string]: string}
    info Mapping[str, str]
    secure_info Mapping[str, str]
    info Map<String>
    secureInfo Map<String>

    GetNdbDatabasesDatabaseInstanceDatabaseNodeProperty

    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

    GetNdbDatabasesDatabaseInstanceDatabaseNodeProtectionDomain

    assocEntities List<String>
    cloudId String
    dateCreated String
    dateModified String
    description String
    eraCreated Boolean
    id String
    name String
    ownerId String
    primaryHost String
    properties List<Property Map>
    List of all the properties
    status String
    type String

    GetNdbDatabasesDatabaseInstanceDatabaseNodeProtectionDomainProperty

    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

    GetNdbDatabasesDatabaseInstanceDatabaseNodeTag

    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String
    entityId string
    entityType string
    tagId string
    tagName string
    value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String

    GetNdbDatabasesDatabaseInstanceInfo

    GetNdbDatabasesDatabaseInstanceInfoBpgConfig

    GetNdbDatabasesDatabaseInstanceInfoBpgConfigBpgDbParam

    GetNdbDatabasesDatabaseInstanceInfoBpgConfigStorage

    GetNdbDatabasesDatabaseInstanceInfoBpgConfigStorageArchiveStorage

    Size double
    Size float64
    size Double
    size number
    size float
    size Number

    GetNdbDatabasesDatabaseInstanceInfoBpgConfigStorageDataDisk

    Count double
    Count float64
    count Double
    count number
    count float
    count Number

    GetNdbDatabasesDatabaseInstanceInfoBpgConfigStorageLogDisk

    Count double
    Size double
    Count float64
    Size float64
    count Double
    size Double
    count number
    size number
    count float
    size float
    count Number
    size Number

    GetNdbDatabasesDatabaseInstanceInfoBpgConfigVmProperty

    GetNdbDatabasesDatabaseInstanceLcmConfig

    GetNdbDatabasesDatabaseInstanceLcmConfigExpiryDetail

    GetNdbDatabasesDatabaseInstanceLcmConfigPostDeleteCommand

    Command string
    Command string
    command String
    command string
    command String

    GetNdbDatabasesDatabaseInstanceLcmConfigPreDeleteCommand

    Command string
    Command string
    command String
    command string
    command String

    GetNdbDatabasesDatabaseInstanceLcmConfigRefreshDetail

    GetNdbDatabasesDatabaseInstanceLinkedDatabase

    GetNdbDatabasesDatabaseInstanceLinkedDatabaseInfo

    Info Dictionary<string, string>
    SecureInfo Dictionary<string, string>
    Info map[string]string
    SecureInfo map[string]string
    info Map<String,String>
    secureInfo Map<String,String>
    info {[key: string]: string}
    secureInfo {[key: string]: string}
    info Mapping[str, str]
    secure_info Mapping[str, str]
    info Map<String>
    secureInfo Map<String>

    GetNdbDatabasesDatabaseInstanceMetadata

    GetNdbDatabasesDatabaseInstanceMetadataDeregisterInfo

    Message string
    Operations List<string>
    Message string
    Operations []string
    message String
    operations List<String>
    message string
    operations string[]
    message str
    operations Sequence[str]
    message String
    operations List<String>

    GetNdbDatabasesDatabaseInstanceProperty

    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

    GetNdbDatabasesDatabaseInstanceTag

    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String
    entityId string
    entityType string
    tagId string
    tagName string
    value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String

    GetNdbDatabasesDatabaseInstanceTimeMachine

    GetNdbDatabasesDatabaseInstanceTimeMachineProperty

    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

    GetNdbDatabasesDatabaseInstanceTimeMachineSchedule

    ContinuousSchedules List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleContinuousSchedule>
    DailySchedules List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleDailySchedule>
    DateCreated string
    DateModified string
    Description string
    GlobalPolicy bool
    Id string
    MonthlySchedules List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleMonthlySchedule>
    Name string
    OwnerId string
    QuartelySchedules List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleQuartelySchedule>
    ReferenceCount int
    SnapshotTimeOfDays List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleSnapshotTimeOfDay>
    StartTime string
    SystemPolicy bool
    TimeZone string
    UniqueName string
    WeeklySchedules List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleWeeklySchedule>
    YearlySchedules List<PiersKarsenbarg.Nutanix.Inputs.GetNdbDatabasesDatabaseInstanceTimeMachineScheduleYearlySchedule>
    continuousSchedules List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleContinuousSchedule>
    dailySchedules List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleDailySchedule>
    dateCreated String
    dateModified String
    description String
    globalPolicy Boolean
    id String
    monthlySchedules List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleMonthlySchedule>
    name String
    ownerId String
    quartelySchedules List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleQuartelySchedule>
    referenceCount Integer
    snapshotTimeOfDays List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleSnapshotTimeOfDay>
    startTime String
    systemPolicy Boolean
    timeZone String
    uniqueName String
    weeklySchedules List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleWeeklySchedule>
    yearlySchedules List<GetNdbDatabasesDatabaseInstanceTimeMachineScheduleYearlySchedule>
    continuous_schedules Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleContinuousSchedule]
    daily_schedules Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleDailySchedule]
    date_created str
    date_modified str
    description str
    global_policy bool
    id str
    monthly_schedules Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleMonthlySchedule]
    name str
    owner_id str
    quartely_schedules Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleQuartelySchedule]
    reference_count int
    snapshot_time_of_days Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleSnapshotTimeOfDay]
    start_time str
    system_policy bool
    time_zone str
    unique_name str
    weekly_schedules Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleWeeklySchedule]
    yearly_schedules Sequence[GetNdbDatabasesDatabaseInstanceTimeMachineScheduleYearlySchedule]

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleContinuousSchedule

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleDailySchedule

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleMonthlySchedule

    dayOfMonth Integer
    enabled Boolean
    dayOfMonth number
    enabled boolean
    dayOfMonth Number
    enabled Boolean

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleQuartelySchedule

    dayOfMonth Integer
    enabled Boolean
    startMonth String
    startMonthValue String
    dayOfMonth number
    enabled boolean
    startMonth string
    startMonthValue string
    dayOfMonth Number
    enabled Boolean
    startMonth String
    startMonthValue String

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleSnapshotTimeOfDay

    Extra bool
    Hours int
    Minutes int
    Seconds int
    Extra bool
    Hours int
    Minutes int
    Seconds int
    extra Boolean
    hours Integer
    minutes Integer
    seconds Integer
    extra boolean
    hours number
    minutes number
    seconds number
    extra bool
    hours int
    minutes int
    seconds int
    extra Boolean
    hours Number
    minutes Number
    seconds Number

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleWeeklySchedule

    dayOfWeek String
    dayOfWeekValue String
    enabled Boolean
    dayOfWeek string
    dayOfWeekValue string
    enabled boolean
    dayOfWeek String
    dayOfWeekValue String
    enabled Boolean

    GetNdbDatabasesDatabaseInstanceTimeMachineScheduleYearlySchedule

    DayOfMonth int
    Enabled bool
    Month string
    MonthValue string
    DayOfMonth int
    Enabled bool
    Month string
    MonthValue string
    dayOfMonth Integer
    enabled Boolean
    month String
    monthValue String
    dayOfMonth number
    enabled boolean
    month string
    monthValue string
    dayOfMonth Number
    enabled Boolean
    month String
    monthValue String

    GetNdbDatabasesDatabaseInstanceTimeMachineSla

    GetNdbDatabasesDatabaseInstanceTimeMachineTag

    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    EntityId string
    EntityType string
    TagId string
    TagName string
    Value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String
    entityId string
    entityType string
    tagId string
    tagName string
    value string
    entityId String
    entityType String
    tagId String
    tagName String
    value String

    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